<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Runtime Configuration</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.installation.html">Installation</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.resources.html">Resource Types</a></div>
<div class="up"><a href="phar.setup.html">Installing/Configuring</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phar.configuration" class="section">
<h2 class="title">Runtime Configuration</h2>
<p class="simpara">
The behaviour of these functions is affected by settings in <var class="filename">php.ini</var>.
</p>
<p class="para">
<table class="doctable table">
<caption><strong>Filesystem and Streams Configuration Options</strong></caption>
<thead>
<tr>
<th>Name</th>
<th>Default</th>
<th>Changeable</th>
<th>Changelog</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a></td>
<td>"1"</td>
<td>PHP_INI_ALL</td>
<td class="empty"> </td>
</tr>
<tr>
<td><a href="phar.configuration.html#ini.phar.require-hash" class="link">phar.require_hash</a></td>
<td>"1"</td>
<td>PHP_INI_ALL</td>
<td class="empty"> </td>
</tr>
<tr>
<td><a href="phar.configuration.html#ini.phar.extract-list" class="link">phar.extract_list</a></td>
<td>""</td>
<td>PHP_INI_ALL</td>
<td>Available from phar 1.1.0 to 1.2.3, removed in 2.0.0.</td>
</tr>
<tr>
<td><a href="phar.configuration.html#ini.phar.cache-list" class="link">phar.cache_list</a></td>
<td>""</td>
<td>PHP_INI_SYSTEM</td>
<td>Available from phar 2.0.0.</td>
</tr>
</tbody>
</table>
</p>
<p class="para">Here's a short explanation of
the configuration directives.</p>
<p class="para">
<dl>
<dt id="ini.phar.readonly">
<span class="term">
<em><code class="parameter">phar.readonly</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
This option disables creation or modification of Phar archives
using the <em>phar</em> stream or <a href="class.phar.html" class="classname">Phar</a>
object's write support. This setting should always be enabled on
production machines, as the phar extension's convenient write support
could allow straightforward creation of a php-based virus when coupled
with other common security vulnerabilities.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This setting can only be unset in php.ini due to security reasons.
If <em>phar.readonly</em> is disabled in php.ini, the
user may enable <em>phar.readonly</em> in a script
or disable it later. If <em>phar.readonly</em> is
enabled in php.ini, a script may harmlessly "re-enable"
the INI variable, but may not disable it.
</p>
</p></blockquote>
</dd>
</dt>
<dt id="ini.phar.require-hash">
<span class="term">
<em><code class="parameter">phar.require_hash</code></em>
<span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>
</span>
<dd>
<p class="para">
This option will force all opened Phar archives to contain some
kind of signature (currently MD5, SHA1, SHA256 and SHA512 are supported), and will
refuse to process any Phar archive that does not contain a signature.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This setting can only be unset in php.ini due to security reasons.
If <em>phar.require_hash</em> is disabled in php.ini, the
user may enable <em>phar.require_hash</em> in a script
or disable it later. If <em>phar.require_hash</em> is
enabled in php.ini, a script may harmlessly "re-enable"
the INI variable, but may not disable it.
</p>
<p class="para">
This setting does not affect reading plain tar files with the
<a href="class.phardata.html" class="classname">PharData</a> class.
</p>
</p></blockquote>
</dd>
</dt>
<dt id="ini.phar.extract-list">
<span class="term">
<em><code class="parameter">phar.extract_list</code></em>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</span>
<dd>
<p class="para">
This INI setting has been removed as of phar 2.0.0
</p>
<p class="para">
Allows mappings from a full path to a phar archive or its alias to
the location of its extracted files.
The format of the parameter is <em>name=archive,name2=archive2</em>.
This allows extraction of phar files to disk, and allows phar to act as a
kind of mapper to extracted disk files. This is often done for performance
reasons, or to assist with debugging a phar.
<div class="example" id="example-654">
<p><strong>Example #1 phar.extract_list usage example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
in php.ini:<br />phar.extract_list = archive=/full/path/to/archive/,arch2=/full/path/to/arch2<br /><span style="color: #0000BB"><?php<br /></span><span style="color: #007700">include </span><span style="color: #DD0000">"phar://archive/content.php"</span><span style="color: #007700">;<br />include </span><span style="color: #DD0000">"phar://arch2/foo.php"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</dd>
</dt>
<dt id="ini.phar.cache-list">
<span class="term">
<em><code class="parameter">phar.cache_list</code></em>
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
</span>
<dd>
<p class="para">
This INI setting was added in phar 2.0.0
</p>
<p class="para">
Allows mapping phar archives to be pre-parsed at web server startup,
providing a performance improvement that brings running files out of a
phar archive very close to the speed of running those files from a
traditional disk-based installation.
<div class="example" id="example-655">
<p><strong>Example #2 phar.cache_list usage example</strong></p>
<div class="example-contents">
<div class="cdata"><pre>
in php.ini (windows):
phar.cache_list =C:\path\to\phar1.phar;C:\path\to\phar2.phar
in php.ini (unix):
phar.cache_list =/path/to/phar1.phar:/path/to/phar2.phar
</pre></div>
</div>
</div>
</p>
</dd>
</dt>
</dl>
</p>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.installation.html">Installation</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.resources.html">Resource Types</a></div>
<div class="up"><a href="phar.setup.html">Installing/Configuring</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
