関数・クラス解説

Phar::webPhar

ウェブベースの phar で使用するフロントコントローラ

公式リファレンス

書式

final public static Phar::webPhar ([ string $alias [, string $index = "index.php" [, string $f404 [, array $mimetypes [, callable $rewrites ]]]]] ) : void

説明

Phar::mapPhar() は、ウェブベースの phar で使用します。 このメソッドは、 $_SERVER['REQUEST_URI'] をパースして ウェブサーバーからのリクエストを phar アーカイブ内のファイルに転送します。 要は、このメソッド自体がウェブサーバーをシミュレートするということです。 正しいファイルにリクエストを転送し、正しいヘッダを出力し、 必要に応じて PHP ファイルをパースします。 この強力なメソッドがあることで、 既存の PHP アプリケーションを phar アーカイブ化するのが容易になります。 Phar::mungServer() や Phar::interceptFileFuncs() と組み合わせて使用すると、任意のウェブアプリケーションをそのまま phar アーカイブ化することができます。

Phar::webPhar() をコールするのは、 phar アーカイブのスタブ内からのみとしましょう (スタブって何? という方は ここ をごらんください)。

パラメータ

alias

phar:// URL でこのアーカイブを指す際に、 フルパスの代わりに使用するエイリアス。

index

phar の中でディレクトリインデックスとなるファイルの場所。

f404

ファイルが見つからないときに実行するスクリプトの場所。 このスクリプトは HTTP 404 ヘッダを返さなければなりません。

mimetypes

ファイルの拡張子と MIME タイプを関連付けた配列。 デフォルトのマッピングで十分な場合は、空の配列を渡します。 デフォルトで、これらの関連が定義されています。

$mimes = array(     'phps' => Phar::PHPS, // highlight_file() に渡します     'c' => 'text/plain',     'cc' => 'text/plain',     'cpp' => 'text/plain',     'c++' => 'text/plain',     'dtd' => 'text/plain',     'h' => 'text/plain',     'log' => 'text/plain',     'rng' => 'text/plain',     'txt' => 'text/plain',     'xsd' => 'text/plain',     'php' => Phar::PHP, // PHP としてパースします     'inc' => Phar::PHP, // PHP としてパースします     'avi' => 'video/avi',     'bmp' => 'image/bmp',     'css' => 'text/css',     'gif' => 'image/gif',     'htm' => 'text/html',     'html' => 'text/html',     'htmls' => 'text/html',     'ico' => 'image/x-ico',     'jpe' => 'image/jpeg',     'jpg' => 'image/jpeg',     'jpeg' => 'image/jpeg',     'js' => 'application/x-javascript',     'midi' => 'audio/midi',     'mid' => 'audio/midi',     'mod' => 'audio/mod',     'mov' => 'movie/quicktime',     'mp3' => 'audio/mp3',     'mpg' => 'video/mpeg',     'mpeg' => 'video/mpeg',     'pdf' => 'application/pdf',     'png' => 'image/png',     'swf' => 'application/shockwave-flash',     'tif' => 'image/tiff',     'tiff' => 'image/tiff',     'wav' => 'audio/wav',     'xbm' => 'image/xbm',     'xml' => 'text/xml', );

rewrites

書き換え関数は、唯一のパラメータとして文字列を受け取り、string あるいは FALSE を返さないといけません。 fast-cgi あるいは cgi を使っている場合、この関数に渡されるパラメータは $_SERVER['PATH_INFO'] の値になります。 それ以外の場合、この関数に渡されるパラメータは $_SERVER['REQUEST_URI'] の値になります。 文字列を返した場合は、内部的なファイルパスとして扱います。FALSE を返した場合は、 webPhar() が HTTP 403 を送信します。

返値

値を返しません。

エラー

出力したい内部ファイルのオープンに失敗した場合、 あるいはスタブ以外からコールした場合には PharException をスローします。 無効な配列を mimetypes に渡したり、 無効なコールバックを rewrites に渡したりした場合は UnexpectedValueException をスローします。

サンプル

例1 Phar::webPhar() の例
 
 この例で作成した phar は、/myphar.phar/index.php や /myphar.phar をブラウズしたときには Hello World を表示し、 /myphar.phar/index.phps をブラウズしたときには index.phps のソースを表示します。 
 

// phar アーカイブを作成します
try {
    $phar = new Phar('myphar.phar');
    $phar['index.php'] = '
';    $phar['index.phps'] = '
 echo "Hello World"; 
';    $phar->setStub('

Phar::webPhar();
__HALT_COMPILER(); 
');} catch (Exception $e) {    // ここでエラー処理をします}?>

参考