Phar::webPharRoutes a request from a web browser to an internal file within the phar archive
&reftitle.description;
finalpublicstaticvoidPhar::webPharstringnullalias&null;stringnullindex&null;stringnullfileNotFoundScript&null;arraymimeTypes[]callablenullrewrite&null;Phar::webPhar serves as Phar::mapPhar for
web-based phars. This method parses $_SERVER['REQUEST_URI'] and
routes a request from a web browser to an internal file within the phar archive.
It simulates a web server, routing requests to the correct file, echoing the correct
headers and parsing PHP files as needed. Combined with Phar::mungServer
and Phar::interceptFileFuncs, any web application can be used
unmodified from a phar archive.
Phar::webPhar should only be
called from the stub of a phar archive (see here
for more information on what a stub is).
&reftitle.parameters;
alias
The alias that can be used in phar:// URLs to
refer to this archive, rather than its full path.
index
The location within the phar of the directory index.
fileNotFoundScript
The location of the script to run when a file is not found. This
script should output the proper HTTP 404 headers.
mimeTypes
An array mapping additional file extensions to MIME type.
If the default mapping is sufficient, pass an empty array.
By default, these extensions are mapped to these MIME types:
Phar::PHPS, // pass to 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, // parse as PHP
'inc' => Phar::PHP, // parse as 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',
);
?>
]]>
rewrite
The rewrites function is passed a string as its only parameter and must return a string or &false;.
If you are using fast-cgi or cgi then the parameter passed to the function is the value of the
$_SERVER['PATH_INFO'] variable. Otherwise, the parameter passed to the function is the value
of the $_SERVER['REQUEST_URI'] variable.
If a string is returned it is used as the internal file path. If &false; is returned then webPhar() will
send a HTTP 403 Denied Code.
&reftitle.returnvalues;
&return.void;
&reftitle.errors;
Throws PharException when unable to open the internal
file to output, or if
called from a non-stub. If an invalid array value is passed into
mimeTypes or an invalid callback is passed into rewrite, then
UnexpectedValueException is thrown.
&reftitle.changelog;
&Version;&Description;8.0.0fileNotFoundScript, mimeTypes
and rewrite are nullable now.
&reftitle.examples;
A <function>Phar::webPhar</function> example
With the example below, the created phar will display Hello World
if one browses to /myphar.phar/index.php or to
/myphar.phar, and will display the source of
index.phps if one browses to /myphar.phar/index.phps.
';
$phar['index.phps'] = '';
$phar->setStub('');
} catch (Exception $e) {
// handle error here
}
?>
]]>
&reftitle.seealso;
Phar::mungServerPhar::interceptFileFuncs