<!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>Sets file-specific permission bits</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pharfileinfo.compress.html">PharFileInfo::compress</a></div>
<div class="up"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pharfileinfo.chmod" class="refentry">
<div class="refnamediv">
<h1 class="refname">PharFileInfo::chmod</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">PharFileInfo::chmod</span> — <span class="dc-title">Sets file-specific permission bits</span></p>
</div>
<div class="refsect1 description" id="refsect1-pharfileinfo.chmod-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>PharFileInfo::chmod</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$permissions</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>PharFileInfo::chmod()</strong></span> allows setting of the executable
file permissions bit, as well as read-only bits. Writeable bits are
ignored, and set at runtime based on the
<a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a> INI variable.
As with all functionality that modifies the contents of
a phar, the <a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a> INI variable
must be off in order to succeed if the file is within a <a href="class.phar.html" class="classname">Phar</a>
archive. Files within <a href="class.phardata.html" class="classname">PharData</a> archives do not have
this restriction.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-pharfileinfo.chmod-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">permissions</code></em></span>
<dd>
<p class="para">
permissions (see <span class="function"><a href="function.chmod.html" class="function">chmod()</a></span>)
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-pharfileinfo.chmod-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-pharfileinfo.chmod-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-725">
<p><strong>Example #1 A <span class="function"><strong>PharFileInfo::chmod()</strong></span> example</strong></p>
<div class="example-contents"><p>
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// make sure it doesn't exist<br /></span><span style="color: #007700">@</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br />try {<br /> </span><span style="color: #0000BB">$p </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.sh'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'#!/usr/local/lib/php<br /> <?php echo "hi"; ?>'</span><span style="color: #007700">;<br /> </span><span style="color: #FF8000">// set executable bit<br /> </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.sh'</span><span style="color: #007700">]-></span><span style="color: #0000BB">chmod</span><span style="color: #007700">(</span><span style="color: #0000BB">0555</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.sh'</span><span style="color: #007700">]-></span><span style="color: #0000BB">isExecutable</span><span style="color: #007700">());<br />} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Could not create/modify phar: '</span><span style="color: #007700">, </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(true)
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pharfileinfo.compress.html">PharFileInfo::compress</a></div>
<div class="up"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
