<strings>
<string id="unixtojd" value="<div id='function.unixtojd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.unixtojd.php'>unixtojd</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>unixtojd</span> &amp;mdash; <span class='dc-title'>Convert Unix timestamp to Julian Day</span></p> </div> <a name='function.unixtojd.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>unixtojd</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timestamp</tt><span class='initializer'> = time()</span></span> ] )</div> <p class='para rdfs-comment'> Return the Julian Day for a Unix <i><tt class='parameter'>timestamp</tt></i> (seconds since 1.1.1970), or for the current day if no <i><tt class='parameter'>timestamp</tt></i> is given. </p> </div> <a name='function.unixtojd.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timestamp</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A unix timestamp to convert. </p> </dd> </dl> <p> </p> </div> <a name='function.unixtojd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A julian day number as integer. </p> </div> <a name='function.unixtojd.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.jdtounix.php' class='function' rel='rdfs-seeAlso'>jdtounix()</a> - Convert Julian Day to Unix timestamp</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_warning_count" value="<div id='function.tidy-warning-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.tidy-warning-count.php'>tidy_warning_count</a></h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy_warning_count</span> &amp;mdash; <span class='dc-title'>Returns the Number of Tidy warnings encountered for specified document</span></p> </div> <a name='function.tidy-warning-count.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>tidy_warning_count</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of Tidy warnings encountered for the specified document. </p> </div> <a name='function.tidy-warning-count.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='function.tidy-warning-count.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of warnings. </p> </div> <a name='function.tidy-warning-count.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy_warning_count()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;p&amp;gt;test&amp;lt;/i&amp;gt;<br />&amp;lt;bogustag&amp;gt;bogus&amp;lt;/bogustag&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>tidy_error_count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//1<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>tidy_warning_count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//5<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.tidy-warning-count.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.tidy-error-count.php' class='function' rel='rdfs-seeAlso'>tidy_error_count()</a> - Returns the Number of Tidy errors encountered for specified document</li> <li class='member'><a href='http://www.php.net/manual/en/function.tidy-access-count.php' class='function' rel='rdfs-seeAlso'>tidy_access_count()</a> - Returns the Number of Tidy accessibility warnings encountered for specified document</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_repair_string" value="<div id='tidy.repairstring' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.repairstring.php'>tidy::repairString</a></h1> <h1 class='refname'>tidy_repair_string</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.7.0)</p><p class='refpurpose'><span class='refname'>tidy::repairString</span> -- <span class='refname'>tidy_repair_string</span> &amp;mdash; <span class='dc-title'>Repair a string using an optionally provided configuration file</span></p> </div> <a name='tidy.repairstring.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>tidy_repair_string</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>tidy::repairString</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> Repairs the given string. </p> </div> <a name='tidy.repairstring.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The data to be repaired. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>config</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The config <i><tt class='parameter'>config</tt></i> can be passed either as an array or as a string. If a string is passed, it is interpreted as the name of the configuration file, otherwise, it is interpreted as the options themselves. </p> <p class='para'> Check <a href='http://tidy.sourceforge.net/docs/quickref.html' class='link external'>&amp;raquo; http://tidy.sourceforge.net/docs/quickref.html</a> for an explanation about each option. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>encoding</tt></i> parameter sets the encoding for input/output documents. The possible values for encoding are: <i>ascii</i>, <i>latin0</i>, <i>latin1</i>, <i>raw</i>, <i>utf8</i>, <i>iso2022</i>, <i>mac</i>, <i>win1252</i>, <i>ibm858</i>, <i>utf16</i>, <i>utf16le</i>, <i>utf16be</i>, <i>big5</i>, and <i>shiftjis</i>. </p> </dd> </dl> <p> </p> </div> <a name='tidy.repairstring.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the repaired string. </p> </div> <a name='tidy.repairstring.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::repairString()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />ob_start</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;<br /></span><br />&amp;lt;html&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;title&amp;gt;test&amp;lt;/title&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;body&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;p&amp;gt;error&amp;lt;/i&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/body&amp;gt;<br />&amp;lt;/html&amp;gt;<br /><br /><span style='color: #0000BB'>&amp;lt;?php<br /><br />$buffer&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ob_get_clean</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>tidy</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$clean&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>repairString</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$buffer</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$clean</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;!DOCTYPE html PUBLIC &amp;quot;-//W3C//DTD HTML 3.2//EN&amp;quot;&amp;gt; &amp;lt;html&amp;gt; &amp;lt;head&amp;gt; &amp;lt;title&amp;gt;test&amp;lt;/title&amp;gt; &amp;lt;/head&amp;gt; &amp;lt;body&amp;gt; &amp;lt;p&amp;gt;error&amp;lt;/p&amp;gt; &amp;lt;/body&amp;gt; &amp;lt;/html&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='tidy.repairstring.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The optional parameters <i><tt class='parameter'>config</tt></i> and <i><tt class='parameter'>encoding</tt></i> were added in Tidy 2.0.</span></p></blockquote> </div> <a name='tidy.repairstring.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/tidy.parsefile.php' class='function' rel='rdfs-seeAlso'>tidy::parseFile()</a> - Parse markup in file or URI</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.parsestring.php' class='function' rel='rdfs-seeAlso'>tidy::parseString()</a> - Parse a document stored in a string</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.repairfile.php' class='function' rel='rdfs-seeAlso'>tidy::repairFile()</a> - Repair a file and return it as a string</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_repair_file" value="<div id='tidy.repairfile' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.repairfile.php'>tidy::repairFile</a></h1> <h1 class='refname'>tidy_repair_file</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.7.0)</p><p class='refpurpose'><span class='refname'>tidy::repairFile</span> -- <span class='refname'>tidy_repair_file</span> &amp;mdash; <span class='dc-title'>Repair a file and return it as a string</span></p> </div> <a name='tidy.repairfile.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>tidy_repair_file</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$use_include_path</tt><span class='initializer'> = false</span></span> ]]] )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>tidy::repairFile</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$use_include_path</tt><span class='initializer'> = false</span></span> ]]] )</div> <p class='para rdfs-comment'> Repairs the given file and returns it as a string. </p> </div> <a name='tidy.repairfile.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The file to be repaired. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>config</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The config <i><tt class='parameter'>config</tt></i> can be passed either as an array or as a string. If a string is passed, it is interpreted as the name of the configuration file, otherwise, it is interpreted as the options themselves. </p> <p class='para'> Check http://tidy.sourceforge.net/docs/quickref.html for an explanation about each option. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>encoding</tt></i> parameter sets the encoding for input/output documents. The possible values for encoding are: <i>ascii</i>, <i>latin0</i>, <i>latin1</i>, <i>raw</i>, <i>utf8</i>, <i>iso2022</i>, <i>mac</i>, <i>win1252</i>, <i>ibm858</i>, <i>utf16</i>, <i>utf16le</i>, <i>utf16be</i>, <i>big5</i>, and <i>shiftjis</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>use_include_path</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Search for the file in the <a href='http://www.php.net/manual/en/ini.core.php#ini.include-path' class='link'>include_path</a>. </p> </dd> </dl> <p> </p> </div> <a name='tidy.repairfile.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the repaired contents as a string. </p> </div> <a name='tidy.repairfile.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::repairFile()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'file.html'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>tidy</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$repaired&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>repairfile</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>rename</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'.bak'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>file_put_contents</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$repaired</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='tidy.repairfile.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The optional parameters <i><tt class='parameter'>config</tt></i> and <i><tt class='parameter'>encoding</tt></i> were added in Tidy 2.0.</span></p></blockquote> </div> <a name='tidy.repairfile.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/tidy.parsefile.php' class='function' rel='rdfs-seeAlso'>tidy::parseFile()</a> - Parse markup in file or URI</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.parsestring.php' class='function' rel='rdfs-seeAlso'>tidy::parseString()</a> - Parse a document stored in a string</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.repairstring.php' class='function' rel='rdfs-seeAlso'>tidy::repairString()</a> - Repair a string using an optionally provided configuration file</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_parse_string" value="<div id='tidy.parsestring' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.parsestring.php'>tidy::parseString</a></h1> <h1 class='refname'>tidy_parse_string</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::parseString</span> -- <span class='refname'>tidy_parse_string</span> &amp;mdash; <span class='dc-title'>Parse a document stored in a string</span></p> </div> <a name='tidy.parsestring.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <span class='methodname'><b>tidy_parse_string</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$input</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidy::parseString</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$input</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> Parses a document stored in a string. </p> </div> <a name='tidy.parsestring.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>input</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The data to be parsed. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>config</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The config <i><tt class='parameter'>config</tt></i> can be passed either as an array or as a string. If a string is passed, it is interpreted as the name of the configuration file, otherwise, it is interpreted as the options themselves. </p> <p class='para'> For an explanation about each option, visit <a href='http://tidy.sourceforge.net/docs/quickref.html' class='link external'>&amp;raquo; http://tidy.sourceforge.net/docs/quickref.html</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>encoding</tt></i> parameter sets the encoding for input/output documents. The possible values for encoding are: <i>ascii</i>, <i>latin0</i>, <i>latin1</i>, <i>raw</i>, <i>utf8</i>, <i>iso2022</i>, <i>mac</i>, <i>win1252</i>, <i>ibm858</i>, <i>utf16</i>, <i>utf16le</i>, <i>utf16be</i>, <i>big5</i>, and <i>shiftjis</i>. </p> </dd> </dl> <p> </p> </div> <a name='tidy.parsestring.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a new <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>tidy</a> instance. </p> </div> <a name='tidy.parsestring.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::parseString()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />ob_start</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;<br /></span><br />&amp;lt;html&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;title&amp;gt;test&amp;lt;/title&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;body&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;p&amp;gt;error&amp;lt;br&amp;gt;another&amp;nbsp;line&amp;lt;/i&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/body&amp;gt;<br />&amp;lt;/html&amp;gt;<br /><br /><span style='color: #0000BB'>&amp;lt;?php<br /><br />$buffer&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ob_get_clean</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$config&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'indent'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>TRUE</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'output-xhtml'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>TRUE</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'wrap'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$buffer</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$config</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UTF8'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>cleanRepair</span><span style='color: #007700'>();<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;!DOCTYPE html PUBLIC &amp;quot;-//W3C//DTD XHTML 1.0 Strict//EN&amp;quot; &amp;quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd&amp;quot;&amp;gt; &amp;lt;html xmlns=&amp;quot;http://www.w3.org/1999/xhtml&amp;quot;&amp;gt; &amp;lt;head&amp;gt; &amp;lt;title&amp;gt; test &amp;lt;/title&amp;gt; &amp;lt;/head&amp;gt; &amp;lt;body&amp;gt; &amp;lt;p&amp;gt; error&amp;lt;br /&amp;gt; another line &amp;lt;/p&amp;gt; &amp;lt;/body&amp;gt; &amp;lt;/html&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='tidy.parsestring.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The optional parameters <i><tt class='parameter'>config</tt></i> and <i><tt class='parameter'>encoding</tt></i> were added in Tidy 2.0.</span></p></blockquote> </div> <a name='tidy.parsestring.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/tidy.parsefile.php' class='function' rel='rdfs-seeAlso'>tidy::parseFile()</a> - Parse markup in file or URI</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.repairfile.php' class='function' rel='rdfs-seeAlso'>tidy::repairFile()</a> - Repair a file and return it as a string</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.repairstring.php' class='function' rel='rdfs-seeAlso'>tidy::repairString()</a> - Repair a string using an optionally provided configuration file</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_parse_file" value="<div id='tidy.parsefile' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.parsefile.php'>tidy::parseFile</a></h1> <h1 class='refname'>tidy_parse_file</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::parseFile</span> -- <span class='refname'>tidy_parse_file</span> &amp;mdash; <span class='dc-title'>Parse markup in file or URI</span></p> </div> <a name='tidy.parsefile.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <span class='methodname'><b>tidy_parse_file</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$use_include_path</tt><span class='initializer'> = false</span></span> ]]] )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidy::parseFile</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$use_include_path</tt><span class='initializer'> = false</span></span> ]]] )</div> <p class='para rdfs-comment'> Parses the given file. </p> </div> <a name='tidy.parsefile.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If the <i><tt class='parameter'>filename</tt></i> parameter is given, this function will also read that file and initialize the object with the file, acting like <b>tidy_parse_file()</b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>config</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The config <i><tt class='parameter'>config</tt></i> can be passed either as an array or as a string. If a string is passed, it is interpreted as the name of the configuration file, otherwise, it is interpreted as the options themselves. </p> <p class='para'> For an explanation about each option, see <a href='http://tidy.sourceforge.net/docs/quickref.html' class='link external'>&amp;raquo; http://tidy.sourceforge.net/docs/quickref.html</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>encoding</tt></i> parameter sets the encoding for input/output documents. The possible values for encoding are: <i>ascii</i>, <i>latin0</i>, <i>latin1</i>, <i>raw</i>, <i>utf8</i>, <i>iso2022</i>, <i>mac</i>, <i>win1252</i>, <i>ibm858</i>, <i>utf16</i>, <i>utf16le</i>, <i>utf16be</i>, <i>big5</i>, and <i>shiftjis</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>use_include_path</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Search for the file in the <a href='http://www.php.net/manual/en/ini.core.php#ini.include-path' class='link'>include_path</a>. </p> </dd> </dl> <p> </p> </div> <a name='tidy.parsefile.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='tidy.parsefile.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::parseFile()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>tidy</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>parseFile</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'file.html'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>cleanRepair</span><span style='color: #007700'>();<br /><br />if(!empty(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>errorBuffer</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;following&amp;nbsp;errors&amp;nbsp;or&amp;nbsp;warnings&amp;nbsp;occured:\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>errorBuffer</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='tidy.parsefile.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The optional parameters <i><tt class='parameter'>config</tt></i> and <i><tt class='parameter'>encoding</tt></i> were added in Tidy 2.0.</span></p></blockquote> </div> <a name='tidy.parsefile.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/tidy.parsestring.php' class='function' rel='rdfs-seeAlso'>tidy::parsestring()</a> - Parse a document stored in a string</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.repairfile.php' class='function' rel='rdfs-seeAlso'>tidy::repairfile()</a> - Repair a file and return it as a string</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.repairstring.php' class='function' rel='rdfs-seeAlso'>tidy::repairstring()</a> - Repair a string using an optionally provided configuration file</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_is_xml" value="<div id='tidy.isxml' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.isxml.php'>tidy::isXml</a></h1> <h1 class='refname'>tidy_is_xml</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::isXml</span> -- <span class='refname'>tidy_is_xml</span> &amp;mdash; <span class='dc-title'>Indicates if the document is a generic (non HTML/XHTML) XML document</span></p> </div> <a name='tidy.isxml.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidy_is_xml</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidy::isXml</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells if the document is a generic (non HTML/XHTML) XML document. </p> </div> <a name='tidy.isxml.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='tidy.isxml.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> This function returns <b><tt class='constant'>TRUE</tt></b> if the specified tidy <i><tt class='parameter'>object</tt></i> is a generic XML document (non HTML/XHTML), or <b><tt class='constant'>FALSE</tt></b> otherwise. </p> <div class='warning'><b class='warning'>Warning</b> <p class='para'> This function is not yet implemented in the Tidylib itself, so it always return <b><tt class='constant'>FALSE</tt></b>. </p> </div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_is_xhtml" value="<div id='tidy.isxhtml' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.isxhtml.php'>tidy::isXhtml</a></h1> <h1 class='refname'>tidy_is_xhtml</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::isXhtml</span> -- <span class='refname'>tidy_is_xhtml</span> &amp;mdash; <span class='dc-title'>Indicates if the document is a XHTML document</span></p> </div> <a name='tidy.isxhtml.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidy_is_xhtml</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidy::isXhtml</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells if the document is a XHTML document. </p> </div> <a name='tidy.isxhtml.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='tidy.isxhtml.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> This function returns <b><tt class='constant'>TRUE</tt></b> if the specified tidy <i><tt class='parameter'>object</tt></i> is a XHTML document, or <b><tt class='constant'>FALSE</tt></b> otherwise. </p> <div class='warning'><b class='warning'>Warning</b> <p class='para'> This function is not yet implemented in the Tidylib itself, so it always return <b><tt class='constant'>FALSE</tt></b>. </p> </div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_getopt" value="<div id='tidy.getopt' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.getopt.php'>tidy::getOpt</a></h1> <h1 class='refname'>tidy_getopt</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::getOpt</span> -- <span class='refname'>tidy_getopt</span> &amp;mdash; <span class='dc-title'>Returns the value of the specified configuration option for the tidy document</span></p> </div> <a name='tidy.getopt.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>tidy_getopt</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>tidy::getOpt</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt></span> )</div> <p class='para rdfs-comment'> Returns the value of the specified <i><tt class='parameter'>option</tt></i> for the specified tidy <i><tt class='parameter'>object</tt></i> . </p> </div> <a name='tidy.getopt.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> You will find a list with each configuration option and their types at: <a href='http://tidy.sourceforge.net/docs/quickref.html' class='link external'>&amp;raquo; http://tidy.sourceforge.net/docs/quickref.html</a>. </p> </dd> </dl> <p> </p> </div> <a name='tidy.getopt.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the value of the specified <i><tt class='parameter'>option</tt></i> . The return type depends on the type of the specified one. </p> </div> <a name='tidy.getopt.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy_getopt()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=</span><span style='color: #DD0000'>'&amp;lt;!DOCTYPE&amp;nbsp;html&amp;nbsp;PUBLIC&amp;nbsp;'-//W3C//DTD&amp;nbsp;HTML&amp;nbsp;3.2//EN'&amp;gt;<br />&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;&amp;lt;title&amp;gt;Title&amp;lt;/title&amp;gt;&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br /><br />&amp;lt;p&amp;gt;&amp;lt;img&amp;nbsp;src='img.png'&amp;gt;&amp;lt;/p&amp;gt;<br /><br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$config&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'accessibility-check'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'alt-text'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'some&amp;nbsp;text'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>tidy</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>parseString</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$config</span><span style='color: #007700'>);<br /><br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>getOpt</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'accessibility-check'</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//integer<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>getOpt</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'lower-literals'</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//boolean<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>getOpt</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'alt-text'</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//string<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> int(3) bool(true) string(9) &amp;quot;some text&amp;quot; </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_get_status" value="<div id='tidy.getstatus' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.getstatus.php'>tidy::getStatus</a></h1> <h1 class='refname'>tidy_get_status</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::getStatus</span> -- <span class='refname'>tidy_get_status</span> &amp;mdash; <span class='dc-title'>Get status of specified document</span></p> </div> <a name='tidy.getstatus.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>tidy_get_status</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>tidy::getStatus</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns the status for the specified tidy <i><tt class='parameter'>object</tt></i> . </p> </div> <a name='tidy.getstatus.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='tidy.getstatus.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns 0 if no error/warning was raised, 1 for warnings or accessibility errors, or 2 for errors. </p> </div> <a name='tidy.getstatus.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::getStatus()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;p&amp;gt;paragraph&amp;lt;/i&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>tidy</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>parseString</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tidy2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>tidy</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$html2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;bogus&amp;gt;test&amp;lt;/bogus&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$tidy2</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>parseString</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html2</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>getStatus</span><span style='color: #007700'>();&amp;nbsp;</span><span style='color: #FF8000'>//1<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>$tidy2</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>getStatus</span><span style='color: #007700'>();&amp;nbsp;</span><span style='color: #FF8000'>//2<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_get_root" value="<div id='tidy.root' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.root.php'>tidy::root</a></h1> <h1 class='refname'>tidy_get_root</h1> <p class='verinfo'>(PHP 5, PECL tidy 0.5.2-1.0.0)</p><p class='refpurpose'><span class='refname'>tidy::root</span> -- <span class='refname'>tidy_get_root</span> &amp;mdash; <span class='dc-title'>Returns a <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object representing the root of the tidy parse tree</span></p> </div> <a name='tidy.root.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidynode.php' class='type tidyNode'>tidyNode</a></span> <span class='methodname'><b>tidy_get_root</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidynode.php' class='type tidyNode'>tidyNode</a></span> <span class='methodname'><b>tidy::root</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns a <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object representing the root of the tidy parse tree. </p> </div> <a name='tidy.root.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='tidy.root.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object. </p> </div> <a name='tidy.root.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::root()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;html&amp;gt;&amp;lt;body&amp;gt;<br /><br />&amp;lt;p&amp;gt;paragraph&amp;lt;/p&amp;gt;<br />&amp;lt;br/&amp;gt;<br /><br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;<br /></span><span style='color: #007700'>HTML;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>dump_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>root</span><span style='color: #007700'>(),&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>dump_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$indent</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>hasChildren</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>child&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>str_repeat</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$indent</span><span style='color: #007700'>*</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;(</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name&amp;nbsp;</span><span style='color: #007700'>?&amp;nbsp;</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name&amp;nbsp;</span><span style='color: #007700'>:&amp;nbsp;</span><span style='color: #DD0000'>'''</span><span style='color: #007700'>.</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>value</span><span style='color: #007700'>.</span><span style='color: #DD0000'>'''</span><span style='color: #007700'>).&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>dump_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$indent</span><span style='color: #007700'>+</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> ..html ....head ......title ....body ......p ........&amp;quot;paragraph&amp;quot; ......br </pre></div> </div> </div><p> </p> </div> <a name='tidy.root.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> This function is only available with Zend Engine 2 (PHP &amp;gt;= 5.0.0).</span></p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_get_release" value="<div id='tidy.getrelease' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.getrelease.php'>tidy::getRelease</a></h1> <h1 class='refname'>tidy_get_release</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::getRelease</span> -- <span class='refname'>tidy_get_release</span> &amp;mdash; <span class='dc-title'>Get release date (version) for Tidy library</span></p> </div> <a name='tidy.getrelease.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>tidy_get_release</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>tidy::getRelease</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Gets the release date of the Tidy library. </p> </div> <a name='tidy.getrelease.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string with the release date of the Tidy library. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_get_output" value="<div id='function.tidy-get-output' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.tidy-get-output.php'>tidy_get_output</a></h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy_get_output</span> &amp;mdash; <span class='dc-title'>Return a string representing the parsed tidy markup</span></p> </div> <a name='function.tidy-get-output.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>tidy_get_output</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'> Gets a string with the repaired html. </p> </div> <a name='function.tidy-get-output.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='function.tidy-get-output.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the parsed tidy markup. </p> </div> <a name='function.tidy-get-output.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy_get_output()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;p&amp;gt;paragraph&amp;lt;/i&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CleanRepair</span><span style='color: #007700'>();<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>tidy_get_output</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;!DOCTYPE html PUBLIC &amp;quot;-//W3C//DTD HTML 3.2//EN&amp;quot;&amp;gt; &amp;lt;html&amp;gt; &amp;lt;head&amp;gt; &amp;lt;title&amp;gt;&amp;lt;/title&amp;gt; &amp;lt;/head&amp;gt; &amp;lt;body&amp;gt; &amp;lt;p&amp;gt;paragraph&amp;lt;/p&amp;gt; &amp;lt;/body&amp;gt; &amp;lt;/html&amp;gt; </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_get_html_ver" value="<div id='tidy.gethtmlver' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.gethtmlver.php'>tidy::htmlver</a></h1> <h1 class='refname'>tidy_get_html_ver</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::htmlver</span> -- <span class='refname'>tidy_get_html_ver</span> &amp;mdash; <span class='dc-title'>Get the Detected HTML version for the specified document</span></p> </div> <a name='tidy.gethtmlver.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>tidy_get_html_ver</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>tidy::getHtmlVer</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns the detected HTML version for the specified tidy <i><tt class='parameter'>object</tt></i> . </p> </div> <a name='tidy.gethtmlver.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='tidy.gethtmlver.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the detected HTML version. </p> <div class='warning'><b class='warning'>Warning</b> <p class='para'> This function is not yet implemented in the Tidylib itself, so it always return <i>0</i>. </p> </div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_get_html" value="<div id='tidy.html' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.html.php'>tidy::html</a></h1> <h1 class='refname'>tidy_get_html</h1> <p class='verinfo'>(PHP 5, PECL tidy 0.5.2-1.0.0)</p><p class='refpurpose'><span class='refname'>tidy::html</span> -- <span class='refname'>tidy_get_html</span> &amp;mdash; <span class='dc-title'>Returns a <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object starting from the &amp;lt;html&amp;gt; tag of the tidy parse tree</span></p> </div> <a name='tidy.html.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidynode.php' class='type tidyNode'>tidyNode</a></span> <span class='methodname'><b>tidy_get_html</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidynode.php' class='type tidyNode'>tidyNode</a></span> <span class='methodname'><b>tidy::html</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns a <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object starting from the &amp;lt;html&amp;gt; tag of the tidy parse tree. </p> </div> <a name='tidy.html.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='tidy.html.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object. </p> </div> <a name='tidy.html.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::html()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'<br />&amp;lt;html&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;title&amp;gt;test&amp;lt;/title&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;body&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;p&amp;gt;paragraph&amp;lt;/p&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/body&amp;gt;<br />&amp;lt;/html&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>();<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>value</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;html&amp;gt; &amp;lt;head&amp;gt; &amp;lt;title&amp;gt;test&amp;lt;/title&amp;gt; &amp;lt;/head&amp;gt; &amp;lt;body&amp;gt; &amp;lt;p&amp;gt;paragraph&amp;lt;/p&amp;gt; &amp;lt;/body&amp;gt; &amp;lt;/html&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='tidy.html.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> This function is only available with Zend Engine 2 (PHP &amp;gt;= 5.0.0).</span></p></blockquote> </div> <a name='tidy.html.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/tidy.body.php' class='function' rel='rdfs-seeAlso'>tidy::body()</a> - Returns a tidyNode object starting from the <body> tag of the tidy parse tree</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.head.php' class='function' rel='rdfs-seeAlso'>tidy::head()</a> - Returns a tidyNode object starting from the <head> tag of the tidy parse tree</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_get_head" value="<div id='tidy.head' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.head.php'>tidy::head</a></h1> <h1 class='refname'>tidy_get_head</h1> <p class='verinfo'>(PHP 5, PECL tidy 0.5.2-1.0.0)</p><p class='refpurpose'><span class='refname'>tidy::head</span> -- <span class='refname'>tidy_get_head</span> &amp;mdash; <span class='dc-title'>Returns a <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object starting from the &amp;lt;head&amp;gt; tag of the tidy parse tree</span></p> </div> <a name='tidy.head.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidynode.php' class='type tidyNode'>tidyNode</a></span> <span class='methodname'><b>tidy_get_head</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidynode.php' class='type tidyNode'>tidyNode</a></span> <span class='methodname'><b>tidy::head</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns a <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object starting from the &amp;lt;head&amp;gt; tag of the tidy parse tree. </p> </div> <a name='tidy.head.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='tidy.head.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object. </p> </div> <a name='tidy.head.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::head()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'<br />&amp;lt;html&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;title&amp;gt;test&amp;lt;/title&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;body&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;p&amp;gt;paragraph&amp;lt;/p&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/body&amp;gt;<br />&amp;lt;/html&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$head&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>head</span><span style='color: #007700'>();<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$head</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>value</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;head&amp;gt; &amp;lt;title&amp;gt;test&amp;lt;/title&amp;gt; &amp;lt;/head&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='tidy.head.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> This function is only available with Zend Engine 2 (PHP &amp;gt;= 5.0.0).</span></p></blockquote> </div> <a name='tidy.head.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/tidy.body.php' class='function' rel='rdfs-seeAlso'>tidy::body()</a> - Returns a tidyNode object starting from the <body> tag of the tidy parse tree</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.html.php' class='function' rel='rdfs-seeAlso'>tidy::html()</a> - Returns a tidyNode object starting from the <html> tag of the tidy parse tree</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_get_error_buffer" value="<div id='function.tidy-get-error-buffer' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.tidy-get-error-buffer.php'>tidy_get_error_buffer</a></h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy_get_error_buffer</span> &amp;mdash; <span class='dc-title'>Return warnings and errors which occurred parsing the specified document</span></p> </div> <a name='function.tidy-get-error-buffer.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>tidy_get_error_buffer</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>tidy</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$errorBuffer</var>;</div> </div> <p class='para'> Returns warnings and errors which occurred parsing the specified document. </p> </div> <a name='function.tidy-get-error-buffer.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='function.tidy-get-error-buffer.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the error buffer as a string. </p> </div> <a name='function.tidy-get-error-buffer.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy_get_error_buffer()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;p&amp;gt;paragraph&amp;lt;/p&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>tidy_get_error_buffer</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>/*&amp;nbsp;or&amp;nbsp;in&amp;nbsp;OO:&amp;nbsp;*/<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>errorBuffer</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> line 1 column 1 - Warning: missing &amp;lt;!DOCTYPE&amp;gt; declaration line 1 column 1 - Warning: inserting missing &amp;#039;title&amp;#039; element </pre></div> </div> </div><p> </p> </div> <a name='function.tidy-get-error-buffer.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.tidy-access-count.php' class='function' rel='rdfs-seeAlso'>tidy_access_count()</a> - Returns the Number of Tidy accessibility warnings encountered for specified document</li> <li class='member'><a href='http://www.php.net/manual/en/function.tidy-error-count.php' class='function' rel='rdfs-seeAlso'>tidy_error_count()</a> - Returns the Number of Tidy errors encountered for specified document</li> <li class='member'><a href='http://www.php.net/manual/en/function.tidy-warning-count.php' class='function' rel='rdfs-seeAlso'>tidy_warning_count()</a> - Returns the Number of Tidy warnings encountered for specified document</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_get_config" value="<div id='tidy.getconfig' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.getconfig.php'>tidy::getConfig</a></h1> <h1 class='refname'>tidy_get_config</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.7.0)</p><p class='refpurpose'><span class='refname'>tidy::getConfig</span> -- <span class='refname'>tidy_get_config</span> &amp;mdash; <span class='dc-title'>Get current Tidy configuration</span></p> </div> <a name='tidy.getconfig.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>tidy_get_config</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>tidy::getConfig</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Gets the list of the configuration options in use by the given tidy <i><tt class='parameter'>object</tt></i> . </p> </div> <a name='tidy.getconfig.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='tidy.getconfig.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of configuration options. </p> <p class='para'> For an explanation about each option, visit <a href='http://tidy.sourceforge.net/docs/quickref.html' class='link external'>&amp;raquo; http://tidy.sourceforge.net/docs/quickref.html</a>. </p> </div> <a name='tidy.getconfig.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::getConfig()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;p&amp;gt;test&amp;lt;/p&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$config&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'indent'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>TRUE</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'output-xhtml'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>TRUE</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'wrap'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$config</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>getConfig</span><span style='color: #007700'>());<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Array ( [indent-spaces] =&amp;gt; 2 [wrap] =&amp;gt; 200 [tab-size] =&amp;gt; 8 [char-encoding] =&amp;gt; 1 [input-encoding] =&amp;gt; 3 [output-encoding] =&amp;gt; 1 [newline] =&amp;gt; 1 [doctype-mode] =&amp;gt; 1 [doctype] =&amp;gt; [repeated-attributes] =&amp;gt; 1 [alt-text] =&amp;gt; [slide-style] =&amp;gt; [error-file] =&amp;gt; [output-file] =&amp;gt; [write-back] =&amp;gt; [markup] =&amp;gt; 1 [show-warnings] =&amp;gt; 1 [quiet] =&amp;gt; [indent] =&amp;gt; 1 [hide-endtags] =&amp;gt; [input-xml] =&amp;gt; [output-xml] =&amp;gt; 1 [output-xhtml] =&amp;gt; 1 [output-html] =&amp;gt; [add-xml-decl] =&amp;gt; [uppercase-tags] =&amp;gt; [uppercase-attributes] =&amp;gt; [bare] =&amp;gt; [clean] =&amp;gt; [logical-emphasis] =&amp;gt; [drop-proprietary-attributes] =&amp;gt; [drop-font-tags] =&amp;gt; [drop-empty-paras] =&amp;gt; 1 [fix-bad-comments] =&amp;gt; 1 [break-before-br] =&amp;gt; [split] =&amp;gt; [numeric-entities] =&amp;gt; [quote-marks] =&amp;gt; [quote-nbsp] =&amp;gt; 1 [quote-ampersand] =&amp;gt; 1 [wrap-attributes] =&amp;gt; [wrap-script-literals] =&amp;gt; [wrap-sections] =&amp;gt; 1 [wrap-asp] =&amp;gt; 1 [wrap-jste] =&amp;gt; 1 [wrap-php] =&amp;gt; 1 [fix-backslash] =&amp;gt; 1 [indent-attributes] =&amp;gt; [assume-xml-procins] =&amp;gt; [add-xml-space] =&amp;gt; [enclose-text] =&amp;gt; [enclose-block-text] =&amp;gt; [keep-time] =&amp;gt; [word-2000] =&amp;gt; [tidy-mark] =&amp;gt; [gnu-emacs] =&amp;gt; [gnu-emacs-file] =&amp;gt; [literal-attributes] =&amp;gt; [show-body-only] =&amp;gt; [fix-uri] =&amp;gt; 1 [lower-literals] =&amp;gt; 1 [hide-comments] =&amp;gt; [indent-cdata] =&amp;gt; [force-output] =&amp;gt; 1 [show-errors] =&amp;gt; 6 [ascii-chars] =&amp;gt; 1 [join-classes] =&amp;gt; [join-styles] =&amp;gt; 1 [escape-cdata] =&amp;gt; [language] =&amp;gt; [ncr] =&amp;gt; 1 [output-bom] =&amp;gt; 2 [replace-color] =&amp;gt; [css-prefix] =&amp;gt; [new-inline-tags] =&amp;gt; [new-blocklevel-tags] =&amp;gt; [new-empty-tags] =&amp;gt; [new-pre-tags] =&amp;gt; [accessibility-check] =&amp;gt; 0 [vertical-space] =&amp;gt; [punctuation-wrap] =&amp;gt; [merge-divs] =&amp;gt; 1 ) </pre></div> </div> </div><p> </p> </div> <a name='tidy.getconfig.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><b>tidy::resetConfig()</b></li> <li class='member'><b>tidy::saveConfig()</b></li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_get_body" value="<div id='tidy.body' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.body.php'>tidy::body</a></h1> <h1 class='refname'>tidy_get_body</h1> <p class='verinfo'>(PHP 5, PECL tidy 0.5.2-1.0)</p><p class='refpurpose'><span class='refname'>tidy::body</span> -- <span class='refname'>tidy_get_body</span> &amp;mdash; <span class='dc-title'>Returns a <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object starting from the &amp;lt;body&amp;gt; tag of the tidy parse tree</span></p> </div> <a name='tidy.body.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidynode.php' class='type tidyNode'>tidyNode</a></span> <span class='methodname'><b>tidy_get_body</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidynode.php' class='type tidyNode'>tidyNode</a></span> <span class='methodname'><b>tidy::body</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns a <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>tidyNode</a> object starting from the &amp;lt;body&amp;gt; tag of the tidy parse tree. </p> </div> <a name='tidy.body.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='tidy.body.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the detected HTML version. </p> <div class='warning'><b class='warning'>Warning</b> <p class='para'> This function is not yet implemented in the Tidylib itself, so it always return <i>0</i>. </p> </div> </div> <a name='tidy.body.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::getBody()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'<br />&amp;lt;html&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;title&amp;gt;test&amp;lt;/title&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;body&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;p&amp;gt;paragraph&amp;lt;/p&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/body&amp;gt;<br />&amp;lt;/html&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$body&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Body</span><span style='color: #007700'>();<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$body</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>value</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;body&amp;gt; &amp;lt;p&amp;gt;paragraph&amp;lt;/p&amp;gt; &amp;lt;/body&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='tidy.body.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> This function is only available with Zend Engine 2 (PHP &amp;gt;= 5.0.0).</span></p></blockquote> </div> <a name='tidy.body.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/tidy.head.php' class='function' rel='rdfs-seeAlso'>tidy::head()</a> - Returns a tidyNode object starting from the <head> tag of the tidy parse tree</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.html.php' class='function' rel='rdfs-seeAlso'>tidy::html()</a> - Returns a tidyNode object starting from the <html> tag of the tidy parse tree</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_error_count" value="<div id='function.tidy-error-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.tidy-error-count.php'>tidy_error_count</a></h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy_error_count</span> &amp;mdash; <span class='dc-title'>Returns the Number of Tidy errors encountered for specified document</span></p> </div> <a name='function.tidy-error-count.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>tidy_error_count</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of Tidy errors encountered for the specified document. </p> </div> <a name='function.tidy-error-count.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='function.tidy-error-count.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of errors. </p> </div> <a name='function.tidy-error-count.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy_error_count()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;p&amp;gt;test&amp;lt;/i&amp;gt;<br />&amp;lt;bogustag&amp;gt;bogus&amp;lt;/bogustag&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>tidy_error_count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//1<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>errorBuffer</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1 line 1 column 1 - Warning: missing &amp;lt;!DOCTYPE&amp;gt; declaration line 1 column 8 - Warning: discarding unexpected &amp;lt;/i&amp;gt; line 2 column 1 - Error: &amp;lt;bogustag&amp;gt; is not recognized! line 2 column 1 - Warning: discarding unexpected &amp;lt;bogustag&amp;gt; line 2 column 16 - Warning: discarding unexpected &amp;lt;/bogustag&amp;gt; line 1 column 1 - Warning: inserting missing &amp;#039;title&amp;#039; element </pre></div> </div> </div><p> </p> </div> <a name='function.tidy-error-count.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.tidy-access-count.php' class='function' rel='rdfs-seeAlso'>tidy_access_count()</a> - Returns the Number of Tidy accessibility warnings encountered for specified document</li> <li class='member'><a href='http://www.php.net/manual/en/function.tidy-warning-count.php' class='function' rel='rdfs-seeAlso'>tidy_warning_count()</a> - Returns the Number of Tidy warnings encountered for specified document</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_diagnose" value="<div id='function.tidy-diagnose' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.tidy-diagnose.php'>tidy::diagnose</a></h1> <h1 class='refname'>tidy_diagnose</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::diagnose</span> -- <span class='refname'>tidy_diagnose</span> &amp;mdash; <span class='dc-title'>Run configured diagnostics on parsed and repaired markup</span></p> </div> <a name='function.tidy-diagnose.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidy_diagnose</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidy::diagnose</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Runs diagnostic tests on the given tidy <i><tt class='parameter'>object</tt></i> , adding some more information about the document in the error buffer. </p> </div> <a name='function.tidy-diagnose.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='function.tidy-diagnose.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.tidy-diagnose.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::diagnose()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;!DOCTYPE&amp;nbsp;html&amp;nbsp;PUBLIC&amp;nbsp;'-//W3C//DTD&amp;nbsp;XHTML&amp;nbsp;1.0&amp;nbsp;Strict//EN'<br />'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'&amp;gt;<br /><br />&amp;lt;p&amp;gt;paragraph&amp;lt;/p&amp;gt;<br /></span><span style='color: #007700'>HTML;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CleanRepair</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;note&amp;nbsp;the&amp;nbsp;difference&amp;nbsp;between&amp;nbsp;the&amp;nbsp;two&amp;nbsp;outputs<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>errorBuffer&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>diagnose</span><span style='color: #007700'>();<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>errorBuffer</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> line 4 column 1 - Warning: &amp;lt;p&amp;gt; isn&amp;#039;t allowed in &amp;lt;head&amp;gt; elements line 4 column 1 - Warning: inserting missing &amp;#039;title&amp;#039; element line 4 column 1 - Warning: &amp;lt;p&amp;gt; isn&amp;#039;t allowed in &amp;lt;head&amp;gt; elements line 4 column 1 - Warning: inserting missing &amp;#039;title&amp;#039; element Info: Doctype given is &amp;quot;-//W3C//DTD XHTML 1.0 Strict//EN&amp;quot; Info: Document content looks like XHTML 1.0 Strict 2 warnings, 0 errors were found! </pre></div> </div> </div><p> </p> </div> <a name='function.tidy-diagnose.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><b>tidy::errorBuffer()</b></li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_config_count" value="<div id='function.tidy-config-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.tidy-config-count.php'>tidy_config_count</a></h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy_config_count</span> &amp;mdash; <span class='dc-title'>Returns the Number of Tidy configuration errors encountered for specified document</span></p> </div> <a name='function.tidy-config-count.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>tidy_config_count</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of errors encountered in the configuration of the specified tidy <i><tt class='parameter'>object</tt></i> . </p> </div> <a name='function.tidy-config-count.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='function.tidy-config-count.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of errors. </p> </div> <a name='function.tidy-config-count.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy_config_count()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;p&amp;gt;test&amp;lt;/I&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$config&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'doctype'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'bogus'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$config</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;This&amp;nbsp;outputs&amp;nbsp;1,&amp;nbsp;because&amp;nbsp;'bogus'&amp;nbsp;isn't&amp;nbsp;a&amp;nbsp;valid&amp;nbsp;doctype&amp;nbsp;*/<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>tidy_config_count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_clean_repair" value="<div id='tidy.cleanrepair' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.cleanrepair.php'>tidy::CleanRepair</a></h1> <h1 class='refname'>tidy_clean_repair</h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::CleanRepair</span> -- <span class='refname'>tidy_clean_repair</span> &amp;mdash; <span class='dc-title'>Execute configured cleanup and repair operations on parsed markup</span></p> </div> <a name='tidy.cleanrepair.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidy_clean_repair</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidy::cleanRepair</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> This function cleans and repairs the given tidy <i><tt class='parameter'>object</tt></i> . </p> </div> <a name='tidy.cleanrepair.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='tidy.cleanrepair.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='tidy.cleanrepair.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::cleanrepair()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;p&amp;gt;test&amp;lt;/I&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CleanRepair</span><span style='color: #007700'>();<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;!DOCTYPE html PUBLIC &amp;quot;-//W3C//DTD HTML 3.2//EN&amp;quot;&amp;gt; &amp;lt;html&amp;gt; &amp;lt;head&amp;gt; &amp;lt;title&amp;gt;&amp;lt;/title&amp;gt; &amp;lt;/head&amp;gt; &amp;lt;body&amp;gt; &amp;lt;p&amp;gt;test&amp;lt;/p&amp;gt; &amp;lt;/body&amp;gt; &amp;lt;/html&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='tidy.cleanrepair.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/tidy.repairfile.php' class='function' rel='rdfs-seeAlso'>tidy::repairFile()</a> - Repair a file and return it as a string</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.repairstring.php' class='function' rel='rdfs-seeAlso'>tidy::repairString()</a> - Repair a string using an optionally provided configuration file</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy_access_count" value="<div id='function.tidy-access-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.tidy-access-count.php'>tidy_access_count</a></h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy_access_count</span> &amp;mdash; <span class='dc-title'>Returns the Number of Tidy accessibility warnings encountered for specified document</span></p> </div> <a name='function.tidy-access-count.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>tidy_access_count</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <p class='para rdfs-comment'> <b>tidy_access_count()</b> returns the number of accessibility warnings found for the specified document. </p> </div> <a name='function.tidy-access-count.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> object. </p> </dd> </dl> <p> </p> </div> <a name='function.tidy-access-count.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of warnings. </p> </div> <a name='function.tidy-access-count.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy_access_count()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=</span><span style='color: #DD0000'>'&amp;lt;!DOCTYPE&amp;nbsp;html&amp;nbsp;PUBLIC&amp;nbsp;'-//W3C//DTD&amp;nbsp;HTML&amp;nbsp;3.2//EN'&amp;gt;<br />&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;&amp;lt;title&amp;gt;Title&amp;lt;/title&amp;gt;&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br /><br />&amp;lt;p&amp;gt;&amp;lt;img&amp;nbsp;src='img.png'&amp;gt;&amp;lt;/p&amp;gt;<br /><br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;'</span><span style='color: #007700'>;<br /><br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;select&amp;nbsp;the&amp;nbsp;accessibility&amp;nbsp;check&amp;nbsp;level:&amp;nbsp;1,&amp;nbsp;2&amp;nbsp;or&amp;nbsp;3<br /></span><span style='color: #0000BB'>$config&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'accessibility-check'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>tidy</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>parseString</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$config</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CleanRepair</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Never&amp;nbsp;forget&amp;nbsp;to&amp;nbsp;call&amp;nbsp;this!&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>diagnose</span><span style='color: #007700'>();<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>tidy_access_count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//5<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.tidy-access-count.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Due to the design of the TidyLib, you must call <a href='http://www.php.net/manual/en/function.tidy-diagnose.php' class='function'>tidy_diagnose()</a> before <b>tidy_access_count()</b> or it will return always <i>0</i>. You must also need to enable the <i>accessibility-check</i> option. <br /> </p></blockquote> </div> <a name='function.tidy-access-count.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.tidy-error-count.php' class='function' rel='rdfs-seeAlso'>tidy_error_count()</a> - Returns the Number of Tidy errors encountered for specified document</li> <li class='member'><a href='http://www.php.net/manual/en/function.tidy-warning-count.php' class='function' rel='rdfs-seeAlso'>tidy_warning_count()</a> - Returns the Number of Tidy warnings encountered for specified document</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidyNode::isText" value="<div id='tidynode.istext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidynode.istext.php'>tidyNode::isText</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.0.1)</p><p class='refpurpose'><span class='refname'>tidyNode::isText</span> &amp;mdash; <span class='dc-title'>Checks if a node represents text (no markup)</span></p> </div> <a name='tidynode.istext.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidyNode::isText</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells if the node represents a text (without any markup). </p> </div> <a name='tidynode.istext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the node represent a text, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='tidynode.istext.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Extract text from a mixed HTML document</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;<br />&amp;lt;?php&amp;nbsp;echo&amp;nbsp;'&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;';&amp;nbsp;?&amp;gt;<br />&amp;lt;#&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;JSTE&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;alert('Hello&amp;nbsp;World');&amp;nbsp;<br />#&amp;gt;<br />&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br /><br />&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;PHP&amp;nbsp;code<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;'hello&amp;nbsp;world!';<br />?&amp;gt;<br /><br />&amp;lt;%<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;ASP&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;response.write('Hello&amp;nbsp;World!')<br />%&amp;gt;<br /><br />&amp;lt;!--&amp;nbsp;Comments&amp;nbsp;--&amp;gt;<br />Hello&amp;nbsp;World<br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;<br />Outside&amp;nbsp;HTML<br /></span><span style='color: #007700'>HTML;<br /><br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>(),&amp;nbsp;</span><span style='color: #DD0000'>'text'</span><span style='color: #007700'>);<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;is&amp;nbsp;of&amp;nbsp;requested&amp;nbsp;type<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;{</span><span style='color: #DD0000'>'is</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>'</span><span style='color: #007700'>}())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\n\n#&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>&amp;nbsp;node&amp;nbsp;#'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;++</span><span style='color: #0000BB'>$GLOBALS</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'num'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>value</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;has&amp;nbsp;childrens<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>hasChildren</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>child&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> # text node #1 Hello World # text node #2 Outside HTML </pre></div> </div> </div><p> </p> </div> <a name='tidynode.istext.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function was named <b>tidy_node::is_text()</b> in PHP 4/Tidy 1. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidyNode::isPhp" value="<div id='tidynode.isphp' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidynode.isphp.php'>tidyNode::isPhp</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.0.1)</p><p class='refpurpose'><span class='refname'>tidyNode::isPhp</span> &amp;mdash; <span class='dc-title'>Checks if a node is PHP</span></p> </div> <a name='tidynode.isphp.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidyNode::isPhp</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells if the node is PHP. </p> </div> <a name='tidynode.isphp.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the current node is PHP code, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='tidynode.isphp.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Extract PHP code from a mixed HTML document</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;<br />&amp;lt;?php&amp;nbsp;echo&amp;nbsp;'&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;';&amp;nbsp;?&amp;gt;<br />&amp;lt;#&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;JSTE&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;alert('Hello&amp;nbsp;World');&amp;nbsp;<br />#&amp;gt;<br />&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br /><br />&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;PHP&amp;nbsp;code<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;'hello&amp;nbsp;world!';<br />?&amp;gt;<br /><br />&amp;lt;%<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;ASP&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;response.write('Hello&amp;nbsp;World!')<br />%&amp;gt;<br /><br />&amp;lt;!--&amp;nbsp;Comments&amp;nbsp;--&amp;gt;<br />Hello&amp;nbsp;World<br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;<br />Outside&amp;nbsp;HTML<br /></span><span style='color: #007700'>HTML;<br /><br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>(),&amp;nbsp;</span><span style='color: #DD0000'>'php'</span><span style='color: #007700'>);<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;is&amp;nbsp;of&amp;nbsp;requested&amp;nbsp;type<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;{</span><span style='color: #DD0000'>'is</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>'</span><span style='color: #007700'>}())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\n\n#&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>&amp;nbsp;node&amp;nbsp;#'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;++</span><span style='color: #0000BB'>$GLOBALS</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'num'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>value</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;has&amp;nbsp;childrens<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>hasChildren</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>child&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> # php node #1 &amp;lt;?php echo &amp;#039;&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;&amp;#039;; ?&amp;gt; # php node #2 &amp;lt;?php // PHP code echo &amp;#039;hello world!&amp;#039;; ?&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='tidynode.isphp.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function was named <b>tidy_node::is_php()</b> in PHP 4/Tidy 1. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidyNode::isJste" value="<div id='tidynode.isjste' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidynode.isjste.php'>tidyNode::isJste</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.0.1)</p><p class='refpurpose'><span class='refname'>tidyNode::isJste</span> &amp;mdash; <span class='dc-title'>Checks if this node is JSTE</span></p> </div> <a name='tidynode.isjste.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidyNode::isJste</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells if the node is JSTE. </p> </div> <a name='tidynode.isjste.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the node is JSTE, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='tidynode.isjste.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Extract JSTE code from a mixed HTML document</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;<br />&amp;lt;?php&amp;nbsp;echo&amp;nbsp;'&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;';&amp;nbsp;?&amp;gt;<br />&amp;lt;#&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;JSTE&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;alert('Hello&amp;nbsp;World');&amp;nbsp;<br />#&amp;gt;<br />&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br /><br />&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;PHP&amp;nbsp;code<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;'hello&amp;nbsp;world!';<br />?&amp;gt;<br /><br />&amp;lt;%<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;ASP&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;response.write('Hello&amp;nbsp;World!')<br />%&amp;gt;<br /><br />&amp;lt;!--&amp;nbsp;Comments&amp;nbsp;--&amp;gt;<br />Hello&amp;nbsp;World<br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;<br />Outside&amp;nbsp;HTML<br /></span><span style='color: #007700'>HTML;<br /><br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>(),&amp;nbsp;</span><span style='color: #DD0000'>'text'</span><span style='color: #007700'>);<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;is&amp;nbsp;of&amp;nbsp;requested&amp;nbsp;type<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;{</span><span style='color: #DD0000'>'is</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>'</span><span style='color: #007700'>}())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\n\n#&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>&amp;nbsp;node&amp;nbsp;#'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;++</span><span style='color: #0000BB'>$GLOBALS</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'num'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>value</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;has&amp;nbsp;childrens<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>hasChildren</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>child&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> # jste node #1 &amp;lt;# /* JSTE code */ alert(&amp;#039;Hello World&amp;#039;); #&amp;gt; /* var_dump($tidy-&amp;gt;html()-&amp;gt;child[0]-&amp;gt;hasChildren()); var_dump($tidy-&amp;gt;html()-&amp;gt;child[0]-&amp;gt;child[0]-&amp;gt;hasChildren()); */ </pre></div> </div> </div><p> </p> </div> <a name='tidynode.isjste.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function was named <b>tidy_node::is_jste()</b> in PHP 4/Tidy 1. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidyNode::isHtml" value="<div id='tidynode.ishtml' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidynode.ishtml.php'>tidyNode::isHtml</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.0.1)</p><p class='refpurpose'><span class='refname'>tidyNode::isHtml</span> &amp;mdash; <span class='dc-title'>Checks if a node is part of a HTML document</span></p> </div> <a name='tidynode.ishtml.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidyNode::isHtml</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells if the node is part of HTML document. </p> </div> <a name='tidynode.ishtml.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the node is part of a HTML document, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='tidynode.ishtml.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Extract HTML code from a mixed HTML document</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;<br />&amp;lt;?php&amp;nbsp;echo&amp;nbsp;'&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;';&amp;nbsp;?&amp;gt;<br />&amp;lt;#&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;JSTE&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;alert('Hello&amp;nbsp;World');&amp;nbsp;<br />#&amp;gt;<br />&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br /><br />&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;PHP&amp;nbsp;code<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;'hello&amp;nbsp;world!';<br />?&amp;gt;<br /><br />&amp;lt;%<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;ASP&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;response.write('Hello&amp;nbsp;World!')<br />%&amp;gt;<br /><br />&amp;lt;!--&amp;nbsp;Comments&amp;nbsp;--&amp;gt;<br />Hello&amp;nbsp;World<br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;<br />Outside&amp;nbsp;HTML<br /></span><span style='color: #007700'>HTML;<br /><br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>(),&amp;nbsp;</span><span style='color: #DD0000'>'text'</span><span style='color: #007700'>);<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;is&amp;nbsp;of&amp;nbsp;requested&amp;nbsp;type<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;{</span><span style='color: #DD0000'>'is</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>'</span><span style='color: #007700'>}())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\n\n#&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>&amp;nbsp;node&amp;nbsp;#'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;++</span><span style='color: #0000BB'>$GLOBALS</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'num'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>value</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;has&amp;nbsp;childrens<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>hasChildren</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>child&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> # html node #1 &amp;lt;html&amp;gt; &amp;lt;head&amp;gt; &amp;lt;?php echo &amp;#039;&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;&amp;#039;; ?&amp;gt;&amp;lt;# /* JSTE code */ alert(&amp;#039;Hello World&amp;#039;); #&amp;gt; &amp;lt;title&amp;gt;&amp;lt;/title&amp;gt; &amp;lt;/head&amp;gt; &amp;lt;body&amp;gt; &amp;lt;?php // PHP code echo &amp;#039;hello world!&amp;#039;; ?&amp;gt;&amp;lt;% /* ASP code */ response.write(&amp;quot;Hello World!&amp;quot;) %&amp;gt;&amp;lt;!-- Comments --&amp;gt; Hello WorldOutside HTML &amp;lt;/body&amp;gt; &amp;lt;/html&amp;gt; # html node #2 &amp;lt;head&amp;gt; &amp;lt;?php echo &amp;#039;&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;&amp;#039;; ?&amp;gt;&amp;lt;# /* JSTE code */ alert(&amp;#039;Hello World&amp;#039;); #&amp;gt; &amp;lt;title&amp;gt;&amp;lt;/title&amp;gt; &amp;lt;/head&amp;gt; # html node #3 &amp;lt;?php echo &amp;#039;&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;&amp;#039;; ?&amp;gt; # html node #4 &amp;lt;# /* JSTE code */ alert(&amp;#039;Hello World&amp;#039;); #&amp;gt; # html node #5 &amp;lt;title&amp;gt;&amp;lt;/title&amp;gt; # html node #6 &amp;lt;body&amp;gt; &amp;lt;?php // PHP code echo &amp;#039;hello world!&amp;#039;; ?&amp;gt;&amp;lt;% /* ASP code */ response.write(&amp;quot;Hello World!&amp;quot;) %&amp;gt;&amp;lt;!-- Comments --&amp;gt; Hello WorldOutside HTML &amp;lt;/body&amp;gt; # html node #7 &amp;lt;?php // PHP code echo &amp;#039;hello world!&amp;#039;; ?&amp;gt; # html node #8 &amp;lt;% /* ASP code */ response.write(&amp;quot;Hello World!&amp;quot;) %&amp;gt; # html node #9 &amp;lt;!-- Comments --&amp;gt; # html node #10 Hello World # html node #11 Outside HTML </pre></div> </div> </div><p> </p> </div> <a name='tidynode.ishtml.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function was named <b>tidy_node::is_html()</b> in PHP 4/Tidy 1. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidyNode::isComment" value="<div id='tidynode.iscomment' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidynode.iscomment.php'>tidyNode::isComment</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.0.1)</p><p class='refpurpose'><span class='refname'>tidyNode::isComment</span> &amp;mdash; <span class='dc-title'>Checks if a node represents a comment</span></p> </div> <a name='tidynode.iscomment.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidyNode::isComment</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells if the node is a comment. </p> </div> <a name='tidynode.iscomment.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the node is a comment, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='tidynode.iscomment.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Extract comments from a mixed HTML document</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;<br />&amp;lt;?php&amp;nbsp;echo&amp;nbsp;'&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;';&amp;nbsp;?&amp;gt;<br />&amp;lt;#&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;JSTE&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;alert('Hello&amp;nbsp;World');&amp;nbsp;<br />#&amp;gt;<br />&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br /><br />&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;PHP&amp;nbsp;code<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;'hello&amp;nbsp;world!';<br />?&amp;gt;<br /><br />&amp;lt;%<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;ASP&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;response.write('Hello&amp;nbsp;World!')<br />%&amp;gt;<br /><br />&amp;lt;!--&amp;nbsp;Comments&amp;nbsp;--&amp;gt;<br />Hello&amp;nbsp;World<br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;<br />Outside&amp;nbsp;HTML<br /></span><span style='color: #007700'>HTML;<br /><br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>(),&amp;nbsp;</span><span style='color: #DD0000'>'comment'</span><span style='color: #007700'>);<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;is&amp;nbsp;of&amp;nbsp;requested&amp;nbsp;type<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;{</span><span style='color: #DD0000'>'is</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>'</span><span style='color: #007700'>}())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\n\n#&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>&amp;nbsp;node&amp;nbsp;#'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;++</span><span style='color: #0000BB'>$GLOBALS</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'num'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>value</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;has&amp;nbsp;childrens<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>hasChildren</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>child&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> # jste node #1 &amp;lt;# /* JSTE code */ alert(&amp;#039;Hello World&amp;#039;); #&amp;gt; /* var_dump($tidy-&amp;gt;html()-&amp;gt;child[0]-&amp;gt;hasChildren()); var_dump($tidy-&amp;gt;html()-&amp;gt;child[0]-&amp;gt;child[0]-&amp;gt;hasChildren()); */ </pre></div> </div> </div><p> </p> </div> <a name='tidynode.iscomment.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function was named <b>tidy_node::is_comment()</b> in PHP 4/Tidy 1. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidyNode::isAsp" value="<div id='tidynode.isasp' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidynode.isasp.php'>tidyNode::isAsp</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.0.1)</p><p class='refpurpose'><span class='refname'>tidyNode::isAsp</span> &amp;mdash; <span class='dc-title'>Checks if this node is ASP</span></p> </div> <a name='tidynode.isasp.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidyNode::isAsp</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells whether the current node is ASP. </p> </div> <a name='tidynode.isasp.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the node is ASP, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='tidynode.isasp.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Extract ASP code from a mixed HTML document</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;<br />&amp;lt;?php&amp;nbsp;echo&amp;nbsp;'&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;';&amp;nbsp;?&amp;gt;<br />&amp;lt;#&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;JSTE&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;alert('Hello&amp;nbsp;World');&amp;nbsp;<br />#&amp;gt;<br />&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br /><br />&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;PHP&amp;nbsp;code<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;'hello&amp;nbsp;world!';<br />?&amp;gt;<br /><br />&amp;lt;%<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;ASP&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;response.write('Hello&amp;nbsp;World!')<br />%&amp;gt;<br /><br />&amp;lt;!--&amp;nbsp;Comments&amp;nbsp;--&amp;gt;<br />Hello&amp;nbsp;World<br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;<br />Outside&amp;nbsp;HTML<br /></span><span style='color: #007700'>HTML;<br /><br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>(),&amp;nbsp;</span><span style='color: #DD0000'>'asp'</span><span style='color: #007700'>);<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;is&amp;nbsp;of&amp;nbsp;requested&amp;nbsp;type<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;{</span><span style='color: #DD0000'>'is</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>'</span><span style='color: #007700'>}())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\n\n#&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #DD0000'>&amp;nbsp;node&amp;nbsp;#'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;++</span><span style='color: #0000BB'>$GLOBALS</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'num'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>value</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;if&amp;nbsp;the&amp;nbsp;current&amp;nbsp;node&amp;nbsp;has&amp;nbsp;childrens<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>hasChildren</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>child&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>get_nodes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$child</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$node_type</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> # asp node #1 &amp;lt;% /* ASP code */ response.write(&amp;quot;Hello World!&amp;quot;) %&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='tidynode.isasp.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function was named <b>tidy_node::is_asp()</b> in PHP 4/Tidy 1. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidyNode::hasSiblings" value="<div id='tidynode.hassiblings' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidynode.hassiblings.php'>tidyNode::hasSiblings</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.0.1)</p><p class='refpurpose'><span class='refname'>tidyNode::hasSiblings</span> &amp;mdash; <span class='dc-title'>Checks if a node has siblings</span></p> </div> <a name='tidynode.hassiblings.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidyNode::hasSiblings</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells if the node has siblings. </p> </div> <a name='tidynode.hassiblings.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the node has siblings, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='tidynode.hassiblings.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidyNode::hasSiblings()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;<br />&amp;lt;?php&amp;nbsp;echo&amp;nbsp;'&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;';&amp;nbsp;?&amp;gt;<br />&amp;lt;#&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;JSTE&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;alert('Hello&amp;nbsp;World');&amp;nbsp;<br />#&amp;gt;<br />&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br /><br />&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;PHP&amp;nbsp;code<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;'hello&amp;nbsp;world!';<br />?&amp;gt;<br /><br />&amp;lt;%<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;ASP&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;response.write('Hello&amp;nbsp;World!')<br />%&amp;gt;<br /><br />&amp;lt;!--&amp;nbsp;Comments&amp;nbsp;--&amp;gt;<br />Hello&amp;nbsp;World<br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;<br />Outside&amp;nbsp;HTML<br /></span><span style='color: #007700'>HTML;<br /><br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;the&amp;nbsp;html&amp;nbsp;tag<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>()-&amp;gt;</span><span style='color: #0000BB'>hasSiblings</span><span style='color: #007700'>());<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;the&amp;nbsp;head&amp;nbsp;tag<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>()-&amp;gt;</span><span style='color: #0000BB'>child</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]-&amp;gt;</span><span style='color: #0000BB'>hasSiblings</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> bool(false) bool(true) </pre></div> </div> </div><p> </p> </div> <a name='tidynode.hassiblings.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function was named <b>tidy_node::has_siblings()</b> in PHP 4/Tidy 1. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidyNode::hasChildren" value="<div id='tidynode.haschildren' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidynode.haschildren.php'>tidyNode::hasChildren</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.0.1)</p><p class='refpurpose'><span class='refname'>tidyNode::hasChildren</span> &amp;mdash; <span class='dc-title'>Checks if a node has children</span></p> </div> <a name='tidynode.haschildren.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>tidyNode::hasChildren</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells if the node has children. </p> </div> <a name='tidynode.haschildren.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the node has children, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='tidynode.haschildren.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidyNode::hasChildren()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;<br />&amp;lt;?php&amp;nbsp;echo&amp;nbsp;'&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;';&amp;nbsp;?&amp;gt;<br />&amp;lt;#&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;JSTE&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;alert('Hello&amp;nbsp;World');&amp;nbsp;<br />#&amp;gt;<br />&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br /><br />&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;PHP&amp;nbsp;code<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;'hello&amp;nbsp;world!';<br />?&amp;gt;<br /><br />&amp;lt;%<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;ASP&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;response.write('Hello&amp;nbsp;World!')<br />%&amp;gt;<br /><br />&amp;lt;!--&amp;nbsp;Comments&amp;nbsp;--&amp;gt;<br />Hello&amp;nbsp;World<br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;<br />Outside&amp;nbsp;HTML<br /></span><span style='color: #007700'>HTML;<br /><br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;the&amp;nbsp;head&amp;nbsp;tag<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>()-&amp;gt;</span><span style='color: #0000BB'>child</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]-&amp;gt;</span><span style='color: #0000BB'>hasChildren</span><span style='color: #007700'>());<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;the&amp;nbsp;php&amp;nbsp;inside&amp;nbsp;the&amp;nbsp;head&amp;nbsp;tag<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>()-&amp;gt;</span><span style='color: #0000BB'>child</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]-&amp;gt;</span><span style='color: #0000BB'>child</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]-&amp;gt;</span><span style='color: #0000BB'>hasChildren</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> bool(true) bool(false) </pre></div> </div> </div><p> </p> </div> <a name='tidynode.haschildren.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function was named <b>tidy_node::has_children()</b> in PHP 4/Tidy 1. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidyNode::getParent" value="<div id='tidynode.getparent' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidynode.getparent.php'>tidyNode::getParent</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.2)</p><p class='refpurpose'><span class='refname'>tidyNode::getParent</span> &amp;mdash; <span class='dc-title'>Returns the parent node of the current node</span></p> </div> <a name='tidynode.getparent.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidynode.php' class='type tidyNode'>tidyNode</a></span> <span class='methodname'><b>tidyNode::getParent</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns the parent node of the current node. </p> </div> <a name='tidynode.getparent.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <a href='http://www.php.net/manual/en/tidynode.haschildren.php' class='function'>tidyNode::hasChildren()</a> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'>&amp;lt;html&amp;gt;&amp;lt;head&amp;gt;<br />&amp;lt;?php&amp;nbsp;echo&amp;nbsp;'&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;';&amp;nbsp;?&amp;gt;<br />&amp;lt;#&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;/*&amp;nbsp;JSTE&amp;nbsp;code&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;alert('Hello&amp;nbsp;World');&amp;nbsp;<br />#&amp;gt;<br />&amp;nbsp;&amp;lt;/head&amp;gt;<br />&amp;nbsp;&amp;lt;body&amp;gt;<br />&amp;nbsp;Hello&amp;nbsp;World<br />&amp;nbsp;&amp;lt;/body&amp;gt;<br />&amp;lt;/html&amp;gt;<br /><br /></span><span style='color: #007700'>HTML;<br /><br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>tidy_parse_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$node&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>html</span><span style='color: #007700'>()-&amp;gt;</span><span style='color: #0000BB'>child</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]-&amp;gt;</span><span style='color: #0000BB'>child</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>];<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$node</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>getparent</span><span style='color: #007700'>()-&amp;gt;</span><span style='color: #0000BB'>name</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> string(4) &amp;quot;head&amp;quot; </pre></div> </div> </div><p> </p> </div> <a name='tidynode.getparent.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a <a href='http://www.php.net/manual/en/class.tidynode.php' class='type tidyNode'>tidyNode</a> if the node has a parent, or <b><tt class='constant'>NULL</tt></b> otherwise. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="tidy::__construct" value="<div id='tidy.construct' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/tidy.construct.php'>tidy::__construct</a></h1> <p class='verinfo'>(PHP 5, PECL tidy &amp;gt;= 0.5.2)</p><p class='refpurpose'><span class='refname'>tidy::__construct</span> &amp;mdash; <span class='dc-title'>Constructs a new <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>tidy</a> object</span></p> </div> <a name='tidy.construct.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <span class='methodname'><b>tidy::__construct</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$use_include_path</tt></span> ]]]] )</div> <p class='para rdfs-comment'> Constructs a new <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>tidy</a> object. </p> </div> <a name='tidy.construct.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If the <i><tt class='parameter'>filename</tt></i> parameter is given, this function will also read that file and initialize the object with the file, acting like <a href='http://www.php.net/manual/en/tidy.parsefile.php' class='function'>tidy_parse_file()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>config</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The config <i><tt class='parameter'>config</tt></i> can be passed either as an array or as a string. If a string is passed, it is interpreted as the name of the configuration file, otherwise, it is interpreted as the options themselves. </p> <p class='para'> For an explanation about each option, visit <a href='http://tidy.sourceforge.net/docs/quickref.html' class='link external'>&amp;raquo; http://tidy.sourceforge.net/docs/quickref.html</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>encoding</tt></i> parameter sets the encoding for input/output documents. The possible values for encoding are: <i>ascii</i>, <i>latin0</i>, <i>latin1</i>, <i>raw</i>, <i>utf8</i>, <i>iso2022</i>, <i>mac</i>, <i>win1252</i>, <i>ibm858</i>, <i>utf16</i>, <i>utf16le</i>, <i>utf16be</i>, <i>big5</i>, and <i>shiftjis</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>use_include_path</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Search for the file in the <a href='http://www.php.net/manual/en/ini.core.php#ini.include-path' class='link'>include_path</a>. </p> </dd> </dl> <p> </p> </div> <a name='tidy.construct.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the new <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>tidy</a> instance. </p> </div> <a name='tidy.construct.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>tidy::__construct()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$html&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;&amp;nbsp;HTML<br /></span><span style='color: #DD0000'><br />&amp;lt;!DOCTYPE&amp;nbsp;html&amp;nbsp;PUBLIC&amp;nbsp;'-//W3C//DTD&amp;nbsp;XHTML&amp;nbsp;1.0&amp;nbsp;Strict//EN'<br />'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'&amp;gt;<br /><br />&amp;lt;html&amp;nbsp;xmlns='http://www.w3.org/1999/xhtml'&amp;nbsp;xml:lang='en'&amp;nbsp;lang='en'&amp;gt;<br />&amp;lt;head&amp;gt;&amp;lt;title&amp;gt;title&amp;lt;/title&amp;gt;&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br />&amp;lt;p&amp;gt;paragraph&amp;nbsp;&amp;lt;bt&amp;nbsp;/&amp;gt;<br />text&amp;lt;/p&amp;gt;<br />&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;<br /><br /></span><span style='color: #007700'>HTML;<br /><br /></span><span style='color: #0000BB'>$tidy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>tidy</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>ParseString</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$html</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CleanRepair</span><span style='color: #007700'>();<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>errorBuffer</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;following&amp;nbsp;errors&amp;nbsp;were&amp;nbsp;detected:\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$tidy</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>errorBuffer</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> The following errors were detected: line 8 column 14 - Error: &amp;lt;bt&amp;gt; is not recognized! line 8 column 14 - Warning: discarding unexpected &amp;lt;bt&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='tidy.construct.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/tidy.parsefile.php' class='function' rel='rdfs-seeAlso'>tidy::parseFile()</a> - Parse markup in file or URI</li> <li class='member'><a href='http://www.php.net/manual/en/tidy.parsestring.php' class='function' rel='rdfs-seeAlso'>tidy::parseString()</a> - Parse a document stored in a string</li> </ul> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="textdomain" value="<div id='function.textdomain' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.textdomain.php'>textdomain</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>textdomain</span> &amp;mdash; <span class='dc-title'>Sets the default domain</span></p> </div> <a name='function.textdomain.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>textdomain</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text_domain</tt></span> )</div> <p class='para rdfs-comment'> This function sets the domain to search within when calls are made to <a href='http://www.php.net/manual/en/function.gettext.php' class='function'>gettext()</a>, usually the named after an application. </p> </div> <a name='function.textdomain.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>text_domain</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new message domain, or <b><tt class='constant'>NULL</tt></b> to get the current setting without changing it </p> </dd> </dl> <p> </p> </div> <a name='function.textdomain.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If successful, this function returns the current message domain, after possibly changing it. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_write" value="<div id='function.socket-write' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-write.php'>socket_write</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_write</span> &amp;mdash; <span class='dc-title'>Write to a socket</span></p> </div> <a name='function.socket-write.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>socket_write</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$buffer</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> The function <b>socket_write()</b> writes to the <i><tt class='parameter'>socket</tt></i> from the given <i><tt class='parameter'>buffer</tt></i> . </p> </div> <a name='function.socket-write.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>buffer</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The buffer to be written. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional parameter <i><tt class='parameter'>length</tt></i> can specify an alternate length of bytes written to the socket. If this length is greater then the buffer length, it is silently truncated to the length of the buffer. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-write.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of bytes successfully written to the socket or <b><tt class='constant'>FALSE</tt></b> one error. The error code can be retrieved with <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. This code may be passed to <a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function'>socket_strerror()</a> to get a textual explanation of the error. </p> <blockquote><p><b class='note'>Note</b>: It is perfectly valid for <b>socket_write()</b> to return zero which means no bytes have been written. Be sure to use the <i>===</i> operator to check for <b><tt class='constant'>FALSE</tt></b> in case of an error. <br /> </p></blockquote> </div> <a name='function.socket-write.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>socket_write()</b> does not necessarily write all bytes from the given buffer. It&amp;#039;s valid that, depending on the network buffers etc., only a certain amount of data, even one byte, is written though your buffer is greater. You have to watch out so you don&amp;#039;t unintentionally forget to transmit the rest of your data. <br /> </p></blockquote> </div> <a name='function.socket-write.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-accept.php' class='function' rel='rdfs-seeAlso'>socket_accept()</a> - Accepts a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-bind.php' class='function' rel='rdfs-seeAlso'>socket_bind()</a> - Binds a name to a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-connect.php' class='function' rel='rdfs-seeAlso'>socket_connect()</a> - Initiates a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-listen.php' class='function' rel='rdfs-seeAlso'>socket_listen()</a> - Listens for a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-read.php' class='function' rel='rdfs-seeAlso'>socket_read()</a> - Reads a maximum of length bytes from a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_strerror" value="<div id='function.socket-strerror' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-strerror.php'>socket_strerror</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_strerror</span> &amp;mdash; <span class='dc-title'>Return a string describing a socket error</span></p> </div> <a name='function.socket-strerror.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>socket_strerror</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$errno</tt></span> )</div> <p class='para rdfs-comment'> <b>socket_strerror()</b> takes as its <i><tt class='parameter'>errno</tt></i> parameter a socket error code as returned by <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a> and returns the corresponding explanatory text. </p> <blockquote><p><b class='note'>Note</b>: Although the error messages generated by the socket extension are in English, the system messages retrieved with this function will appear depending on the current locale (<b><tt class='constant'>LC_MESSAGES</tt></b>). <br /> </p></blockquote> </div> <a name='function.socket-strerror.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>errno</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket error number, likely produced by <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-strerror.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the error message associated with the <i><tt class='parameter'>errno</tt></i> parameter. </p> </div> <a name='function.socket-strerror.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>socket_strerror()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>false&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;(</span><span style='color: #0000BB'>$socket&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>socket_create</span><span style='color: #007700'>(</span><span style='color: #0000BB'>AF_INET</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOCK_STREAM</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOL_TCP</span><span style='color: #007700'>)))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'socket_create()&amp;nbsp;failed:&amp;nbsp;reason:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>socket_strerror</span><span style='color: #007700'>(</span><span style='color: #0000BB'>socket_last_error</span><span style='color: #007700'>())&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>false&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;(@</span><span style='color: #0000BB'>socket_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'127.0.0.1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>80</span><span style='color: #007700'>)))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'socket_bind()&amp;nbsp;failed:&amp;nbsp;reason:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>socket_strerror</span><span style='color: #007700'>(</span><span style='color: #0000BB'>socket_last_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>))&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p> The expected output from the above example (assuming the script is not run with root privileges): </p></div> <div class='example-contents screen'> <div class='cdata'><pre> socket_bind() failed: reason: Permission denied </pre></div> </div> </div><p> </p> </div> <a name='function.socket-strerror.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-accept.php' class='function' rel='rdfs-seeAlso'>socket_accept()</a> - Accepts a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-bind.php' class='function' rel='rdfs-seeAlso'>socket_bind()</a> - Binds a name to a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-connect.php' class='function' rel='rdfs-seeAlso'>socket_connect()</a> - Initiates a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-listen.php' class='function' rel='rdfs-seeAlso'>socket_listen()</a> - Listens for a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-create.php' class='function' rel='rdfs-seeAlso'>socket_create()</a> - Create a socket (endpoint for communication)</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_shutdown" value="<div id='function.socket-shutdown' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-shutdown.php'>socket_shutdown</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_shutdown</span> &amp;mdash; <span class='dc-title'>Shuts down a socket for receiving, sending, or both</span></p> </div> <a name='function.socket-shutdown.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>socket_shutdown</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$how</tt><span class='initializer'> = 2</span></span> ] )</div> <p class='para rdfs-comment'> The <b>socket_shutdown()</b> function allows you to stop incoming, outgoing or all data (the default) from being sent through the <i><tt class='parameter'>socket</tt></i> </p> </div> <a name='function.socket-shutdown.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>how</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value of <i><tt class='parameter'>how</tt></i> can be one of the following: </p><table class='doctable table'> <caption><b>possible values for <i><tt class='parameter'>how</tt></i> </b></caption> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><i>0</i></td> <td align='left'> Shutdown socket reading </td> </tr> <tr valign='middle'> <td align='left'><i>1</i></td> <td align='left'> Shutdown socket writing </td> </tr> <tr valign='middle'> <td align='left'><i>2</i></td> <td align='left'> Shutdown socket reading and writing </td> </tr> </tbody> </table> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.socket-shutdown.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_set_option" value="<div id='function.socket-set-option' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-set-option.php'>socket_set_option</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_set_option</span> &amp;mdash; <span class='dc-title'>Sets socket options for the socket</span></p> </div> <a name='function.socket-set-option.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>socket_set_option</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$level</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$optname</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$optval</tt></span> )</div> <p class='para rdfs-comment'> The <b>socket_set_option()</b> function sets the option specified by the <i><tt class='parameter'>optname</tt></i> parameter, at the specified protocol <i><tt class='parameter'>level</tt></i> , to the value pointed to by the <i><tt class='parameter'>optval</tt></i> parameter for the <i><tt class='parameter'>socket</tt></i> . </p> </div> <a name='function.socket-set-option.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> or <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>level</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>level</tt></i> parameter specifies the protocol level at which the option resides. For example, to retrieve options at the socket level, a <i><tt class='parameter'>level</tt></i> parameter of <b><tt class='constant'>SOL_SOCKET</tt></b> would be used. Other levels, such as TCP, can be used by specifying the protocol number of that level. Protocol numbers can be found by using the <a href='http://www.php.net/manual/en/function.getprotobyname.php' class='function'>getprotobyname()</a> function. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>optname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The available socket options are the same as those for the <a href='http://www.php.net/manual/en/function.socket-get-option.php' class='function'>socket_get_option()</a> function. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>optval</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The option value. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-set-option.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.socket-set-option.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>socket_set_option()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$socket&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_create</span><span style='color: #007700'>(</span><span style='color: #0000BB'>AF_INET</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOCK_STREAM</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOL_TCP</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>is_resource</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;create&amp;nbsp;socket:&amp;nbsp;'</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>socket_strerror</span><span style='color: #007700'>(</span><span style='color: #0000BB'>socket_last_error</span><span style='color: #007700'>())&amp;nbsp;.&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>socket_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOL_SOCKET</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SO_REUSEADDR</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;set&amp;nbsp;option&amp;nbsp;on&amp;nbsp;socket:&amp;nbsp;'</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>socket_strerror</span><span style='color: #007700'>(</span><span style='color: #0000BB'>socket_last_error</span><span style='color: #007700'>())&amp;nbsp;.&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>socket_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'127.0.0.1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1223</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;bind&amp;nbsp;socket:&amp;nbsp;'</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>socket_strerror</span><span style='color: #007700'>(</span><span style='color: #0000BB'>socket_last_error</span><span style='color: #007700'>())&amp;nbsp;.&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>$rval&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOL_SOCKET</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SO_REUSEADDR</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$rval&amp;nbsp;</span><span style='color: #007700'>===&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;get&amp;nbsp;socket&amp;nbsp;option:&amp;nbsp;'</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>socket_strerror</span><span style='color: #007700'>(</span><span style='color: #0000BB'>socket_last_error</span><span style='color: #007700'>())&amp;nbsp;.&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$rval&amp;nbsp;</span><span style='color: #007700'>!==&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'SO_REUSEADDR&amp;nbsp;is&amp;nbsp;set&amp;nbsp;on&amp;nbsp;socket&amp;nbsp;!'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.socket-set-option.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> This function was renamed. It used to be called <b>socket_setopt()</b>. </td> </tr> </tbody> </table> <p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_set_nonblock" value="<div id='function.socket-set-nonblock' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-set-nonblock.php'>socket_set_nonblock</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_set_nonblock</span> &amp;mdash; <span class='dc-title'>Sets nonblocking mode for file descriptor fd </span></p> </div> <a name='function.socket-set-nonblock.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>socket_set_nonblock</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> )</div> <p class='para rdfs-comment'> The <b>socket_set_nonblock()</b> function sets the <b><tt class='constant'>O_NONBLOCK</tt></b> flag on the socket specified by the <i><tt class='parameter'>socket</tt></i> parameter. </p> <p class='para'> When an operation (e.g. receive, send, connect, accept, ...) is performed on a non-blocking socket, the script not pause its execution until it receives a signal or it can perform the operation. Rather, if the operation would result in a block, the called function will fail. </p> </div> <a name='function.socket-set-nonblock.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> or <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-set-nonblock.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.socket-set-nonblock.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>socket_set_nonblock()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$socket&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_create_listen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1223</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>socket_set_nonblock</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>socket_accept</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p> This example creates a listening socket on all interfaces on port 1223 and sets the socket to <b><tt class='constant'>O_NONBLOCK</tt></b> mode. <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a> will immediately fail unless there is a pending connection exactly at this moment. </p></div> </div><p> </p> </div> <a name='function.socket-set-nonblock.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-set-block.php' class='function' rel='rdfs-seeAlso'>socket_set_block()</a> - Sets blocking mode on a socket resource</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-set-option.php' class='function' rel='rdfs-seeAlso'>socket_set_option()</a> - Sets socket options for the socket</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_set_block" value="<div id='function.socket-set-block' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-set-block.php'>socket_set_block</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_set_block</span> &amp;mdash; <span class='dc-title'>Sets blocking mode on a socket resource</span></p> </div> <a name='function.socket-set-block.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>socket_set_block</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> )</div> <p class='para rdfs-comment'> The <b>socket_set_block()</b> function removes the <b><tt class='constant'>O_NONBLOCK</tt></b> flag on the socket specified by the <i><tt class='parameter'>socket</tt></i> parameter. </p> <p class='para'> When an operation (e.g. receive, send, connect, accept, ...) is performed on a blocking socket, the script will pause its execution until it receives a signal or it can perform the operation. </p> </div> <a name='function.socket-set-block.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> or <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-set-block.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.socket-set-block.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>socket_set_block()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$socket&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_create_listen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1223</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>socket_set_block</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>socket_accept</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p> This example creates a listening socket on all interfaces on port 1223 and sets the socket to <b><tt class='constant'>O_BLOCK</tt></b> mode. <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a> will hang until there is a connection to accept. </p></div> </div><p> </p> </div> <a name='function.socket-set-block.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-set-nonblock.php' class='function' rel='rdfs-seeAlso'>socket_set_nonblock()</a> - Sets nonblocking mode for file descriptor fd</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-set-option.php' class='function' rel='rdfs-seeAlso'>socket_set_option()</a> - Sets socket options for the socket</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_sendto" value="<div id='function.socket-sendto' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-sendto.php'>socket_sendto</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_sendto</span> &amp;mdash; <span class='dc-title'>Sends a message to a socket, whether it is connected or not </span></p> </div> <a name='function.socket-sendto.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>socket_sendto</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$buf</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$len</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$addr</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> The function <b>socket_sendto()</b> sends <i><tt class='parameter'>len</tt></i> bytes from <i><tt class='parameter'>buf</tt></i> through the socket <i><tt class='parameter'>socket</tt></i> to the <i><tt class='parameter'>port</tt></i> at the address <i><tt class='parameter'>addr</tt></i> . </p> </div> <a name='function.socket-sendto.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created using <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>buf</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The sent data will be taken from buffer <i><tt class='parameter'>buf</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>len</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>len</tt></i> bytes from <i><tt class='parameter'>buf</tt></i> will be sent. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value of <i><tt class='parameter'>flags</tt></i> can be any combination of the following flags, joined with the binary OR (<i>|</i>) operator. </p><table class='doctable table'> <caption><b>Possible values for <i><tt class='parameter'>flags</tt></i> </b></caption> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_OOB</tt></b></td> <td align='left'> Send OOB (out-of-band) data. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_EOR</tt></b></td> <td align='left'> Indicate a record mark. The sent data completes the record. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_EOF</tt></b></td> <td align='left'> Close the sender side of the socket and include an appropriate notification of this at the end of the sent data. The sent data completes the transaction. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_DONTROUTE</tt></b></td> <td align='left'> Bypass routing, use direct interface. </td> </tr> </tbody> </table> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>addr</tt></i> </span> </dt><dd class='listitem'> <p class='para'> IP address of the remote host. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>port</tt></i> is the remote port number at which the data will be sent. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-sendto.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>socket_sendto()</b> returns the number of bytes sent to the remote host, or <b><tt class='constant'>FALSE</tt></b> if an error occurred. </p> </div> <a name='function.socket-sendto.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>socket_sendto()</b> Example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;$sock&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_create</span><span style='color: #007700'>(</span><span style='color: #0000BB'>AF_INET</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOCK_DGRAM</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOL_UDP</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$msg&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Ping&amp;nbsp;!'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$len&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>strlen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$msg</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>socket_sendto</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sock</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$msg</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$len</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'127.0.0.1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1223</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>socket_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sock</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.socket-sendto.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-send.php' class='function' rel='rdfs-seeAlso'>socket_send()</a> - Sends data to a connected socket</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_send" value="<div id='function.socket-send' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-send.php'>socket_send</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_send</span> &amp;mdash; <span class='dc-title'>Sends data to a connected socket</span></p> </div> <a name='function.socket-send.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>socket_send</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$buf</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$len</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt></span> )</div> <p class='para rdfs-comment'> The function <b>socket_send()</b> sends <i><tt class='parameter'>len</tt></i> bytes to the socket <i><tt class='parameter'>socket</tt></i> from <i><tt class='parameter'>buf</tt></i> . </p> </div> <a name='function.socket-send.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> or <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>buf</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A buffer containing the data that will be sent to the remote host. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>len</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of bytes that will be sent to the remote host from <i><tt class='parameter'>buf</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value of <i><tt class='parameter'>flags</tt></i> can be any combination of the following flags, joined with the binary OR (<i>|</i>) operator. </p><table class='doctable table'> <caption><b>Possible values for <i><tt class='parameter'>flags</tt></i> </b></caption> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_OOB</tt></b></td> <td align='left'> Send OOB (out-of-band) data. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_EOR</tt></b></td> <td align='left'> Indicate a record mark. The sent data completes the record. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_EOF</tt></b></td> <td align='left'> Close the sender side of the socket and include an appropriate notification of this at the end of the sent data. The sent data completes the transaction. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_DONTROUTE</tt></b></td> <td align='left'> Bypass routing, use direct interface. </td> </tr> </tbody> </table> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.socket-send.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>socket_send()</b> returns the number of bytes sent, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.socket-send.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-sendto.php' class='function' rel='rdfs-seeAlso'>socket_sendto()</a> - Sends a message to a socket, whether it is connected or not</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_select" value="<div id='function.socket-select' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-select.php'>socket_select</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_select</span> &amp;mdash; <span class='dc-title'>Runs the select() system call on the given arrays of sockets with a specified timeout</span></p> </div> <a name='function.socket-select.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>socket_select</b></span> ( <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$read</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$write</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$except</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$tv_sec</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$tv_usec</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>socket_select()</b> accepts arrays of sockets and waits for them to change status. Those coming with BSD sockets background will recognize that those socket resource arrays are in fact the so-called file descriptor sets. Three independent arrays of socket resources are watched. </p> </div> <a name='function.socket-select.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>read</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The sockets listed in the <i><tt class='parameter'>read</tt></i> array will be watched to see if characters become available for reading (more precisely, to see if a read will not block - in particular, a socket resource is also ready on end-of-file, in which case a <a href='http://www.php.net/manual/en/function.socket-read.php' class='function'>socket_read()</a> will return a zero length string). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>write</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The sockets listed in the <i><tt class='parameter'>write</tt></i> array will be watched to see if a write will not block. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>except</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The sockets listed in the <i><tt class='parameter'>except</tt></i> array will be watched for exceptions. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>tv_sec</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>tv_sec</tt></i> and <i><tt class='parameter'>tv_usec</tt></i> together form the <i>timeout</i> parameter. The <i>timeout</i> is an upper bound on the amount of time elapsed before <b>socket_select()</b> return. <i><tt class='parameter'>tv_sec</tt></i> may be zero , causing <b>socket_select()</b> to return immediately. This is useful for polling. If <i><tt class='parameter'>tv_sec</tt></i> is <b><tt class='constant'>NULL</tt></b> (no timeout), <b>socket_select()</b> can block indefinitely. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>tv_usec</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> <div class='warning'><b class='warning'>Warning</b> <p class='para'> On exit, the arrays are modified to indicate which socket resource actually changed status. </p> </div> <p class='para'> You do not need to pass every array to <b>socket_select()</b>. You can leave it out and use an empty array or <b><tt class='constant'>NULL</tt></b> instead. Also do not forget that those arrays are passed <em class='emphasis'>by reference</em> and will be modified after <b>socket_select()</b> returns. </p> <blockquote><p><b class='note'>Note</b>: Due a limitation in the current Zend Engine it is not possible to pass a constant modifier like <b><tt class='constant'>NULL</tt></b> directly as a parameter to a function which expects this parameter to be passed by reference. Instead use a temporary variable or an expression with the leftmost member being a temporary variable: </p><div class='example'> <p><b>Example #1 Using <b><tt class='constant'>NULL</tt></b> with <b>socket_select()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$e&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>socket_select</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$w</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$e</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> <br /> </p></blockquote> </div> <a name='function.socket-select.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> On success <b>socket_select()</b> returns the number of socket resources contained in the modified arrays, which may be zero if the timeout expires before anything interesting happens. On error <b><tt class='constant'>FALSE</tt></b> is returned. The error code can be retrieved with <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. </p> <blockquote><p><b class='note'>Note</b>: Be sure to use the <i>===</i> operator when checking for an error. Since the <b>socket_select()</b> may return 0 the comparison with <i>==</i> would evaluate to <b><tt class='constant'>TRUE</tt></b>: </p><div class='example'> <p><b>Example #2 Understanding <b>socket_select()</b>&amp;#039;s result</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$e&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>false&amp;nbsp;</span><span style='color: #007700'>===&amp;nbsp;</span><span style='color: #0000BB'>socket_select</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$w</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$e</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'socket_select()&amp;nbsp;failed,&amp;nbsp;reason:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>socket_strerror</span><span style='color: #007700'>(</span><span style='color: #0000BB'>socket_last_error</span><span style='color: #007700'>())&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> <br /> </p></blockquote> </div> <a name='function.socket-select.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #3 <b>socket_select()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Prepare&amp;nbsp;the&amp;nbsp;read&amp;nbsp;array&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$read&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #0000BB'>$socket1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$socket2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$write&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$except&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$num_changed_sockets&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_select</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$read</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$write</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$except</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$num_changed_sockets&amp;nbsp;</span><span style='color: #007700'>===&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Error&amp;nbsp;handling&amp;nbsp;*/<br /></span><span style='color: #007700'>}&amp;nbsp;else&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$num_changed_sockets&amp;nbsp;</span><span style='color: #007700'>&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;At&amp;nbsp;least&amp;nbsp;at&amp;nbsp;one&amp;nbsp;of&amp;nbsp;the&amp;nbsp;sockets&amp;nbsp;something&amp;nbsp;interesting&amp;nbsp;happened&amp;nbsp;*/<br /></span><span style='color: #007700'>}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.socket-select.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Be aware that some socket implementations need to be handled very carefully. A few basic rules: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> You should always try to use <b>socket_select()</b> without timeout. Your program should have nothing to do if there is no data available. Code that depends on timeouts is not usually portable and difficult to debug. </span> </li> <li class='listitem'> <span class='simpara'> No socket resource must be added to any set if you do not intend to check its result after the <b>socket_select()</b> call, and respond appropriately. After <b>socket_select()</b> returns, all socket resources in all arrays must be checked. Any socket resource that is available for writing must be written to, and any socket resource available for reading must be read from. </span> </li> <li class='listitem'> <span class='simpara'> If you read/write to a socket returns in the arrays be aware that they do not necessarily read/write the full amount of data you have requested. Be prepared to even only be able to read/write a single byte. </span> </li> <li class='listitem'> <span class='simpara'> It&amp;#039;s common to most socket implementations that the only exception caught with the <i><tt class='parameter'>except</tt></i> array is out-of-bound data received on a socket. </span> </li> </ul><p> <br /> </p></blockquote> </div> <a name='function.socket-select.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-read.php' class='function' rel='rdfs-seeAlso'>socket_read()</a> - Reads a maximum of length bytes from a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-write.php' class='function' rel='rdfs-seeAlso'>socket_write()</a> - Write to a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function' rel='rdfs-seeAlso'>socket_last_error()</a> - Returns the last error on the socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_recvfrom" value="<div id='function.socket-recvfrom' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-recvfrom.php'>socket_recvfrom</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_recvfrom</span> &amp;mdash; <span class='dc-title'>Receives data from a socket whether or not it is connection-oriented</span></p> </div> <a name='function.socket-recvfrom.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>socket_recvfrom</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter reference'>&amp;amp;$buf</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$len</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter reference'>&amp;amp;$name</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter reference'>&amp;amp;$port</tt></span> ] )</div> <p class='para rdfs-comment'> The <b>socket_recvfrom()</b> function receives <i><tt class='parameter'>len</tt></i> bytes of data in <i><tt class='parameter'>buf</tt></i> from <i><tt class='parameter'>name</tt></i> on port <i><tt class='parameter'>port</tt></i> (if the socket is not of type <b><tt class='constant'>AF_UNIX</tt></b>) using <i><tt class='parameter'>socket</tt></i> . <b>socket_recvfrom()</b> can be used to gather data from both connected and unconnected sockets. Additionally, one or more flags can be specified to modify the behaviour of the function. </p> <p class='para'> The <i><tt class='parameter'>name</tt></i> and <i><tt class='parameter'>port</tt></i> must be passed by reference. If the socket is not connection-oriented, <i><tt class='parameter'>name</tt></i> will be set to the internet protocol address of the remote host or the path to the UNIX socket. If the socket is connection-oriented, <i><tt class='parameter'>name</tt></i> is <b><tt class='constant'>NULL</tt></b>. Additionally, the <i><tt class='parameter'>port</tt></i> will contain the port of the remote host in the case of an unconnected <b><tt class='constant'>AF_INET</tt></b> or <b><tt class='constant'>AF_INET6</tt></b> socket. </p> </div> <a name='function.socket-recvfrom.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>socket</tt></i> must be a socket resource previously created by socket_create(). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>buf</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The data received will be fetched to the variable specified with <i><tt class='parameter'>buf</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>len</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Up to <i><tt class='parameter'>len</tt></i> bytes will be fetched from remote host. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value of <i><tt class='parameter'>flags</tt></i> can be any combination of the following flags, joined with the binary OR (<i>|</i>) operator. </p> <table class='doctable table'> <caption><b>Possible values for <i><tt class='parameter'>flags</tt></i> </b></caption> <thead valign='middle'> <tr valign='middle'> <th>Flag</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_OOB</tt></b></td> <td align='left'> Process out-of-band data. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_PEEK</tt></b></td> <td align='left'> Receive data from the beginning of the receive queue without removing it from the queue. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_WAITALL</tt></b></td> <td align='left'> Block until at least <i><tt class='parameter'>len</tt></i> are received. However, if a signal is caught or the remote host disconnects, the function may return less data. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MSG_DONTWAIT</tt></b></td> <td align='left'> With this flag set, the function returns even if it would normally have blocked. </td> </tr> </tbody> </table> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If the socket is of the type <b><tt class='constant'>AF_UNIX</tt></b> type, <i><tt class='parameter'>name</tt></i> is the path to the file. Else, for unconnected sockets, <i><tt class='parameter'>name</tt></i> is the IP address of, the remote host, or <b><tt class='constant'>NULL</tt></b> if the socket is connection-oriented. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This argument only applies to <b><tt class='constant'>AF_INET</tt></b> and <b><tt class='constant'>AF_INET6</tt></b> sockets, and specifies the remote port from which the data is received. If the socket is connection-oriented, <i><tt class='parameter'>port</tt></i> will be <b><tt class='constant'>NULL</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-recvfrom.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>socket_recvfrom()</b> returns the number of bytes received, or -1 if there was an error. The actual error code can be retrieved by calling <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. This error code may be passed to <a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function'>socket_strerror()</a> to get a textual explanation of the error. </p> </div> <a name='function.socket-recvfrom.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>socket_recvfrom()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />error_reporting</span><span style='color: #007700'>(</span><span style='color: #0000BB'>E_ALL&amp;nbsp;</span><span style='color: #007700'>|&amp;nbsp;</span><span style='color: #0000BB'>E_STRICT</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$socket&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_create</span><span style='color: #007700'>(</span><span style='color: #0000BB'>AF_INET</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOCK_DGRAM</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOL_UDP</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>socket_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'127.0.0.1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1223</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$from&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>socket_recvfrom</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$buf</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>12</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$from</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$port</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Received&amp;nbsp;</span><span style='color: #0000BB'>$buf</span><span style='color: #DD0000'>&amp;nbsp;from&amp;nbsp;remote&amp;nbsp;address&amp;nbsp;</span><span style='color: #0000BB'>$from</span><span style='color: #DD0000'>&amp;nbsp;and&amp;nbsp;remote&amp;nbsp;port&amp;nbsp;</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p> This example will initiate an UDP socket on port 1223 of 127.0.0.1 and print at most 12 characters received from a remote host. </p></div> </div><p> </p> </div> <a name='function.socket-recvfrom.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> <b>socket_recvfrom()</b> is now binary safe. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.socket-recvfrom.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-recv.php' class='function' rel='rdfs-seeAlso'>socket_recv()</a> - Receives data from a connected socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-send.php' class='function' rel='rdfs-seeAlso'>socket_send()</a> - Sends data to a connected socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-sendto.php' class='function' rel='rdfs-seeAlso'>socket_sendto()</a> - Sends a message to a socket, whether it is connected or not</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-create.php' class='function' rel='rdfs-seeAlso'>socket_create()</a> - Create a socket (endpoint for communication)</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_recv" value="<div id='function.socket-recv' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-recv.php'>socket_recv</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_recv</span> &amp;mdash; <span class='dc-title'>Receives data from a connected socket </span></p> </div> <a name='function.socket-recv.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>socket_recv</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter reference'>&amp;amp;$buf</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$len</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt></span> )</div> <p class='para rdfs-comment'> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is currently not documented; only its argument list is available. </p></div> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_read" value="<div id='function.socket-read' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-read.php'>socket_read</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_read</span> &amp;mdash; <span class='dc-title'>Reads a maximum of length bytes from a socket</span></p> </div> <a name='function.socket-read.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>socket_read</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$type</tt><span class='initializer'> = PHP_BINARY_READ</span></span> ] )</div> <p class='para rdfs-comment'> The function <b>socket_read()</b> reads from the socket resource <i><tt class='parameter'>socket</tt></i> created by the <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> or <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a> functions. </p> </div> <a name='function.socket-read.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> or <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The maximum number of bytes read is specified by the <i><tt class='parameter'>length</tt></i> parameter. Otherwise you can use <b><tt class='constant'>\r</tt></b>, <b><tt class='constant'>\n</tt></b>, or <b><tt class='constant'>\0</tt></b> to end reading (depending on the <i><tt class='parameter'>type</tt></i> parameter, see below). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Optional <i><tt class='parameter'>type</tt></i> parameter is a named constant: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>PHP_BINARY_READ</tt></b> (Default) - use the system <i>recv()</i> function. Safe for reading binary data. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>PHP_NORMAL_READ</tt></b> - reading stops at <i>\n</i> or <i>\r</i>. </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.socket-read.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>socket_read()</b> returns the data as a string on success, or <b><tt class='constant'>FALSE</tt></b> on error (including if the remote host has closed the connection). The error code can be retrieved with <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. This code may be passed to <a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function'>socket_strerror()</a> to get a textual representation of the error. </p> <blockquote><p><b class='note'>Note</b>: <b>socket_read()</b> returns a zero length string (&amp;quot;&amp;quot;) when there is no more data to read. <br /> </p></blockquote> </div> <a name='function.socket-read.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.1.0</td> <td align='left'> The default value for <i><tt class='parameter'>type</tt></i> was changed from <b><tt class='constant'>PHP_NORMAL_READ</tt></b> to <b><tt class='constant'>PHP_BINARY_READ</tt></b> </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.socket-read.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-accept.php' class='function' rel='rdfs-seeAlso'>socket_accept()</a> - Accepts a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-bind.php' class='function' rel='rdfs-seeAlso'>socket_bind()</a> - Binds a name to a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-connect.php' class='function' rel='rdfs-seeAlso'>socket_connect()</a> - Initiates a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-listen.php' class='function' rel='rdfs-seeAlso'>socket_listen()</a> - Listens for a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function' rel='rdfs-seeAlso'>socket_last_error()</a> - Returns the last error on the socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-write.php' class='function' rel='rdfs-seeAlso'>socket_write()</a> - Write to a socket</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_listen" value="<div id='function.socket-listen' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-listen.php'>socket_listen</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_listen</span> &amp;mdash; <span class='dc-title'>Listens for a connection on a socket</span></p> </div> <a name='function.socket-listen.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>socket_listen</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$backlog</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> After the socket <i><tt class='parameter'>socket</tt></i> has been created using <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> and bound to a name with <a href='http://www.php.net/manual/en/function.socket-bind.php' class='function'>socket_bind()</a>, it may be told to listen for incoming connections on <i><tt class='parameter'>socket</tt></i> . </p> <p class='para'> <b>socket_listen()</b> is applicable only to sockets of type <b><tt class='constant'>SOCK_STREAM</tt></b> or <b><tt class='constant'>SOCK_SEQPACKET</tt></b>. </p> </div> <a name='function.socket-listen.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>backlog</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A maximum of <i><tt class='parameter'>backlog</tt></i> incoming connections will be queued for processing. If a connection request arrives with the queue full the client may receive an error with an indication of <i>ECONNREFUSED</i>, or, if the underlying protocol supports retransmission, the request may be ignored so that retries may succeed. </p> <blockquote><p><b class='note'>Note</b>: The maximum number passed to the <i><tt class='parameter'>backlog</tt></i> parameter highly depends on the underlying platform. On Linux, it is silently truncated to <b><tt class='constant'>SOMAXCONN</tt></b>. On win32, if passed <b><tt class='constant'>SOMAXCONN</tt></b>, the underlying service provider responsible for the socket will set the backlog to a maximum <em class='emphasis'>reasonable</em> value. There is no standard provision to find out the actual backlog value on this platform. <br /> </p></blockquote> </dd> </dl> <p> </p> </div> <a name='function.socket-listen.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. The error code can be retrieved with <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. This code may be passed to <a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function'>socket_strerror()</a> to get a textual explanation of the error. </p> </div> <a name='function.socket-listen.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-accept.php' class='function' rel='rdfs-seeAlso'>socket_accept()</a> - Accepts a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-bind.php' class='function' rel='rdfs-seeAlso'>socket_bind()</a> - Binds a name to a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-connect.php' class='function' rel='rdfs-seeAlso'>socket_connect()</a> - Initiates a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-create.php' class='function' rel='rdfs-seeAlso'>socket_create()</a> - Create a socket (endpoint for communication)</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_last_error" value="<div id='function.socket-last-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-last-error.php'>socket_last_error</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_last_error</span> &amp;mdash; <span class='dc-title'>Returns the last error on the socket </span></p> </div> <a name='function.socket-last-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>socket_last_error</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> ] )</div> <p class='para rdfs-comment'> If a socket resource is passed to this function, the last error which occurred on this particular socket is returned. If the socket resource is omitted, the error code of the last failed socket function is returned. The latter is particularly helpful for functions like <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> which don&amp;#039;t return a socket on failure and <a href='http://www.php.net/manual/en/function.socket-select.php' class='function'>socket_select()</a> which can fail for reasons not directly tied to a particular socket. The error code is suitable to be fed to <a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function'>socket_strerror()</a> which returns a string describing the given error code. </p> </div> <a name='function.socket-last-error.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-last-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> This function returns a socket error code. </p> </div> <a name='function.socket-last-error.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>socket_last_error()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$socket&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>socket_create</span><span style='color: #007700'>(</span><span style='color: #0000BB'>AF_INET</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOCK_STREAM</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOL_TCP</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$socket&amp;nbsp;</span><span style='color: #007700'>===&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$errorcode&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_last_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$errormsg&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_strerror</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$errorcode</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Couldn't&amp;nbsp;create&amp;nbsp;socket:&amp;nbsp;[</span><span style='color: #0000BB'>$errorcode</span><span style='color: #DD0000'>]&amp;nbsp;</span><span style='color: #0000BB'>$errormsg</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.socket-last-error.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>socket_last_error()</b> does not clear the error code, use <a href='http://www.php.net/manual/en/function.socket-clear-error.php' class='function'>socket_clear_error()</a> for this purpose. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_getsockname" value="<div id='function.socket-getsockname' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-getsockname.php'>socket_getsockname</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_getsockname</span> &amp;mdash; <span class='dc-title'>Queries the local side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type</span></p> </div> <a name='function.socket-getsockname.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>socket_getsockname</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter reference'>&amp;amp;$addr</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter reference'>&amp;amp;$port</tt></span> ] )</div> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> <b>socket_getsockname()</b> should not be used with <b><tt class='constant'>AF_UNIX</tt></b> sockets created with <a href='http://www.php.net/manual/en/function.socket-connect.php' class='function'>socket_connect()</a>. Only sockets created with <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a> or a primary server socket following a call to <a href='http://www.php.net/manual/en/function.socket-bind.php' class='function'>socket_bind()</a> will return meaningful values. </span> </p></blockquote> </div> <a name='function.socket-getsockname.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> or <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>addr</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If the given socket is of type <b><tt class='constant'>AF_INET</tt></b> or <b><tt class='constant'>AF_INET6</tt></b>, <b>socket_getsockname()</b> will return the local <em class='emphasis'>IP address</em> in appropriate notation (e.g. <i>127.0.0.1</i> or <i>fe80::1</i>) in the <i><tt class='parameter'>address</tt></i> parameter and, if the optional <i><tt class='parameter'>port</tt></i> parameter is present, also the associated port. </p> <p class='para'> If the given socket is of type <b><tt class='constant'>AF_UNIX</tt></b>, <b>socket_getsockname()</b> will return the Unix filesystem path (e.g. <i>/var/run/daemon.sock</i>) in the <i><tt class='parameter'>address</tt></i> parameter. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If provided, this will hold the associated port. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-getsockname.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. <b>socket_getsockname()</b> may also return <b><tt class='constant'>FALSE</tt></b> if the socket type is not any of <b><tt class='constant'>AF_INET</tt></b>, <b><tt class='constant'>AF_INET6</tt></b>, or <b><tt class='constant'>AF_UNIX</tt></b>, in which case the last socket error code is <em class='emphasis'>not</em> updated. </p> </div> <a name='function.socket-getsockname.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-getpeername.php' class='function' rel='rdfs-seeAlso'>socket_getpeername()</a> - Queries the remote side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function' rel='rdfs-seeAlso'>socket_last_error()</a> - Returns the last error on the socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_getpeername" value="<div id='function.socket-getpeername' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-getpeername.php'>socket_getpeername</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_getpeername</span> &amp;mdash; <span class='dc-title'>Queries the remote side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type</span></p> </div> <a name='function.socket-getpeername.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>socket_getpeername</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter reference'>&amp;amp;$address</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter reference'>&amp;amp;$port</tt></span> ] )</div> <p class='para rdfs-comment'> Queries the remote side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type. </p> </div> <a name='function.socket-getpeername.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> or <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>address</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If the given socket is of type <b><tt class='constant'>AF_INET</tt></b> or <b><tt class='constant'>AF_INET6</tt></b>, <b>socket_getpeername()</b> will return the peers (remote) <em class='emphasis'>IP address</em> in appropriate notation (e.g. <i>127.0.0.1</i> or <i>fe80::1</i>) in the <i><tt class='parameter'>address</tt></i> parameter and, if the optional <i><tt class='parameter'>port</tt></i> parameter is present, also the associated port. </p> <p class='para'> If the given socket is of type <b><tt class='constant'>AF_UNIX</tt></b>, <b>socket_getpeername()</b> will return the Unix filesystem path (e.g. <i>/var/run/daemon.sock</i>) in the <i><tt class='parameter'>address</tt></i> parameter. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If given, this will hold the port associated to <i><tt class='parameter'>address</tt></i> . </p> </dd> </dl> <p> </p> </div> <a name='function.socket-getpeername.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. <b>socket_getpeername()</b> may also return <b><tt class='constant'>FALSE</tt></b> if the socket type is not any of <b><tt class='constant'>AF_INET</tt></b>, <b><tt class='constant'>AF_INET6</tt></b>, or <b><tt class='constant'>AF_UNIX</tt></b>, in which case the last socket error code is <em class='emphasis'>not</em> updated. </p> </div> <a name='function.socket-getpeername.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>socket_getpeername()</b> should not be used with <b><tt class='constant'>AF_UNIX</tt></b> sockets created with <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a>. Only sockets created with <a href='http://www.php.net/manual/en/function.socket-connect.php' class='function'>socket_connect()</a> or a primary server socket following a call to <a href='http://www.php.net/manual/en/function.socket-bind.php' class='function'>socket_bind()</a> will return meaningful values. <br /> </p></blockquote> </div> <a name='function.socket-getpeername.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-getsockname.php' class='function' rel='rdfs-seeAlso'>socket_getsockname()</a> - Queries the local side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function' rel='rdfs-seeAlso'>socket_last_error()</a> - Returns the last error on the socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_get_option" value="<div id='function.socket-get-option' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-get-option.php'>socket_get_option</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_get_option</span> &amp;mdash; <span class='dc-title'>Gets socket options for the socket </span></p> </div> <a name='function.socket-get-option.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>socket_get_option</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$level</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$optname</tt></span> )</div> <p class='para rdfs-comment'> The <b>socket_get_option()</b> function retrieves the value for the option specified by the <i><tt class='parameter'>optname</tt></i> parameter for the specified <i><tt class='parameter'>socket</tt></i> . </p> </div> <a name='function.socket-get-option.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> or <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>level</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>level</tt></i> parameter specifies the protocol level at which the option resides. For example, to retrieve options at the socket level, a <i><tt class='parameter'>level</tt></i> parameter of <b><tt class='constant'>SOL_SOCKET</tt></b> would be used. Other levels, such as <b><tt class='constant'>TCP</tt></b>, can be used by specifying the protocol number of that level. Protocol numbers can be found by using the <a href='http://www.php.net/manual/en/function.getprotobyname.php' class='function'>getprotobyname()</a> function. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>optname</tt></i> </span> </dt><dd class='listitem'> <table class='doctable table'> <caption><b>Available Socket Options</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Option</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_DEBUG</tt></b></td> <td align='left'> Reports whether debugging information is being recorded. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_BROADCAST</tt></b></td> <td align='left'> Reports whether transmission of broadcast messages is supported. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_REUSEADDR</tt></b></td> <td align='left'> Reports whether local addresses can be reused. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_KEEPALIVE</tt></b></td> <td align='left'> Reports whether connections are kept active with periodic transmission of messages. If the connected socket fails to respond to these messages, the connection is broken and processes writing to that socket are notified with a SIGPIPE signal. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_LINGER</tt></b></td> <td align='left'> <p class='para'> Reports whether the <i><tt class='parameter'>socket</tt></i> lingers on <a href='http://www.php.net/manual/en/function.socket-close.php' class='function'>socket_close()</a> if data is present. By default, when the socket is closed, it attempts to send all unsent data. In the case of a connection-oriented socket, <a href='http://www.php.net/manual/en/function.socket-close.php' class='function'>socket_close()</a> will wait for its peer to acknowledge the data. </p> <p class='para'> If <var class='varname'>l_onoff</var> is non-zero and <var class='varname'>l_linger</var> is zero, all the unsent data will be discarded and RST (reset) is sent to the peer in the case of a connection-oriented socket. </p> <p class='para'> On the other hand, if <var class='varname'>l_onoff</var> is non-zero and <var class='varname'>l_linger</var> is non-zero, <a href='http://www.php.net/manual/en/function.socket-close.php' class='function'>socket_close()</a> will block until all the data is sent or the time specified in <var class='varname'>l_linger</var> elapses. If the socket is non-blocking, <a href='http://www.php.net/manual/en/function.socket-close.php' class='function'>socket_close()</a> will fail and return an error. </p> </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>. The array will contain two keys: <var class='varname'>l_onoff</var> and <var class='varname'>l_linger</var>. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_OOBINLINE</tt></b></td> <td align='left'> Reports whether the <i><tt class='parameter'>socket</tt></i> leaves out-of-band data inline. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_SNDBUF</tt></b></td> <td align='left'> Reports the size of the send buffer. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_RCVBUF</tt></b></td> <td align='left'> Reports the size of the receive buffer. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_ERROR</tt></b></td> <td align='left'> Reports information about error status and clears it. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> (cannot be set by <a href='http://www.php.net/manual/en/function.socket-set-option.php' class='function'>socket_set_option()</a>) </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_TYPE</tt></b></td> <td align='left'> Reports the <i><tt class='parameter'>socket</tt></i> type (e.g. <b><tt class='constant'>SOCK_STREAM</tt></b>). </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> (cannot be set by <a href='http://www.php.net/manual/en/function.socket-set-option.php' class='function'>socket_set_option()</a>) </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_DONTROUTE</tt></b></td> <td align='left'> Reports whether outgoing messages bypass the standard routing facilities. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_RCVLOWAT</tt></b></td> <td align='left'> Reports the minimum number of bytes to process for <i><tt class='parameter'>socket</tt></i> input operations. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_RCVTIMEO</tt></b></td> <td align='left'> Reports the timeout value for input operations. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>. The array will contain two keys: <var class='varname'>sec</var> which is the seconds part on the timeout value and <var class='varname'>usec</var> which is the microsecond part of the timeout value. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_SNDTIMEO</tt></b></td> <td align='left'> Reports the timeout value specifying the amount of time that an output function blocks because flow control prevents data from being sent. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>. The array will contain two keys: <var class='varname'>sec</var> which is the seconds part on the timeout value and <var class='varname'>usec</var> which is the microsecond part of the timeout value. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SO_SNDLOWAT</tt></b></td> <td align='left'> Reports the minimum number of bytes to process for <i><tt class='parameter'>socket</tt></i> output operations. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>TCP_NODELAY</tt></b></td> <td align='left'> Reports whether the Nagle TCP algorithm is disabled. </td> <td align='left'> <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> </td> </tr> </tbody> </table> </dd> </dl> <p> </p> </div> <a name='function.socket-get-option.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the value of the given option, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.socket-get-option.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <a href='http://www.php.net/manual/en/function.socket-set-option.php' class='function'>socket_set_option()</a> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$socket&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_create_listen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1223</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$linger&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'l_linger'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'l_onoff'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>socket_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOL_SOCKET</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SO_LINGER</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$linger</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>socket_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$socket</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOL_SOCKET</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SO_REUSEADDR</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.socket-get-option.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> The name of this function was changed. It used to be called <i>socket_getopt()</i>. </td> </tr> </tbody> </table> <p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_create_listen" value="<div id='function.socket-create-listen' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-create-listen.php'>socket_create_listen</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_create_listen</span> &amp;mdash; <span class='dc-title'>Opens a socket on port to accept connections </span></p> </div> <a name='function.socket-create-listen.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>socket_create_listen</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$backlog</tt><span class='initializer'> = 128</span></span> ] )</div> <p class='para rdfs-comment'> <b>socket_create_listen()</b> creates a new socket resource of type <b><tt class='constant'>AF_INET</tt></b> listening on <em class='emphasis'>all</em> local interfaces on the given port waiting for new connections. </p> <p class='para'> This function is meant to ease the task of creating a new socket which only listens to accept new connections. </p> </div> <a name='function.socket-create-listen.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The port on which to listen on all interfaces. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>backlog</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>backlog</tt></i> parameter defines the maximum length the queue of pending connections may grow to. <b><tt class='constant'>SOMAXCONN</tt></b> may be passed as <i><tt class='parameter'>backlog</tt></i> parameter, see <a href='http://www.php.net/manual/en/function.socket-listen.php' class='function'>socket_listen()</a> for more information. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-create-listen.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>socket_create_listen()</b> returns a new socket resource on success or <b><tt class='constant'>FALSE</tt></b> on error. The error code can be retrieved with <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. This code may be passed to <a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function'>socket_strerror()</a> to get a textual explanation of the error. </p> </div> <a name='function.socket-create-listen.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: If you want to create a socket which only listens on a certain interface you need to use <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a>, <a href='http://www.php.net/manual/en/function.socket-bind.php' class='function'>socket_bind()</a> and <a href='http://www.php.net/manual/en/function.socket-listen.php' class='function'>socket_listen()</a>. <br /> </p></blockquote> </div> <a name='function.socket-create-listen.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-create.php' class='function' rel='rdfs-seeAlso'>socket_create()</a> - Create a socket (endpoint for communication)</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-create-pair.php' class='function' rel='rdfs-seeAlso'>socket_create_pair()</a> - Creates a pair of indistinguishable sockets and stores them in an array</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-bind.php' class='function' rel='rdfs-seeAlso'>socket_bind()</a> - Binds a name to a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-listen.php' class='function' rel='rdfs-seeAlso'>socket_listen()</a> - Listens for a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function' rel='rdfs-seeAlso'>socket_last_error()</a> - Returns the last error on the socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_create" value="<div id='function.socket-create' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-create.php'>socket_create</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_create</span> &amp;mdash; <span class='dc-title'>Create a socket (endpoint for communication)</span></p> </div> <a name='function.socket-create.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>socket_create</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$domain</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$type</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$protocol</tt></span> )</div> <p class='para rdfs-comment'> Creates and returns a socket resource, also referred to as an endpoint of communication. A typical network connection is made up of 2 sockets, one performing the role of the client, and another performing the role of the server. </p> </div> <a name='function.socket-create.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>domain</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>domain</tt></i> parameter specifies the protocol family to be used by the socket. </p> <table class='doctable table'> <caption><b>Available address/protocol families</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Domain</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>AF_INET</tt></b></td> <td align='left'> IPv4 Internet based protocols. TCP and UDP are common protocols of this protocol family. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>AF_INET6</tt></b></td> <td align='left'> IPv6 Internet based protocols. TCP and UDP are common protocols of this protocol family. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>AF_UNIX</tt></b></td> <td align='left'> Local communication protocol family. High efficiency and low overhead make it a great form of IPC (Interprocess Communication). </td> </tr> </tbody> </table> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>type</tt></i> parameter selects the type of communication to be used by the socket. </p> <table class='doctable table'> <caption><b>Available socket types</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Type</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>SOCK_STREAM</tt></b></td> <td align='left'> Provides sequenced, reliable, full-duplex, connection-based byte streams. An out-of-band data transmission mechanism may be supported. The TCP protocol is based on this socket type. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SOCK_DGRAM</tt></b></td> <td align='left'> Supports datagrams (connectionless, unreliable messages of a fixed maximum length). The UDP protocol is based on this socket type. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SOCK_SEQPACKET</tt></b></td> <td align='left'> Provides a sequenced, reliable, two-way connection-based data transmission path for datagrams of fixed maximum length; a consumer is required to read an entire packet with each read call. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SOCK_RAW</tt></b></td> <td align='left'> Provides raw network protocol access. This special type of socket can be used to manually construct any type of protocol. A common use for this socket type is to perform ICMP requests (like ping, traceroute, etc). </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>SOCK_RDM</tt></b></td> <td align='left'> Provides a reliable datagram layer that does not guarantee ordering. This is most likely not implemented on your operating system. </td> </tr> </tbody> </table> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>protocol</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>protocol</tt></i> parameter sets the specific protocol within the specified <i><tt class='parameter'>domain</tt></i> to be used when communicating on the returned socket. The proper value can be retrieved by name by using <a href='http://www.php.net/manual/en/function.getprotobyname.php' class='function'>getprotobyname()</a>. If the desired protocol is TCP, or UDP the corresponding constants <b><tt class='constant'>SOL_TCP</tt></b>, and <b><tt class='constant'>SOL_UDP</tt></b> can also be used. </p> <table class='doctable table'> <caption><b>Common protocols</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>icmp</td> <td align='left'> The Internet Control Message Protocol is used primarily by gateways and hosts to report errors in datagram communication. The &amp;quot;ping&amp;quot; command (present in most modern operating systems) is an example application of ICMP. </td> </tr> <tr valign='middle'> <td align='left'>udp</td> <td align='left'> The User Datagram Protocol is a connectionless, unreliable, protocol with fixed record lengths. Due to these aspects, UDP requires a minimum amount of protocol overhead. </td> </tr> <tr valign='middle'> <td align='left'>tcp</td> <td align='left'> The Transmission Control Protocol is a reliable, connection based, stream oriented, full duplex protocol. TCP guarantees that all data packets will be received in the order in which they were sent. If any packet is somehow lost during communication, TCP will automatically retransmit the packet until the destination host acknowledges that packet. For reliability and performance reasons, the TCP implementation itself decides the appropriate octet boundaries of the underlying datagram communication layer. Therefore, TCP applications must allow for the possibility of partial record transmission. </td> </tr> </tbody> </table> </dd> </dl> <p> </p> </div> <a name='function.socket-create.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>socket_create()</b> returns a socket resource on success, or <b><tt class='constant'>FALSE</tt></b> on error. The actual error code can be retrieved by calling <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. This error code may be passed to <a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function'>socket_strerror()</a> to get a textual explanation of the error. </p> </div> <a name='function.socket-create.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.0.0</td> <td align='left'> The <b><tt class='constant'>AF_INET6</tt></b> constant was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.socket-create.errors'></a><div class='refsect1 errors'> <h3 class='title'>Errors/Exceptions</h3> <p class='para'> If an invalid <i><tt class='parameter'>domain</tt></i> or <i><tt class='parameter'>type</tt></i> is given, <b>socket_create()</b> defaults to <b><tt class='constant'>AF_INET</tt></b> and <b><tt class='constant'>SOCK_STREAM</tt></b> respectively and additionally emits an <b><tt class='constant'>E_WARNING</tt></b> message. </p> </div> <a name='function.socket-create.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-accept.php' class='function' rel='rdfs-seeAlso'>socket_accept()</a> - Accepts a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-bind.php' class='function' rel='rdfs-seeAlso'>socket_bind()</a> - Binds a name to a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-connect.php' class='function' rel='rdfs-seeAlso'>socket_connect()</a> - Initiates a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-listen.php' class='function' rel='rdfs-seeAlso'>socket_listen()</a> - Listens for a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function' rel='rdfs-seeAlso'>socket_last_error()</a> - Returns the last error on the socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_connect" value="<div id='function.socket-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-connect.php'>socket_connect</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_connect</span> &amp;mdash; <span class='dc-title'>Initiates a connection on a socket</span></p> </div> <a name='function.socket-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>socket_connect</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$address</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Initiate a connection to <i><tt class='parameter'>address</tt></i> using the socket resource <i><tt class='parameter'>socket</tt></i> , which must be a valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a>. </p> </div> <a name='function.socket-connect.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>address</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>address</tt></i> parameter is either an IPv4 address in dotted-quad notation (e.g. <i>127.0.0.1</i>) if <i><tt class='parameter'>socket</tt></i> is <b><tt class='constant'>AF_INET</tt></b>, a valid IPv6 address (e.g. <i>::1</i>) if IPv6 support is enabled and <i><tt class='parameter'>socket</tt></i> is <b><tt class='constant'>AF_INET6</tt></b> or the pathname of a Unix domain socket, if the socket family is <b><tt class='constant'>AF_UNIX</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>port</tt></i> parameter is only used and is mandatory when connecting to an <b><tt class='constant'>AF_INET</tt></b> or an <b><tt class='constant'>AF_INET6</tt></b> socket, and designates the port on the remote host to which a connection should be made. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. The error code can be retrieved with <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. This code may be passed to <a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function'>socket_strerror()</a> to get a textual explanation of the error. </p> <blockquote><p><b class='note'>Note</b>: If the socket is non-blocking then this function returns <b><tt class='constant'>FALSE</tt></b> with an error <i>Operation now in progress</i>. <br /> </p></blockquote> </div> <a name='function.socket-connect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-bind.php' class='function' rel='rdfs-seeAlso'>socket_bind()</a> - Binds a name to a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-listen.php' class='function' rel='rdfs-seeAlso'>socket_listen()</a> - Listens for a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-create.php' class='function' rel='rdfs-seeAlso'>socket_create()</a> - Create a socket (endpoint for communication)</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function' rel='rdfs-seeAlso'>socket_last_error()</a> - Returns the last error on the socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_close" value="<div id='function.socket-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-close.php'>socket_close</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_close</span> &amp;mdash; <span class='dc-title'>Closes a socket resource</span></p> </div> <a name='function.socket-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>socket_close</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> )</div> <p class='para rdfs-comment'> <b>socket_close()</b> closes the socket resource given by <i><tt class='parameter'>socket</tt></i> . This function is specific to sockets and cannot be used on any other type of resources. </p> </div> <a name='function.socket-close.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a> or <a href='http://www.php.net/manual/en/function.socket-accept.php' class='function'>socket_accept()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.socket-close.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-bind.php' class='function' rel='rdfs-seeAlso'>socket_bind()</a> - Binds a name to a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-listen.php' class='function' rel='rdfs-seeAlso'>socket_listen()</a> - Listens for a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-create.php' class='function' rel='rdfs-seeAlso'>socket_create()</a> - Create a socket (endpoint for communication)</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_clear_error" value="<div id='function.socket-clear-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-clear-error.php'>socket_clear_error</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_clear_error</span> &amp;mdash; <span class='dc-title'>Clears the error on the socket or the last error code</span></p> </div> <a name='function.socket-clear-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>socket_clear_error</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> ] )</div> <p class='para rdfs-comment'> This function clears the error code on the given socket or the global last socket error if no socket is specified. </p> <p class='para'> This function allows explicitly resetting the error code value either of a socket or of the extension global last error code. This may be useful to detect within a part of the application if an error occurred or not. </p> </div> <a name='function.socket-clear-error.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-clear-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.socket-clear-error.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function' rel='rdfs-seeAlso'>socket_last_error()</a> - Returns the last error on the socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_bind" value="<div id='function.socket-bind' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-bind.php'>socket_bind</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_bind</span> &amp;mdash; <span class='dc-title'>Binds a name to a socket</span></p> </div> <a name='function.socket-bind.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>socket_bind</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$address</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Binds the name given in <i><tt class='parameter'>address</tt></i> to the socket described by <i><tt class='parameter'>socket</tt></i> . This has to be done before a connection is be established using <a href='http://www.php.net/manual/en/function.socket-connect.php' class='function'>socket_connect()</a> or <a href='http://www.php.net/manual/en/function.socket-listen.php' class='function'>socket_listen()</a>. </p> </div> <a name='function.socket-bind.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>address</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If the socket is of the <b><tt class='constant'>AF_INET</tt></b> family, the <i><tt class='parameter'>address</tt></i> is an IP in dotted-quad notation (e.g. <i>127.0.0.1</i>). </p> <p class='para'> If the socket is of the <b><tt class='constant'>AF_UNIX</tt></b> family, the <i><tt class='parameter'>address</tt></i> is the path of a Unix-domain socket (e.g. <var class='filename'>/tmp/my.sock</var>). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> (Optional)</span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>port</tt></i> parameter is only used when connecting to an <b><tt class='constant'>AF_INET</tt></b> socket, and designates the port on the remote host to which a connection should be made. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-bind.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The error code can be retrieved with <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. This code may be passed to <a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function'>socket_strerror()</a> to get a textual explanation of the error. </p> </div> <a name='function.socket-bind.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>socket_bind()</b> to set the source address</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;socket<br /></span><span style='color: #0000BB'>$sock&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>socket_create</span><span style='color: #007700'>(</span><span style='color: #0000BB'>AF_INET</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOCK_STREAM</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SOL_TCP</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;An&amp;nbsp;example&amp;nbsp;list&amp;nbsp;of&amp;nbsp;IP&amp;nbsp;addresses&amp;nbsp;owned&amp;nbsp;by&amp;nbsp;the&amp;nbsp;computer<br /></span><span style='color: #0000BB'>$sourceips</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'kevin'</span><span style='color: #007700'>]&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'127.0.0.1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$sourceips</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'madcoder'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'127.0.0.2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Bind&amp;nbsp;the&amp;nbsp;source&amp;nbsp;address<br /></span><span style='color: #0000BB'>socket_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sock</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sourceips</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'madcoder'</span><span style='color: #007700'>]);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;destination&amp;nbsp;address<br /></span><span style='color: #0000BB'>socket_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sock</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'127.0.0.1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>80</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Write<br /></span><span style='color: #0000BB'>$request&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'GET&amp;nbsp;/&amp;nbsp;HTTP/1.1'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\r\n'&amp;nbsp;</span><span style='color: #007700'>.<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'Host:&amp;nbsp;example.com'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\r\n\r\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>socket_write</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sock</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$request</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Close<br /></span><span style='color: #0000BB'>socket_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sock</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.socket-bind.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function must be used on the socket before <a href='http://www.php.net/manual/en/function.socket-connect.php' class='function'>socket_connect()</a>. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: Windows 9x/ME compatibility note: <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a> may return an invalid error code if trying to bind the socket to a wrong address that does not belong to your machine. <br /> </p></blockquote> </div> <a name='function.socket-bind.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-connect.php' class='function' rel='rdfs-seeAlso'>socket_connect()</a> - Initiates a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-listen.php' class='function' rel='rdfs-seeAlso'>socket_listen()</a> - Listens for a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-create.php' class='function' rel='rdfs-seeAlso'>socket_create()</a> - Create a socket (endpoint for communication)</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function' rel='rdfs-seeAlso'>socket_last_error()</a> - Returns the last error on the socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="socket_accept" value="<div id='function.socket-accept' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.socket-accept.php'>socket_accept</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>socket_accept</span> &amp;mdash; <span class='dc-title'>Accepts a connection on a socket</span></p> </div> <a name='function.socket-accept.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>socket_accept</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$socket</tt></span> )</div> <p class='para rdfs-comment'> After the socket <i><tt class='parameter'>socket</tt></i> has been created using <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a>, bound to a name with <a href='http://www.php.net/manual/en/function.socket-bind.php' class='function'>socket_bind()</a>, and told to listen for connections with <a href='http://www.php.net/manual/en/function.socket-listen.php' class='function'>socket_listen()</a>, this function will accept incoming connections on that socket. Once a successful connection is made, a new socket resource is returned, which may be used for communication. If there are multiple connections queued on the socket, the first will be used. If there are no pending connections, <b>socket_accept()</b> will block until a connection becomes present. If <i><tt class='parameter'>socket</tt></i> has been made non-blocking using <a href='http://www.php.net/manual/en/function.socket-set-blocking.php' class='function'>socket_set_blocking()</a> or <a href='http://www.php.net/manual/en/function.socket-set-nonblock.php' class='function'>socket_set_nonblock()</a>, <b><tt class='constant'>FALSE</tt></b> will be returned. </p> <p class='para'> The socket resource returned by <b>socket_accept()</b> may not be used to accept new connections. The original listening socket <i><tt class='parameter'>socket</tt></i> , however, remains open and may be reused. </p> </div> <a name='function.socket-accept.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid socket resource created with <a href='http://www.php.net/manual/en/function.socket-create.php' class='function'>socket_create()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.socket-accept.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a new socket resource on success, or <b><tt class='constant'>FALSE</tt></b> on error. The actual error code can be retrieved by calling <a href='http://www.php.net/manual/en/function.socket-last-error.php' class='function'>socket_last_error()</a>. This error code may be passed to <a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function'>socket_strerror()</a> to get a textual explanation of the error. </p> </div> <a name='function.socket-accept.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.socket-connect.php' class='function' rel='rdfs-seeAlso'>socket_connect()</a> - Initiates a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-listen.php' class='function' rel='rdfs-seeAlso'>socket_listen()</a> - Listens for a connection on a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-create.php' class='function' rel='rdfs-seeAlso'>socket_create()</a> - Create a socket (endpoint for communication)</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-bind.php' class='function' rel='rdfs-seeAlso'>socket_bind()</a> - Binds a name to a socket</li> <li class='member'><a href='http://www.php.net/manual/en/function.socket-strerror.php' class='function' rel='rdfs-seeAlso'>socket_strerror()</a> - Return a string describing a socket error</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="shmop_write" value="<div id='function.shmop-write' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.shmop-write.php'>shmop_write</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>shmop_write</span> &amp;mdash; <span class='dc-title'>Write data into shared memory block</span></p> </div> <a name='function.shmop-write.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>shmop_write</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$shmid</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> )</div> <p class='para rdfs-comment'> <b>shmop_write()</b> will write a string into shared memory block. </p> </div> <a name='function.shmop-write.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>shmid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The shared memory block identifier created by <a href='http://www.php.net/manual/en/function.shmop-open.php' class='function'>shmop_open()</a> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A string to write into shared memory block </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies where to start writing data inside the shared memory segment. </p> </dd> </dl> <p> </p> </div> <a name='function.shmop-write.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The size of the written <i><tt class='parameter'>data</tt></i> , or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.shmop-write.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Writing to shared memory block</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$shm_bytes_written&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>shmop_write</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$shm_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$my_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> This example will write data inside <i>$my_string</i> into shared memory block, <i>$shm_bytes_written</i> will contain the number of bytes written. </p> </div> <a name='function.shmop-write.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.shmop-read.php' class='function' rel='rdfs-seeAlso'>shmop_read()</a> - Read data from shared memory block</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="shmop_size" value="<div id='function.shmop-size' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.shmop-size.php'>shmop_size</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>shmop_size</span> &amp;mdash; <span class='dc-title'>Get size of shared memory block</span></p> </div> <a name='function.shmop-size.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>shmop_size</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$shmid</tt></span> )</div> <p class='para rdfs-comment'> <b>shmop_size()</b> is used to get the size, in bytes of the shared memory block. </p> </div> <a name='function.shmop-size.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>shmid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The shared memory block identifier created by <a href='http://www.php.net/manual/en/function.shmop-open.php' class='function'>shmop_open()</a> </p> </dd> </dl> <p> </p> </div> <a name='function.shmop-size.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an int, which represents the number of bytes the shared memory block occupies. </p> </div> <a name='function.shmop-size.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Getting the size of the shared memory block</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$shm_size&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>shmop_size</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$shm_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> This example will put the size of shared memory block identified by <i>$shm_id</i> into <i>$shm_size</i>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="shmop_read" value="<div id='function.shmop-read' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.shmop-read.php'>shmop_read</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>shmop_read</span> &amp;mdash; <span class='dc-title'>Read data from shared memory block</span></p> </div> <a name='function.shmop-read.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>shmop_read</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$shmid</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$start</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$count</tt></span> )</div> <p class='para rdfs-comment'> <b>shmop_read()</b> will read a string from shared memory block. </p> </div> <a name='function.shmop-read.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>shmid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The shared memory block identifier created by <a href='http://www.php.net/manual/en/function.shmop-open.php' class='function'>shmop_open()</a> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>start</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Offset from which to start reading </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>count</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of bytes to read </p> </dd> </dl> <p> </p> </div> <a name='function.shmop-read.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the data or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.shmop-read.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Reading shared memory block</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$shm_data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>shmop_read</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$shm_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> This example will read 50 bytes from shared memory block and place the data inside <i>$shm_data</i>. </p> </div> <a name='function.shmop-read.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.shmop-write.php' class='function' rel='rdfs-seeAlso'>shmop_write()</a> - Write data into shared memory block</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="shmop_open" value="<div id='function.shmop-open' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.shmop-open.php'>shmop_open</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>shmop_open</span> &amp;mdash; <span class='dc-title'>Create or open shared memory block</span></p> </div> <a name='function.shmop-open.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>shmop_open</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$key</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$flags</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$size</tt></span> )</div> <p class='para rdfs-comment'> <b>shmop_open()</b> can create or open a shared memory block. </p> </div> <a name='function.shmop-open.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>key</tt></i> </span> </dt><dd class='listitem'> <p class='para'> System&amp;#039;s id for the shared memory block. Can be passed as a decimal or hex. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The flags that you can use: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> &amp;quot;a&amp;quot; for access (sets SHM_RDONLY for shmat) use this flag when you need to open an existing shared memory segment for read only </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;c&amp;quot; for create (sets IPC_CREATE) use this flag when you need to create a new shared memory segment or if a segment with the same key exists, try to open it for read and write </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;w&amp;quot; for read &amp;amp; write access use this flag when you need to read and write to a shared memory segment, use this flag in most cases. </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;n&amp;quot; create a new memory segment (sets IPC_CREATE|IPC_EXCL) use this flag when you want to create a new shared memory segment but if one already exists with the same flag, fail. This is useful for security purposes, using this you can prevent race condition exploits. </span> </li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The permissions that you wish to assign to your memory segment, those are the same as permission for a file. Permissions need to be passed in octal form, like for example <i>0644</i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>size</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The size of the shared memory block you wish to create in bytes </p> </dd> </dl> <p> </p><blockquote><p><b class='note'>Note</b>: Note: the 3rd and 4th should be entered as 0 if you are opening an existing memory segment. <br /> </p></blockquote><p> </p> </div> <a name='function.shmop-open.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> On success <b>shmop_open()</b> will return an id that you can use to access the shared memory segment you&amp;#039;ve created. <b><tt class='constant'>FALSE</tt></b> is returned on failure. </p> </div> <a name='function.shmop-open.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Create a new shared memory block</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$shm_key&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftok</span><span style='color: #007700'>(</span><span style='color: #0000BB'>__FILE__</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'t'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$shm_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>shmop_open</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$shm_key</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'c'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0644</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> This example opened a shared memory block with a system id returned by <a href='http://www.php.net/manual/en/function.ftok.php' class='function'>ftok()</a>. </p> </div> <a name='function.shmop-open.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.shmop-close.php' class='function' rel='rdfs-seeAlso'>shmop_close()</a> - Close shared memory block</li> <li class='member'><a href='http://www.php.net/manual/en/function.shmop-delete.php' class='function' rel='rdfs-seeAlso'>shmop_delete()</a> - Delete shared memory block</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="shmop_delete" value="<div id='function.shmop-delete' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.shmop-delete.php'>shmop_delete</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>shmop_delete</span> &amp;mdash; <span class='dc-title'>Delete shared memory block</span></p> </div> <a name='function.shmop-delete.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>shmop_delete</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$shmid</tt></span> )</div> <p class='para rdfs-comment'> <b>shmop_delete()</b> is used to delete a shared memory block. </p> </div> <a name='function.shmop-delete.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>shmid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The shared memory block identifier created by <a href='http://www.php.net/manual/en/function.shmop-open.php' class='function'>shmop_open()</a> </p> </dd> </dl> <p> </p> </div> <a name='function.shmop-delete.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.shmop-delete.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Deleting shared memory block</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />shmop_delete</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$shm_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> This example will delete shared memory block identified by <i>$shm_id</i>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="shmop_close" value="<div id='function.shmop-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.shmop-close.php'>shmop_close</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>shmop_close</span> &amp;mdash; <span class='dc-title'>Close shared memory block</span></p> </div> <a name='function.shmop-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>shmop_close</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$shmid</tt></span> )</div> <p class='para rdfs-comment'> <b>shmop_close()</b> is used to close a shared memory block. </p> </div> <a name='function.shmop-close.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>shmid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The shared memory block identifier created by <a href='http://www.php.net/manual/en/function.shmop-open.php' class='function'>shmop_open()</a> </p> </dd> </dl> <p> </p> </div> <a name='function.shmop-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.shmop-close.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Closing shared memory block</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />shmop_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$shm_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> This example will close shared memory block identified by <i>$shm_id</i>. </p> </div> <a name='function.shmop-close.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.shmop-open.php' class='function' rel='rdfs-seeAlso'>shmop_open()</a> - Create or open shared memory block</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="read_exif_data" value="<div id='function.read-exif-data' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.read-exif-data.php'>read_exif_data</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.1, PHP 5)</p><p class='refpurpose'><span class='refname'>read_exif_data</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.exif-read-data.php' class='function'>exif_read_data()</a></span></p> </div> <a name='function.read-exif-data.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.exif-read-data.php' class='function'>exif_read_data()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ob_tidyhandler" value="<div id='function.ob-tidyhandler' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ob-tidyhandler.php'>ob_tidyhandler</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>ob_tidyhandler</span> &amp;mdash; <span class='dc-title'>ob_start callback function to repair the buffer</span></p> </div> <a name='function.ob-tidyhandler.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ob_tidyhandler</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$input</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> ] )</div> <p class='para rdfs-comment'> Callback function for <a href='http://www.php.net/manual/en/function.ob-start.php' class='function'>ob_start()</a> to repair the buffer. </p> </div> <a name='function.ob-tidyhandler.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>input</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The buffer. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The buffer mode. </p> </dd> </dl> <p> </p> </div> <a name='function.ob-tidyhandler.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the modified buffer. </p> </div> <a name='function.ob-tidyhandler.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ob_tidyhandler()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />ob_start</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ob_tidyhandler'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;p&amp;gt;test&amp;lt;/i&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;!DOCTYPE html PUBLIC &amp;quot;-//W3C//DTD HTML 3.2//EN&amp;quot;&amp;gt; &amp;lt;html&amp;gt; &amp;lt;head&amp;gt; &amp;lt;title&amp;gt;&amp;lt;/title&amp;gt; &amp;lt;/head&amp;gt; &amp;lt;body&amp;gt; &amp;lt;p&amp;gt;test&amp;lt;/p&amp;gt; &amp;lt;/body&amp;gt; &amp;lt;/html&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='function.ob-tidyhandler.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ob-start.php' class='function' rel='rdfs-seeAlso'>ob_start()</a> - Turn on output buffering</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ob_iconv_handler" value="<div id='function.ob-iconv-handler' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ob-iconv-handler.php'>ob_iconv_handler</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>ob_iconv_handler</span> &amp;mdash; <span class='dc-title'>Convert character encoding as output buffer handler</span></p> </div> <a name='function.ob-iconv-handler.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ob_iconv_handler</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$contents</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$status</tt></span> )</div> <p class='para rdfs-comment'> Converts the string encoded in <i><tt class='parameter'>internal_encoding</tt></i> to <i><tt class='parameter'>output_encoding</tt></i> . </p> <p class='para'> <i><tt class='parameter'>internal_encoding</tt></i> and <i><tt class='parameter'>output_encoding</tt></i> should be defined in the <var class='filename'>php.ini</var> file or in <a href='http://www.php.net/manual/en/function.iconv-set-encoding.php' class='function'>iconv_set_encoding()</a>. </p> </div> <a name='function.ob-iconv-handler.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> See <a href='http://www.php.net/manual/en/function.ob-start.php' class='function'>ob_start()</a> for information about this handler parameters. </p> </div> <a name='function.ob-iconv-handler.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> See <a href='http://www.php.net/manual/en/function.ob-start.php' class='function'>ob_start()</a> for information about this handler return values. </p> </div> <a name='function.ob-iconv-handler.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ob_iconv_handler()</b> example:</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />iconv_set_encoding</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'internal_encoding'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>iconv_set_encoding</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'output_encoding'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ISO-8859-1'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>ob_start</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ob_iconv_handler'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;start&amp;nbsp;output&amp;nbsp;buffering<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ob-iconv-handler.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.iconv-get-encoding.php' class='function' rel='rdfs-seeAlso'>iconv_get_encoding()</a> - Retrieve internal configuration variables of iconv extension</li> <li class='member'><a href='http://www.php.net/manual/en/function.iconv-set-encoding.php' class='function' rel='rdfs-seeAlso'>iconv_set_encoding()</a> - Set current setting for character encoding conversion</li> <li class='member'><a href='http://www.php.net/manual/en/ref.outcontrol.php' class='link'>output-control functions</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ngettext" value="<div id='function.ngettext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ngettext.php'>ngettext</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ngettext</span> &amp;mdash; <span class='dc-title'>Plural version of gettext</span></p> </div> <a name='function.ngettext.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ngettext</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$msgid1</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$msgid2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$n</tt></span> )</div> <p class='para rdfs-comment'> The plural version of <a href='http://www.php.net/manual/en/function.gettext.php' class='function'>gettext()</a>. Some languages have more than one form for plural messages dependent on the count. </p> </div> <a name='function.ngettext.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msgid1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msgid2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>n</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ngettext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns correct plural form of message identified by <i><tt class='parameter'>msgid1</tt></i> and <i><tt class='parameter'>msgid2</tt></i> for count <i><tt class='parameter'>n</tt></i> . </p> </div> <a name='function.ngettext.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ngettext()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />setlocale</span><span style='color: #007700'>(</span><span style='color: #0000BB'>LC_ALL</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'cs_CZ'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ngettext</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%d&amp;nbsp;window'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'%d&amp;nbsp;windows'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;1&amp;nbsp;okno<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ngettext</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%d&amp;nbsp;window'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'%d&amp;nbsp;windows'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;2&amp;nbsp;okna<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ngettext</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%d&amp;nbsp;window'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'%d&amp;nbsp;windows'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;5&amp;nbsp;oken<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mime_content_type" value="<div id='function.mime-content-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mime-content-type.php'>mime_content_type</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mime_content_type</span> &amp;mdash; <span class='dc-title'>Detect MIME Content-type for a file (deprecated)</span></p> </div> <a name='function.mime-content-type.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mime_content_type</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Returns the MIME content type for a file as determined by using information from the <var class='filename'>magic.mime</var> file. </p> </div> <a name='function.mime-content-type.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Path to the tested file. </p> </dd> </dl> <p> </p> </div> <a name='function.mime-content-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the content type in MIME format, like <i>text/plain</i> or <i>application/octet-stream</i>. </p> </div> <a name='function.mime-content-type.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='warning'><b class='warning'>Warning</b> <p class='para'> This function has been deprecated as the PECL extension <a href='http://www.php.net/manual/en/ref.fileinfo.php' class='link'>Fileinfo</a> provides the same functionality (and more) in a much cleaner way. </p> </div> </div> <a name='function.mime-content-type.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mime_content_type()</b> Example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>mime_content_type</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.gif'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>mime_content_type</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'test.php'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> image/gif text/plain </pre></div> </div> </div><p> </p> </div> <a name='function.mime-content-type.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'> <a href='http://www.php.net/manual/en/ref.fileinfo.php' class='link'>Fileinfo</a> for a replacement </li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_set_server_params" value="<div id='function.memcache-setserverparams' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-setserverparams.php'>Memcache::setServerParams</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 2.1.0)</p><p class='refpurpose'><span class='refname'>Memcache::setServerParams</span> &amp;mdash; <span class='dc-title'>Changes server parameters and status at runtime</span></p> </div> <a name='function.memcache-setserverparams.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::setServerParams</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$host</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timeout</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$retry_interval</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$status</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.callback' class='type callback'>callback</a></span> <tt class='parameter'>$failure_callback</tt></span> ]]]]] )</div> <p class='para rdfs-comment'> <b>Memcache::setServerParams()</b> changes server parameters at runtime. You can also use the <b>memcache_set_server_params()</b> function. </p> <blockquote><p><b class='note'>Note</b>: This function has been added to Memcache version 2.1.0. <br /> </p></blockquote> </div> <a name='function.memcache-setserverparams.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>host</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Point to the host where memcached is listening for connections. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Point to the port where memcached is listening for connections. This parameter is optional and its default value is 11211. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timeout</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>retry_interval</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Controls how often a failed server will be retried, the default value is 15 seconds. Setting this parameter to -1 disables automatic retry. Neither this nor the <i><tt class='parameter'>persistent</tt></i> parameter has any effect when the extension is loaded dynamically via <a href='http://www.php.net/manual/en/function.dl.php' class='function'>dl()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>status</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Controls if the server should be flagged as online. Setting this parameter to <b><tt class='constant'>FALSE</tt></b> and <i><tt class='parameter'>retry_interval</tt></i> to -1 allows a failed server to be kept in the pool so as not to affect the key distribution algoritm. Requests for this server will then failover or fail immediately depending on the <i><tt class='parameter'>memcache.allow_failover</tt></i> setting. Default to <b><tt class='constant'>TRUE</tt></b>, meaning the server should be considered online. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>failure_callback</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Allows the user to specify a callback function to run upon encountering an error. The callback is run before failover is attempted. The function takes two parameters, the hostname and port of the failed server. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-setserverparams.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-setserverparams.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::setServerParams()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #007700'>function&amp;nbsp;</span><span style='color: #0000BB'>_callback_memcache_failure</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$host</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$port</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'memcache&amp;nbsp;'</span><span style='color: #0000BB'>$host</span><span style='color: #DD0000'>:</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>'&amp;nbsp;failed'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Add&amp;nbsp;the&amp;nbsp;server&amp;nbsp;in&amp;nbsp;offline&amp;nbsp;mode<br /></span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>addServer</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Bring&amp;nbsp;the&amp;nbsp;server&amp;nbsp;back&amp;nbsp;online<br /></span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>setServerParams</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>15</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'_callback_memcache_failure'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>memcache_set_server_params</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>15</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'_callback_memcache_failure'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-setserverparams.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-addserver.php' class='function' rel='rdfs-seeAlso'>Memcache::addServer()</a> - Add a memcached server to connection pool</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-getserverstatus.php' class='function' rel='rdfs-seeAlso'>Memcache::getServerStatus()</a> - Returns server status</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_set_compress_threshold" value="<div id='function.memcache-setcompressthreshold' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-setcompressthreshold.php'>Memcache::setCompressThreshold</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 2.0.0)</p><p class='refpurpose'><span class='refname'>Memcache::setCompressThreshold</span> &amp;mdash; <span class='dc-title'>Enable automatic compression of large values</span></p> </div> <a name='function.memcache-setcompressthreshold.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::setCompressThreshold</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$threshold</tt></span> [, <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$min_savings</tt></span> ] )</div> <p class='para rdfs-comment'> <b>Memcache::setCompressThreshold()</b> enables automatic compression of large values. You can also use the <b>memcache_set_compress_threshold()</b> function. </p> <blockquote><p><b class='note'>Note</b>: This function has been added to Memcache version 2.0.0. <br /> </p></blockquote> </div> <a name='function.memcache-setcompressthreshold.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>threshold</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Controls the minimum value length before attempting to compress automatically. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>min_saving</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the minimum amount of savings to actually store the value compressed. The supplied value must be between 0 and 1. Default value is 0.2 giving a minimum 20% compression savings. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-setcompressthreshold.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-setcompressthreshold.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::setCompressThreshold()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>addServer</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>setCompressThreshold</span><span style='color: #007700'>(</span><span style='color: #0000BB'>20000</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0.2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>memcache_set_compress_threshold</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20000</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0.2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_set" value="<div id='function.memcache-set' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-set.php'>Memcache::set</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>Memcache::set</span> &amp;mdash; <span class='dc-title'>Store data at the server</span></p> </div> <a name='function.memcache-set.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::set</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$key</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$var</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flag</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$expire</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>Memcache::set()</b> stores an item <i><tt class='parameter'>var</tt></i> with <i><tt class='parameter'>key</tt></i> on the memcached server. Parameter <i><tt class='parameter'>expire</tt></i> is expiration time in seconds. If it&amp;#039;s 0, the item never expires (but memcached server doesn&amp;#039;t guarantee this item to be stored all the time, it could be deleted from the cache to make place for other items). You can use <b><tt class='constant'>MEMCACHE_COMPRESSED</tt></b> constant as <i><tt class='parameter'>flag</tt></i> value if you want to use on-the-fly compression (uses zlib). </p><blockquote><p><b class='note'>Note</b>: Remember that resource variables (i.e. file and connection descriptors) cannot be stored in the cache, because they cannot be adequately represented in serialized state. <br /> </p></blockquote><p> Also you can use <b>memcache_set()</b> function. </p> </div> <a name='function.memcache-set.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>key</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The key that will be associated with the item. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable to store. Strings and integers are stored as is, other types are stored serialized. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flag</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Use <b><tt class='constant'>MEMCACHE_COMPRESSED</tt></b> to store the item compressed (uses zlib). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>expire</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Expiration time of the item. If it&amp;#039;s equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days). </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-set.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-set.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::set()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /><br />/*&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;memcached&amp;nbsp;server&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*<br />set&amp;nbsp;value&amp;nbsp;of&amp;nbsp;item&amp;nbsp;with&amp;nbsp;key&amp;nbsp;'var_key'<br />using&amp;nbsp;0&amp;nbsp;as&amp;nbsp;flag&amp;nbsp;value,&amp;nbsp;compression&amp;nbsp;is&amp;nbsp;not&amp;nbsp;used<br />expire&amp;nbsp;time&amp;nbsp;is&amp;nbsp;30&amp;nbsp;seconds<br />*/<br /></span><span style='color: #0000BB'>memcache_set</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'var_key'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'some&amp;nbsp;variable'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>memcache_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'var_key'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 <b>Memcache::set()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;memcached&amp;nbsp;server&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*<br />set&amp;nbsp;value&amp;nbsp;of&amp;nbsp;item&amp;nbsp;with&amp;nbsp;key&amp;nbsp;'var_key',&amp;nbsp;using&amp;nbsp;on-the-fly&amp;nbsp;compression<br />expire&amp;nbsp;time&amp;nbsp;is&amp;nbsp;50&amp;nbsp;seconds<br />*/<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>set</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'var_key'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'some&amp;nbsp;really&amp;nbsp;big&amp;nbsp;variable'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MEMCACHE_COMPRESSED</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>get</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'var_key'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-set.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-add.php' class='function' rel='rdfs-seeAlso'>Memcache::add()</a> - Add an item to the server</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-replace.php' class='function' rel='rdfs-seeAlso'>Memcache::replace()</a> - Replace value of the existing item</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_replace" value="<div id='function.memcache-replace' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-replace.php'>Memcache::replace</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>Memcache::replace</span> &amp;mdash; <span class='dc-title'>Replace value of the existing item</span></p> </div> <a name='function.memcache-replace.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::replace</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$key</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$var</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flag</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$expire</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>Memcache::replace()</b> should be used to replace value of existing item with <i><tt class='parameter'>key</tt></i> . In case if item with such key doesn&amp;#039;t exists, <b>Memcache::replace()</b> returns <b><tt class='constant'>FALSE</tt></b>. For the rest <b>Memcache::replace()</b> behaves similarly to <a href='http://www.php.net/manual/en/function.memcache-set.php' class='function'>Memcache::set()</a>. Also you can use <b>memcache_replace()</b> function. </p> </div> <a name='function.memcache-replace.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>key</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The key that will be associated with the item. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable to store. Strings and integers are stored as is, other types are stored serialized. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flag</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Use <b><tt class='constant'>MEMCACHE_COMPRESSED</tt></b> to store the item compressed (uses zlib). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>expire</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Expiration time of the item. If it&amp;#039;s equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days). </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-replace.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-replace.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::replace()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>memcache_replace</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test_key'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'some&amp;nbsp;variable'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>replace</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'test_key'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'some&amp;nbsp;variable'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-replace.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-set.php' class='function' rel='rdfs-seeAlso'>Memcache::set()</a> - Store data at the server</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-add.php' class='function' rel='rdfs-seeAlso'>Memcache::add()</a> - Add an item to the server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_pconnect" value="<div id='function.memcache-pconnect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-pconnect.php'>Memcache::pconnect</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.4.0)</p><p class='refpurpose'><span class='refname'>Memcache::pconnect</span> &amp;mdash; <span class='dc-title'>Open memcached server persistent connection</span></p> </div> <a name='function.memcache-pconnect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::pconnect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$host</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timeout</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>Memcache::pconnect()</b> is similar to <a href='http://www.php.net/manual/en/function.memcache-connect.php' class='function'>Memcache::connect()</a> with the difference, that the connection it establishes is persistent. This connection is not closed after the end of script execution and by <a href='http://www.php.net/manual/en/function.memcache-close.php' class='function'>Memcache::close()</a> function. Also you can use <b>memcache_pconnect()</b> function. </p> </div> <a name='function.memcache-pconnect.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>host</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Point to the host where memcached is listening for connections. This parameter may also specify other transports like <i>unix:///path/to/memcached.sock</i> to use UNIX domain sockets, in this case <i><tt class='parameter'>port</tt></i> must also be set to <i>0</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Point to the port where memcached is listening for connections. Set this parameter to <i>0</i> when using UNIX domain sockets. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timeout</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-pconnect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-pconnect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::pconnect()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-pconnect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-connect.php' class='function' rel='rdfs-seeAlso'>Memcache::connect()</a> - Open memcached server connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_increment" value="<div id='function.memcache-increment' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-increment.php'>Memcache::increment</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>Memcache::increment</span> &amp;mdash; <span class='dc-title'>Increment item&amp;#039;s value</span></p> </div> <a name='function.memcache-increment.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>Memcache::increment</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$key</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$value</tt></span> ] )</div> <p class='para rdfs-comment'> <b>Memcache::increment()</b> increments value of the item on the specified <i><tt class='parameter'>value</tt></i> . If item with key <i><tt class='parameter'>key</tt></i> was not numeric and cannot be converted to number, it will change it&amp;#039;s value to <i><tt class='parameter'>value</tt></i> . <b>Memcache::increment()</b> <em class='emphasis'>does not</em> create an item if it didn&amp;#039;t exist. </p><blockquote><p><b class='note'>Note</b>: Do not use <b>Memcache::increment()</b> with item, which was stored compressed, because consequent call to <a href='http://www.php.net/manual/en/function.memcache-get.php' class='function'>Memcache::get()</a> will fail. <br /> </p></blockquote><p> Also you can use <b>memcache_increment()</b> function. </p> </div> <a name='function.memcache-increment.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>key</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Key of the item to increment. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>value</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Increment the item by <i><tt class='parameter'>value</tt></i> . Optional and defaults to 1. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-increment.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns new item&amp;#039;s value on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-increment.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::increment()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>/*&amp;nbsp;increment&amp;nbsp;counter&amp;nbsp;by&amp;nbsp;2&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$current_value&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_increment</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'counter'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>/*&amp;nbsp;increment&amp;nbsp;counter&amp;nbsp;by&amp;nbsp;3&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$current_value&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>increment</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'counter'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-increment.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-decrement.php' class='function' rel='rdfs-seeAlso'>Memcache::decrement()</a> - Decrement item's value</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-replace.php' class='function' rel='rdfs-seeAlso'>Memcache::replace()</a> - Replace value of the existing item</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_get_version" value="<div id='function.memcache-getversion' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-getversion.php'>Memcache::getVersion</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>Memcache::getVersion</span> &amp;mdash; <span class='dc-title'>Return version of the server</span></p> </div> <a name='function.memcache-getversion.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>Memcache::getVersion</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> <b>Memcache::getVersion()</b> returns a string with server&amp;#039;s version number. Also you can use <b>memcache_get_version()</b> function. </p> </div> <a name='function.memcache-getversion.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string of server version number or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-getversion.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::getVersion()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>getVersion</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>memcache_get_version</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-getversion.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-getextendedstats.php' class='function' rel='rdfs-seeAlso'>Memcache::getExtendedStats()</a> - Get statistics from all servers in pool</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-getstats.php' class='function' rel='rdfs-seeAlso'>Memcache::getStats()</a> - Get statistics of the server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_get_stats" value="<div id='function.memcache-getstats' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-getstats.php'>Memcache::getStats</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>Memcache::getStats</span> &amp;mdash; <span class='dc-title'>Get statistics of the server</span></p> </div> <a name='function.memcache-getstats.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>Memcache::getStats</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$type</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$slabid</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$limit</tt></span> ]]] )</div> <p class='para rdfs-comment'> <b>Memcache::getStats()</b> returns an associative array with server&amp;#039;s statistics. Array keys correspond to stats parameters and values to parameter&amp;#039;s values. Also you can use <b>memcache_get_stats()</b> function. </p> </div> <a name='function.memcache-getstats.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The type of statistics to fetch. Valid values are {reset, malloc, maps, cachedump, slabs, items, sizes}. According to the memcached protocol spec these additional arguments &amp;quot;are subject to change for the convenience of memcache developers&amp;quot;. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>slabid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Used in conjunction with <i><tt class='parameter'>type</tt></i> set to cachedump to identify the slab to dump from. The cachedump command ties up the server and is strictly to be used for debugging purposes. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>limit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Used in conjunction with <i><tt class='parameter'>type</tt></i> set to cachedump to limit the number of entries to dump. Default value is 100. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-getstats.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array of server statistics or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-getstats.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-getversion.php' class='function' rel='rdfs-seeAlso'>Memcache::getVersion()</a> - Return version of the server</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-getextendedstats.php' class='function' rel='rdfs-seeAlso'>Memcache::getExtendedStats()</a> - Get statistics from all servers in pool</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_get_server_status" value="<div id='function.memcache-getserverstatus' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-getserverstatus.php'>Memcache::getServerStatus</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 2.1.0)</p><p class='refpurpose'><span class='refname'>Memcache::getServerStatus</span> &amp;mdash; <span class='dc-title'>Returns server status</span></p> </div> <a name='function.memcache-getserverstatus.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>Memcache::getServerStatus</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$host</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt></span> ] )</div> <p class='para rdfs-comment'> <b>Memcache::getServerStatus()</b> returns a the servers online/offline status. You can also use <b>memcache_get_server_status()</b> function. </p> <blockquote><p><b class='note'>Note</b>: This function has been added to Memcache version 2.1.0. <br /> </p></blockquote> </div> <a name='function.memcache-getserverstatus.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>host</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Point to the host where memcached is listening for connections. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Point to the port where memcached is listening for connections. This parameter is optional and its default value is 11211. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-getserverstatus.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a the servers status. 0 if server is failed, non-zero otherwise </p> </div> <a name='function.memcache-getserverstatus.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::getServerStatus()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>addServer</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>getServerStatus</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>memcache_get_server_status</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-getserverstatus.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-addserver.php' class='function' rel='rdfs-seeAlso'>Memcache::addServer()</a> - Add a memcached server to connection pool</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-setserverparams.php' class='function' rel='rdfs-seeAlso'>Memcache::setServerParams()</a> - Changes server parameters and status at runtime</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_get_extended_stats" value="<div id='function.memcache-getextendedstats' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-getextendedstats.php'>Memcache::getExtendedStats</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 2.0.0)</p><p class='refpurpose'><span class='refname'>Memcache::getExtendedStats</span> &amp;mdash; <span class='dc-title'>Get statistics from all servers in pool</span></p> </div> <a name='function.memcache-getextendedstats.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>Memcache::getExtendedStats</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$type</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$slabid</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$limit</tt></span> ]]] )</div> <p class='para rdfs-comment'> <b>Memcache::getExtendedStats()</b> returns a two-dimensional associative array with server statistics. Array keys correspond to host:port of server and values contain the individual server statistics. A failed server will have its corresponding entry set to <b><tt class='constant'>FALSE</tt></b>. You can also use the <b>memcache_get_extended_stats()</b> function. </p> <blockquote><p><b class='note'>Note</b>: This function has been added to Memcache version 2.0.0. <br /> </p></blockquote> </div> <a name='function.memcache-getextendedstats.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The type of statistics to fetch. Valid values are {reset, malloc, maps, cachedump, slabs, items, sizes}. According to the memcached protocol spec these additional arguments &amp;quot;are subject to change for the convenience of memcache developers&amp;quot;. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>slabid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Used in conjunction with <i><tt class='parameter'>type</tt></i> set to cachedump to identify the slab to dump from. The cachedump command ties up the server and is strictly to be used for debugging purposes. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>limit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Used in conjunction with <i><tt class='parameter'>type</tt></i> set to cachedump to limit the number of entries to dump. Default value is 100. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-getextendedstats.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a two-dimensional associative array of server statistics or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-getextendedstats.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::getExtendedStats()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>addServer</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>addServer</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'failed_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stats&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>getExtendedStats</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stats</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Array ( [memcache_host:11211] =&amp;gt; Array ( [pid] =&amp;gt; 3756 [uptime] =&amp;gt; 603011 [time] =&amp;gt; 1133810435 [version] =&amp;gt; 1.1.12 [rusage_user] =&amp;gt; 0.451931 [rusage_system] =&amp;gt; 0.634903 [curr_items] =&amp;gt; 2483 [total_items] =&amp;gt; 3079 [bytes] =&amp;gt; 2718136 [curr_connections] =&amp;gt; 2 [total_connections] =&amp;gt; 807 [connection_structures] =&amp;gt; 13 [cmd_get] =&amp;gt; 9748 [cmd_set] =&amp;gt; 3096 [get_hits] =&amp;gt; 5976 [get_misses] =&amp;gt; 3772 [bytes_read] =&amp;gt; 3448968 [bytes_written] =&amp;gt; 2318883 [limit_maxbytes] =&amp;gt; 33554432 ) [failed_host:11211] =&amp;gt; false ) </pre></div> </div> </div><p> </p> </div> <a name='function.memcache-getextendedstats.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-getversion.php' class='function' rel='rdfs-seeAlso'>Memcache::getVersion()</a> - Return version of the server</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-getstats.php' class='function' rel='rdfs-seeAlso'>Memcache::getStats()</a> - Get statistics of the server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_get" value="<div id='function.memcache-get' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-get.php'>Memcache::get</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>Memcache::get</span> &amp;mdash; <span class='dc-title'>Retrieve item from the server</span></p> </div> <a name='function.memcache-get.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>Memcache::get</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$key</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter reference'>&amp;amp;$flags</tt></span> ] )</div> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>Memcache::get</b></span> ( <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$keys</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$flags</tt></span> ] )</div> <p class='para rdfs-comment'> <b>Memcache::get()</b> returns previously stored data if an item with such <i><tt class='parameter'>key</tt></i> exists on the server at this moment. </p> <p class='para'> You can pass array of keys to <b>Memcache::get()</b> to get array of values. The result array will contain only found key-value pairs. </p> </div> <a name='function.memcache-get.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>key</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The key or array of keys to fetch. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If present, flags fetched along with the values will be written to this parameter. These flags are the same as the ones given to for example <a href='http://www.php.net/manual/en/function.memcache-set.php' class='function'>Memcache::set()</a>. The lowest byte of the int is reserved for pecl/memcache internal usage (e.g. to indicate compression and serialization status). </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-get.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the string associated with the <i><tt class='parameter'>key</tt></i> or <b><tt class='constant'>FALSE</tt></b> on failure or if such <i><tt class='parameter'>key</tt></i> was not found. </p> </div> <a name='function.memcache-get.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::get()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$var&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'some_key'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$var&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>get</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'some_key'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;<br />You&amp;nbsp;also&amp;nbsp;can&amp;nbsp;use&amp;nbsp;array&amp;nbsp;of&amp;nbsp;keys&amp;nbsp;as&amp;nbsp;a&amp;nbsp;parameter.<br />If&amp;nbsp;such&amp;nbsp;item&amp;nbsp;wasn't&amp;nbsp;found&amp;nbsp;at&amp;nbsp;the&amp;nbsp;server,&amp;nbsp;the&amp;nbsp;result<br />array&amp;nbsp;simply&amp;nbsp;will&amp;nbsp;not&amp;nbsp;include&amp;nbsp;such&amp;nbsp;key.<br />*/<br /><br />/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$var&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;Array(</span><span style='color: #DD0000'>'some_key'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'another_key'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$var&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>get</span><span style='color: #007700'>(Array(</span><span style='color: #DD0000'>'some_key'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'second_key'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_flush" value="<div id='function.memcache-flush' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-flush.php'>Memcache::flush</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>Memcache::flush</span> &amp;mdash; <span class='dc-title'>Flush all existing items at the server</span></p> </div> <a name='function.memcache-flush.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::flush</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> <b>Memcache::flush()</b> immediately invalidates all existing items. <b>Memcache::flush()</b> doesn&amp;#039;t actually free any resources, it only marks all the items as expired, so occupied memory will be overwritten by new items. Also you can use <b>memcache_flush()</b> function. </p> </div> <a name='function.memcache-flush.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-flush.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::flush()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>memcache_flush</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>flush</span><span style='color: #007700'>();<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_delete" value="<div id='function.memcache-delete' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-delete.php'>Memcache::delete</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>Memcache::delete</span> &amp;mdash; <span class='dc-title'>Delete item from the server</span></p> </div> <a name='function.memcache-delete.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::delete</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$key</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timeout</tt></span> ] )</div> <p class='para rdfs-comment'> <b>Memcache::delete()</b> deletes item with the <i><tt class='parameter'>key</tt></i> . If parameter <i><tt class='parameter'>timeout</tt></i> is specified, the item will expire after <i><tt class='parameter'>timeout</tt></i> seconds. Also you can use <b>memcache_delete()</b> function. </p> </div> <a name='function.memcache-delete.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>key</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The key associated with the item to delete. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timeout</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Execution time of the item. If it&amp;#039;s equal to zero, the item will be deleted right away whereas if you set it to 30, the item will be deleted in 30 seconds. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-delete.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-delete.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::delete()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;after&amp;nbsp;10&amp;nbsp;seconds&amp;nbsp;item&amp;nbsp;will&amp;nbsp;be&amp;nbsp;deleted&amp;nbsp;by&amp;nbsp;the&amp;nbsp;server&amp;nbsp;*/<br /></span><span style='color: #0000BB'>memcache_delete</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'key_to_delete'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>delete</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'key_to_delete'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-delete.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-set.php' class='function' rel='rdfs-seeAlso'>Memcache::set()</a> - Store data at the server</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-replace.php' class='function' rel='rdfs-seeAlso'>Memcache::replace()</a> - Replace value of the existing item</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_decrement" value="<div id='function.memcache-decrement' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-decrement.php'>Memcache::decrement</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>Memcache::decrement</span> &amp;mdash; <span class='dc-title'>Decrement item&amp;#039;s value</span></p> </div> <a name='function.memcache-decrement.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>Memcache::decrement</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$key</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$value</tt></span> ] )</div> <p class='para rdfs-comment'> <b>Memcache::decrement()</b> decrements value of the item by <i><tt class='parameter'>value</tt></i> . Similarly to <a href='http://www.php.net/manual/en/function.memcache-increment.php' class='function'>Memcache::increment()</a>, current value of the item is being converted to numerical and after that <i><tt class='parameter'>value</tt></i> is substracted. </p><blockquote><p><b class='note'>Note</b>: New item&amp;#039;s value will not be less than zero. <br /> </p></blockquote><p> </p><blockquote><p><b class='note'>Note</b>: Do not use <b>Memcache::decrement()</b> with item, which was stored compressed, because consequent call to <a href='http://www.php.net/manual/en/function.memcache-get.php' class='function'>Memcache::get()</a> will fail. <br /> </p></blockquote><p> <b>Memcache::decrement()</b> <em class='emphasis'>does not</em> create an item if it didn&amp;#039;t exist. Also you can use <b>memcache_decrement()</b> function. </p> </div> <a name='function.memcache-decrement.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>key</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Key of the item do decrement. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>value</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Decrement the item by <i><tt class='parameter'>value</tt></i> . Optional and defaults to 1. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-decrement.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns item&amp;#039;s new value on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-decrement.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::decrement()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>/*&amp;nbsp;decrement&amp;nbsp;item&amp;nbsp;by&amp;nbsp;2&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$new_value&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_decrement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test_item'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>/*&amp;nbsp;decrement&amp;nbsp;item&amp;nbsp;by&amp;nbsp;3&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$new_value&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>decrement</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'test_item'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-decrement.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-increment.php' class='function' rel='rdfs-seeAlso'>Memcache::increment()</a> - Increment item's value</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-replace.php' class='function' rel='rdfs-seeAlso'>Memcache::replace()</a> - Replace value of the existing item</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_debug" value="<div id='function.memcache-debug' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-debug.php'>memcache_debug</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>memcache_debug</span> &amp;mdash; <span class='dc-title'>Turn debug output on/off</span></p> </div> <a name='function.memcache-debug.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>memcache_debug</b></span> ( <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$on_off</tt></span> )</div> <p class='para rdfs-comment'> <b>memcache_debug()</b> turns on debug output if parameter <i><tt class='parameter'>on_off</tt></i> is equal to <b><tt class='constant'>TRUE</tt></b> and turns off if it&amp;#039;s <b><tt class='constant'>FALSE</tt></b>. </p><blockquote><p><b class='note'>Note</b>: <b>memcache_debug()</b> is accessible only if PHP was built with --enable-debug option and always returns <b><tt class='constant'>TRUE</tt></b> in this case. Otherwise, this function has no effect and always returns <b><tt class='constant'>FALSE</tt></b>. <br /> </p></blockquote><p> </p> </div> <a name='function.memcache-debug.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>on_off</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Turns debug output on if equals to <b><tt class='constant'>TRUE</tt></b>. Turns debug output off if equals to <b><tt class='constant'>FALSE</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-debug.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if PHP was built with --enable-debug option, otherwise returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_connect" value="<div id='function.memcache-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-connect.php'>Memcache::connect</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>Memcache::connect</span> &amp;mdash; <span class='dc-title'>Open memcached server connection</span></p> </div> <a name='function.memcache-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::connect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$host</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timeout</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>Memcache::connect()</b> establishes a connection to the memcached server. The connection, which was opened using <b>Memcache::connect()</b> will be automatically closed at the end of script execution. Also you can close it with <a href='http://www.php.net/manual/en/function.memcache-close.php' class='function'>Memcache::close()</a>. Also you can use <b>memcache_connect()</b> function. </p> </div> <a name='function.memcache-connect.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>host</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Point to the host where memcached is listening for connections. This parameter may also specify other transports like <i>unix:///path/to/memcached.sock</i> to use UNIX domain sockets, in this case <i><tt class='parameter'>port</tt></i> must also be set to <i>0</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Point to the port where memcached is listening for connections. Set this parameter to <i>0</i> when using UNIX domain sockets. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timeout</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow. </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::connect()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-connect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-pconnect.php' class='function' rel='rdfs-seeAlso'>Memcache::pconnect()</a> - Open memcached server persistent connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-close.php' class='function' rel='rdfs-seeAlso'>Memcache::close()</a> - Close memcached server connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_close" value="<div id='function.memcache-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-close.php'>Memcache::close</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.4.0)</p><p class='refpurpose'><span class='refname'>Memcache::close</span> &amp;mdash; <span class='dc-title'>Close memcached server connection</span></p> </div> <a name='function.memcache-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::close</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> <b>Memcache::close()</b> closes connection to memcached server. This function doesn&amp;#039;t close persistent connections, which are closed only during web-server shutdown/restart. Also you can use <b>memcache_close()</b> function. </p> </div> <a name='function.memcache-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-close.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::close()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>/*&amp;nbsp;<br />do&amp;nbsp;something&amp;nbsp;here&amp;nbsp;..<br />*/<br /></span><span style='color: #0000BB'>memcache_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>/*&amp;nbsp;<br />do&amp;nbsp;something&amp;nbsp;here&amp;nbsp;..<br />*/<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-close.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-connect.php' class='function' rel='rdfs-seeAlso'>Memcache::connect()</a> - Open memcached server connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-pconnect.php' class='function' rel='rdfs-seeAlso'>Memcache::pconnect()</a> - Open memcached server persistent connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_add_server" value="<div id='function.memcache-addserver' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-addserver.php'>Memcache::addServer</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 2.0.0)</p><p class='refpurpose'><span class='refname'>Memcache::addServer</span> &amp;mdash; <span class='dc-title'>Add a memcached server to connection pool</span></p> </div> <a name='function.memcache-addserver.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::addServer</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$host</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$persistent</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$weight</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timeout</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$retry_interval</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$status</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.callback' class='type callback'>callback</a></span> <tt class='parameter'>$failure_callback</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timeoutms</tt></span> ]]]]]]]] )</div> <p class='para rdfs-comment'> <b>Memcache::addServer()</b> adds a server to the connection pool. The connection, which was opened using <b>Memcache::addServer()</b> will be automatically closed at the end of script execution, you can also close it manually with <a href='http://www.php.net/manual/en/function.memcache-close.php' class='function'>Memcache::close()</a>. You can also use the <b>memcache_add_server()</b> function. </p> <p class='para'> When using this method (as opposed to <a href='http://www.php.net/manual/en/function.memcache-connect.php' class='function'>Memcache::connect()</a> and <a href='http://www.php.net/manual/en/function.memcache-pconnect.php' class='function'>Memcache::pconnect()</a>) the network connection is not established until actually needed. Thus there is no overhead in adding a large number of servers to the pool, even though they might not all be used. </p> <p class='para'> Failover may occur at any stage in any of the methods, as long as other servers are available the request the user won&amp;#039;t notice. Any kind of socket or Memcached server level errors (except out-of-memory) may trigger the failover. Normal client errors such as adding an existing key will not trigger a failover. </p> <blockquote><p><b class='note'>Note</b>: This function has been added to Memcache version 2.0.0. <br /> </p></blockquote> </div> <a name='function.memcache-addserver.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>host</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Point to the host where memcached is listening for connections. This parameter may also specify other transports like <i>unix:///path/to/memcached.sock</i> to use UNIX domain sockets, in this case <i><tt class='parameter'>port</tt></i> must also be set to <i>0</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Point to the port where memcached is listening for connections. This parameter is optional and its default value is 11211. Set this parameter to <i>0</i> when using UNIX domain sockets. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>persistent</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Controls the use of a persistent connection. Default to <b><tt class='constant'>TRUE</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>weight</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Number of buckets to create for this server which in turn control its probability of it being selected. The probability is relative to the total weight of all servers. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timeout</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>retry_interval</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Controls how often a failed server will be retried, the default value is 15 seconds. Setting this parameter to -1 disables automatic retry. Neither this nor the <i><tt class='parameter'>persistent</tt></i> parameter has any effect when the extension is loaded dynamically via <a href='http://www.php.net/manual/en/function.dl.php' class='function'>dl()</a>. </p> <p class='para'> Each failed connection struct has its own timeout and before it has expired the struct will be skipped when selecting backends to serve a request. Once expired the connection will be successfully reconnected or marked as failed for another <i><tt class='parameter'>retry_interval</tt></i> seconds. The typical effect is that each web server child will retry the connection about every <i><tt class='parameter'>retry_interval</tt></i> seconds when serving a page. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>status</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Controls if the server should be flagged as online. Setting this parameter to <b><tt class='constant'>FALSE</tt></b> and <i><tt class='parameter'>retry_interval</tt></i> to -1 allows a failed server to be kept in the pool so as not to affect the key distribution algorithm. Requests for this server will then failover or fail immediately depending on the <i><tt class='parameter'>memcache.allow_failover</tt></i> setting. Default to <b><tt class='constant'>TRUE</tt></b>, meaning the server should be considered online. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>failure_callback</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Allows the user to specify a callback function to run upon encountering an error. The callback is run before failover is attempted. The function takes two parameters, the hostname and port of the failed server. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timeoutms</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-addserver.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.memcache-addserver.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::addServer()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Memcache</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>addServer</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$memcache</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>addServer</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'memcache_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>memcache_add_server</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'memcache_host2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-addserver.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-connect.php' class='function' rel='rdfs-seeAlso'>Memcache::connect()</a> - Open memcached server connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-pconnect.php' class='function' rel='rdfs-seeAlso'>Memcache::pconnect()</a> - Open memcached server persistent connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-close.php' class='function' rel='rdfs-seeAlso'>Memcache::close()</a> - Close memcached server connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-setserverparams.php' class='function' rel='rdfs-seeAlso'>Memcache::setServerParams()</a> - Changes server parameters and status at runtime</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-getserverstatus.php' class='function' rel='rdfs-seeAlso'>Memcache::getServerStatus()</a> - Returns server status</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="memcache_add" value="<div id='function.memcache-add' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memcache-add.php'>Memcache::add</a></h1> <p class='verinfo'>(PECL memcache &amp;gt;= 0.2.0)</p><p class='refpurpose'><span class='refname'>Memcache::add</span> &amp;mdash; <span class='dc-title'>Add an item to the server</span></p> </div> <a name='function.memcache-add.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>Memcache::add</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$key</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$var</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flag</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$expire</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>Memcache::add()</b> stores variable <i><tt class='parameter'>var</tt></i> with <i><tt class='parameter'>key</tt></i> only if such key doesn&amp;#039;t exist at the server yet. Also you can use <b>memcache_add()</b> function. </p> </div> <a name='function.memcache-add.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>key</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The key that will be associated with the item. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable to store. Strings and integers are stored as is, other types are stored serialized. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flag</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Use <b><tt class='constant'>MEMCACHE_COMPRESSED</tt></b> to store the item compressed (uses zlib). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>expire</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Expiration time of the item. If it&amp;#039;s equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days). </p> </dd> </dl> <p> </p> </div> <a name='function.memcache-add.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. Returns <b><tt class='constant'>FALSE</tt></b> if such key already exist. For the rest <b>Memcache::add()</b> behaves similarly to <a href='http://www.php.net/manual/en/function.memcache-set.php' class='function'>Memcache::set()</a>. </p> </div> <a name='function.memcache-add.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>Memcache::add()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$memcache_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>memcache_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11211</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;procedural&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>memcache_add</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'var_key'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test&amp;nbsp;variable'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;OO&amp;nbsp;API&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$memcache_obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>add</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'var_key'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test&amp;nbsp;variable'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memcache-add.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-set.php' class='function' rel='rdfs-seeAlso'>Memcache::set()</a> - Store data at the server</li> <li class='member'><a href='http://www.php.net/manual/en/function.memcache-replace.php' class='function' rel='rdfs-seeAlso'>Memcache::replace()</a> - Replace value of the existing item</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="juliantojd" value="<div id='function.juliantojd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.juliantojd.php'>JulianToJD</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>JulianToJD</span> &amp;mdash; <span class='dc-title'>Converts a Julian Calendar date to Julian Day Count</span></p> </div> <a name='function.juliantojd.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>juliantojd</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$month</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$day</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$year</tt></span> )</div> <p class='para rdfs-comment'> Valid Range for Julian Calendar 4713 B.C. to 9999 A.D. </p> <p class='para'> Although this function can handle dates all the way back to 4713 B.C., such use may not be meaningful. The calendar was created in 46 B.C., but the details did not stabilize until at least 8 A.D., and perhaps as late at the 4th century. Also, the beginning of a year varied from one culture to another - not all accepted January as the first month. </p> <div class='caution'><b class='caution'>Caution</b> <p class='para'> Remember, the current calendar system being used worldwide is the Gregorian calendar. <a href='http://www.php.net/manual/en/function.gregoriantojd.php' class='function'>gregoriantojd()</a> can be used to convert such dates to their Julian Day count. </p> </div> </div> <a name='function.juliantojd.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>month</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The month as a number from 1 (for January) to 12 (for December) </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>day</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The day as a number from 1 to 31 </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>year</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The year as a number between -4713 and 9999 </p> </dd> </dl> <p> </p> </div> <a name='function.juliantojd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The julian day for the given julian date as an integer. </p> </div> <a name='function.juliantojd.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.jdtojulian.php' class='function' rel='rdfs-seeAlso'>jdtojulian()</a> - Converts a Julian Day Count to a Julian Calendar Date</li> <li class='member'><a href='http://www.php.net/manual/en/function.cal-to-jd.php' class='function' rel='rdfs-seeAlso'>cal_to_jd()</a> - Converts from a supported calendar to Julian Day Count</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="jewishtojd" value="<div id='function.jewishtojd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.jewishtojd.php'>JewishToJD</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>JewishToJD</span> &amp;mdash; <span class='dc-title'>Converts a date in the Jewish Calendar to Julian Day Count</span></p> </div> <a name='function.jewishtojd.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>jewishtojd</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$month</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$day</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$year</tt></span> )</div> <p class='para rdfs-comment'> Although this function can handle dates all the way back to the year 1 (3761 B.C.), such use may not be meaningful. The Jewish calendar has been in use for several thousand years, but in the early days there was no formula to determine the start of a month. A new month was started when the new moon was first observed. </p> </div> <a name='function.jewishtojd.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>month</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The month as a number from 1 to 13 </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>day</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The day as a number from 1 to 30 </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>year</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The year as a number between 1 and 9999 </p> </dd> </dl> <p> </p> </div> <a name='function.jewishtojd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The julian day for the given jewish date as an integer. </p> </div> <a name='function.jewishtojd.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.jdtojewish.php' class='function' rel='rdfs-seeAlso'>jdtojewish()</a> - Converts a Julian day count to a Jewish calendar date</li> <li class='member'><a href='http://www.php.net/manual/en/function.cal-to-jd.php' class='function' rel='rdfs-seeAlso'>cal_to_jd()</a> - Converts from a supported calendar to Julian Day Count</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="jdtounix" value="<div id='function.jdtounix' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.jdtounix.php'>jdtounix</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>jdtounix</span> &amp;mdash; <span class='dc-title'>Convert Julian Day to Unix timestamp</span></p> </div> <a name='function.jdtounix.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>jdtounix</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$jday</tt></span> )</div> <p class='para rdfs-comment'> This function will return a Unix timestamp corresponding to the Julian Day given in <i><tt class='parameter'>jday</tt></i> or <b><tt class='constant'>FALSE</tt></b> if <i><tt class='parameter'>jday</tt></i> is not inside the Unix epoch (Gregorian years between 1970 and 2037 or 2440588 &amp;lt;= <i><tt class='parameter'>jday</tt></i> &amp;lt;= 2465342 ). The time returned is localtime (and not GMT). </p> </div> <a name='function.jdtounix.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>jday</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A julian day number between 2440588 and 2465342. </p> </dd> </dl> <p> </p> </div> <a name='function.jdtounix.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The unix timestamp for the start of the given julian day. </p> </div> <a name='function.jdtounix.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.unixtojd.php' class='function' rel='rdfs-seeAlso'>unixtojd()</a> - Convert Unix timestamp to Julian Day</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="jdtojulian" value="<div id='function.jdtojulian' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.jdtojulian.php'>JDToJulian</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>JDToJulian</span> &amp;mdash; <span class='dc-title'>Converts a Julian Day Count to a Julian Calendar Date</span></p> </div> <a name='function.jdtojulian.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>jdtojulian</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$julianday</tt></span> )</div> <p class='para rdfs-comment'> Converts Julian Day Count to a string containing the Julian Calendar Date in the format of &amp;quot;month/day/year&amp;quot;. </p> </div> <a name='function.jdtojulian.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>julianday</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A julian day number as integer </p> </dd> </dl> <p> </p> </div> <a name='function.jdtojulian.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The julian date as a string in the form &amp;quot;month/day/year&amp;quot; </p> </div> <a name='function.jdtojulian.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.juliantojd.php' class='function' rel='rdfs-seeAlso'>juliantojd()</a> - Converts a Julian Calendar date to Julian Day Count</li> <li class='member'><a href='http://www.php.net/manual/en/function.cal-from-jd.php' class='function' rel='rdfs-seeAlso'>cal_from_jd()</a> - Converts from Julian Day Count to a supported calendar</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="jdtojewish" value="<div id='function.jdtojewish' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.jdtojewish.php'>jdtojewish</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>jdtojewish</span> &amp;mdash; <span class='dc-title'>Converts a Julian day count to a Jewish calendar date</span></p> </div> <a name='function.jdtojewish.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>jdtojewish</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$juliandaycount</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$hebrew</tt><span class='initializer'> = false</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$fl</tt><span class='initializer'> = 0</span></span> ]] )</div> <p class='para rdfs-comment'> Converts a Julian Day Count to the Jewish Calendar. </p> </div> <a name='function.jdtojewish.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>julianday</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A julian day number as integer </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>hebrew</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If the <i><tt class='parameter'>hebrew</tt></i> parameter is set to <b><tt class='constant'>TRUE</tt></b>, the <i><tt class='parameter'>fl</tt></i> parameter is used for Hebrew, string based, output format. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fl</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The available formats are: <b><tt class='constant'>CAL_JEWISH_ADD_ALAFIM_GERESH</tt></b>, <b><tt class='constant'>CAL_JEWISH_ADD_ALAFIM</tt></b>, <b><tt class='constant'>CAL_JEWISH_ADD_GERESHAYIM</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.jdtojewish.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The jewish date as a string in the form &amp;quot;month/day/year&amp;quot; </p> </div> <a name='function.jdtojewish.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.0.0</td> <td align='left'> The <i><tt class='parameter'>fl</tt></i> parameter was added. </td> </tr> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> The <i><tt class='parameter'>hebrew</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.jdtojewish.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>jdtojewish()</b> Example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>jdtojewish</span><span style='color: #007700'>(</span><span style='color: #0000BB'>gregoriantojd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>8</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2002</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>CAL_JEWISH_ADD_GERESHAYIM&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>CAL_JEWISH_ADD_ALAFIM&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>CAL_JEWISH_ADD_ALAFIM_GERESH</span><span style='color: #007700'>);&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.jdtojewish.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.jewishtojd.php' class='function' rel='rdfs-seeAlso'>jewishtojd()</a> - Converts a date in the Jewish Calendar to Julian Day Count</li> <li class='member'><a href='http://www.php.net/manual/en/function.cal-from-jd.php' class='function' rel='rdfs-seeAlso'>cal_from_jd()</a> - Converts from Julian Day Count to a supported calendar</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="jdtogregorian" value="<div id='function.jdtogregorian' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.jdtogregorian.php'>JDToGregorian</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>JDToGregorian</span> &amp;mdash; <span class='dc-title'>Converts Julian Day Count to Gregorian date</span></p> </div> <a name='function.jdtogregorian.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>jdtogregorian</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$julianday</tt></span> )</div> <p class='para rdfs-comment'> Converts Julian Day Count to a string containing the Gregorian date in the format of &amp;quot;month/day/year&amp;quot;. </p> </div> <a name='function.jdtogregorian.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>julianday</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A julian day number as integer </p> </dd> </dl> <p> </p> </div> <a name='function.jdtogregorian.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The gregorian date as a string in the form &amp;quot;month/day/year&amp;quot; </p> </div> <a name='function.jdtogregorian.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.gregoriantojd.php' class='function' rel='rdfs-seeAlso'>gregoriantojd()</a> - Converts a Gregorian date to Julian Day Count</li> <li class='member'><a href='http://www.php.net/manual/en/function.cal-from-jd.php' class='function' rel='rdfs-seeAlso'>cal_from_jd()</a> - Converts from Julian Day Count to a supported calendar</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="jdtofrench" value="<div id='function.jdtofrench' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.jdtofrench.php'>JDToFrench</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>JDToFrench</span> &amp;mdash; <span class='dc-title'>Converts a Julian Day Count to the French Republican Calendar</span></p> </div> <a name='function.jdtofrench.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>jdtofrench</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$juliandaycount</tt></span> )</div> <p class='para rdfs-comment'> Converts a Julian Day Count to the French Republican Calendar. </p> </div> <a name='function.jdtofrench.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>julianday</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A julian day number as integer </p> </dd> </dl> <p> </p> </div> <a name='function.jdtofrench.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The french revolution date as a string in the form &amp;quot;month/day/year&amp;quot; </p> </div> <a name='function.jdtofrench.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.frenchtojd.php' class='function' rel='rdfs-seeAlso'>frenchtojd()</a> - Converts a date from the French Republican Calendar to a Julian Day Count</li> <li class='member'><a href='http://www.php.net/manual/en/function.cal-from-jd.php' class='function' rel='rdfs-seeAlso'>cal_from_jd()</a> - Converts from Julian Day Count to a supported calendar</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="jdmonthname" value="<div id='function.jdmonthname' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.jdmonthname.php'>JDMonthName</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>JDMonthName</span> &amp;mdash; <span class='dc-title'>Returns a month name</span></p> </div> <a name='function.jdmonthname.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>jdmonthname</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$julianday</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> )</div> <p class='para rdfs-comment'> Returns a string containing a month name. <i><tt class='parameter'>mode</tt></i> tells this function which calendar to convert the Julian Day Count to, and what type of month names are to be returned. </p><table class='doctable table'> <caption><b>Calendar modes</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Mode</th> <th>Meaning</th> <th>Values</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0</td> <td align='left'>Gregorian - abbreviated</td> <td align='left'>Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec</td> </tr> <tr valign='middle'> <td align='left'>1</td> <td align='left'>Gregorian</td> <td align='left'>January, February, March, April, May, June, July, August, September, October, November, December</td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'>Julian - abbreviated</td> <td align='left'>Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec</td> </tr> <tr valign='middle'> <td align='left'>3</td> <td align='left'>Julian</td> <td align='left'>January, February, March, April, May, June, July, August, September, October, November, December</td> </tr> <tr valign='middle'> <td align='left'>4</td> <td align='left'>Jewish</td> <td align='left'>Tishri, Heshvan, Kislev, Tevet, Shevat, AdarI, AdarII, Nisan, Iyyar, Sivan, Tammuz, Av, Elul</td> </tr> <tr valign='middle'> <td align='left'>5</td> <td align='left'>French Republican</td> <td align='left'>Vendemiaire, Brumaire, Frimaire, Nivose, Pluviose, Ventose, Germinal, Floreal, Prairial, Messidor, Thermidor, Fructidor, Extra</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.jdmonthname.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>jday</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The Julian Day to operate on </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>calendar</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The calendar to take the month name from </p> </dd> </dl> <p> </p> </div> <a name='function.jdmonthname.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The month name for the given Julian Day and <i><tt class='parameter'>calendar</tt></i> . </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="jddayofweek" value="<div id='function.jddayofweek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.jddayofweek.php'>JDDayOfWeek</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>JDDayOfWeek</span> &amp;mdash; <span class='dc-title'>Returns the day of the week</span></p> </div> <a name='function.jddayofweek.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>jddayofweek</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$julianday</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt><span class='initializer'> = CAL_DOW_DAYNO</span></span> ] )</div> <p class='para rdfs-comment'> Returns the day of the week. Can return a string or an integer depending on the mode. </p> </div> <a name='function.jddayofweek.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>julianday</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A julian day number as integer </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <table class='doctable table'> <caption><b>Calendar week modes</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Mode</th> <th>Meaning</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0 (Default)</td> <td align='left'> Return the day number as an int (0=Sunday, 1=Monday, etc) </td> </tr> <tr valign='middle'> <td align='left'>1</td> <td align='left'> Returns string containing the day of week (English-Gregorian) </td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'> Return a string containing the abbreviated day of week (English-Gregorian) </td> </tr> </tbody> </table> </dd> </dl> <p> </p> </div> <a name='function.jddayofweek.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The gregorian weekday as either an integer or string. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_utf8" value="<div id='function.imap-utf8' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-utf8.php'>imap_utf8</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_utf8</span> &amp;mdash; <span class='dc-title'>Converts MIME-encoded text to UTF-8</span></p> </div> <a name='function.imap-utf8.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_utf8</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mime_encoded_text</tt></span> )</div> <p class='para rdfs-comment'> Converts the given <i><tt class='parameter'>mime_encoded_text</tt></i> to UTF-8. </p> </div> <a name='function.imap-utf8.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mime_encoded_text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A MIME encoded string. MIME encoding method and the UTF-8 specification are described in <a href='http://www.faqs.org/rfcs/rfc2047' class='link external'>&amp;raquo; RFC2047</a> and <a href='http://www.faqs.org/rfcs/rfc2044' class='link external'>&amp;raquo; RFC2044</a> respectively. </p> </dd> </dl> <p> </p> </div> <a name='function.imap-utf8.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an UTF-8 encoded string. </p> </div> <a name='function.imap-utf8.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-mime-header-decode.php' class='function' rel='rdfs-seeAlso'>imap_mime_header_decode()</a> - Decode MIME header elements</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_utf7_encode" value="<div id='function.imap-utf7-encode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-utf7-encode.php'>imap_utf7_encode</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_utf7_encode</span> &amp;mdash; <span class='dc-title'>Converts ISO-8859-1 string to modified UTF-7 text</span></p> </div> <a name='function.imap-utf7-encode.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_utf7_encode</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> )</div> <p class='para rdfs-comment'> Converts <i><tt class='parameter'>data</tt></i> to modified UTF-7 text. </p> <p class='para'> This is needed to encode mailbox names that contain certain characters which are not in range of printable ASCII characters. </p> </div> <a name='function.imap-utf7-encode.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An ISO-8859-1 string. </p> </dd> </dl> <p> </p> </div> <a name='function.imap-utf7-encode.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <i><tt class='parameter'>data</tt></i> encoded with the modified UTF-7 encoding as defined in <a href='http://www.faqs.org/rfcs/rfc2060' class='link external'>&amp;raquo; RFC 2060</a>, section 5.1.3 (original UTF-7 was defined in <a href='http://www.faqs.org/rfcs/rfc1642' class='link external'>&amp;raquo; RFC1642</a>). </p> </div> <a name='function.imap-utf7-encode.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-utf7-decode.php' class='function' rel='rdfs-seeAlso'>imap_utf7_decode()</a> - Decodes a modified UTF-7 encoded string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_utf7_decode" value="<div id='function.imap-utf7-decode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-utf7-decode.php'>imap_utf7_decode</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_utf7_decode</span> &amp;mdash; <span class='dc-title'>Decodes a modified UTF-7 encoded string</span></p> </div> <a name='function.imap-utf7-decode.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_utf7_decode</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text</tt></span> )</div> <p class='para rdfs-comment'> Decodes modified UTF-7 <i><tt class='parameter'>text</tt></i> into ISO-8859-1 string. </p> <p class='para'> This function is needed to decode mailbox names that contain certain characters which are not in range of printable ASCII characters. </p> </div> <a name='function.imap-utf7-decode.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A modified UTF-7 encoding string, as defined in <a href='http://www.faqs.org/rfcs/rfc2060' class='link external'>&amp;raquo; RFC 2060</a>, section 5.1.3 (original UTF-7 was defined in <a href='http://www.faqs.org/rfcs/rfc1642' class='link external'>&amp;raquo; RFC1642</a>). </p> </dd> </dl> <p> </p> </div> <a name='function.imap-utf7-decode.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string that is encoded in ISO-8859-1 and consists of the same sequence of characters in <i><tt class='parameter'>text</tt></i> , or <b><tt class='constant'>FALSE</tt></b> if <i><tt class='parameter'>text</tt></i> contains invalid modified UTF-7 sequence or <i><tt class='parameter'>text</tt></i> contains a character that is not part of ISO-8859-1 character set. </p> </div> <a name='function.imap-utf7-decode.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-utf7-encode.php' class='function' rel='rdfs-seeAlso'>imap_utf7_encode()</a> - Converts ISO-8859-1 string to modified UTF-7 text</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_unsubscribe" value="<div id='function.imap-unsubscribe' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-unsubscribe.php'>imap_unsubscribe</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_unsubscribe</span> &amp;mdash; <span class='dc-title'>Unsubscribe from a mailbox</span></p> </div> <a name='function.imap-unsubscribe.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_unsubscribe</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> )</div> <p class='para rdfs-comment'> Unsubscribe from the specified <i><tt class='parameter'>mailbox</tt></i> . </p> </div> <a name='function.imap-unsubscribe.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> </dl> <p> </p> </div> <a name='function.imap-unsubscribe.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-unsubscribe.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-subscribe.php' class='function' rel='rdfs-seeAlso'>imap_subscribe()</a> - Subscribe to a mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_undelete" value="<div id='function.imap-undelete' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-undelete.php'>imap_undelete</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_undelete</span> &amp;mdash; <span class='dc-title'>Unmark the message which is marked deleted</span></p> </div> <a name='function.imap-undelete.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_undelete</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$msg_number</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Removes the deletion flag for a specified message, which is set by <a href='http://www.php.net/manual/en/function.imap-delete.php' class='function'>imap_delete()</a> or <a href='http://www.php.net/manual/en/function.imap-mail-move.php' class='function'>imap_mail_move()</a>. </p> </div> <a name='function.imap-undelete.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msg_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message number </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-undelete.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-undelete.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-delete.php' class='function' rel='rdfs-seeAlso'>imap_delete()</a> - Mark a message for deletion from current mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-mail-move.php' class='function' rel='rdfs-seeAlso'>imap_mail_move()</a> - Move specified messages to a mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_uid" value="<div id='function.imap-uid' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-uid.php'>imap_uid</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_uid</span> &amp;mdash; <span class='dc-title'>This function returns the UID for the given message sequence number</span></p> </div> <a name='function.imap-uid.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>imap_uid</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$msg_number</tt></span> )</div> <p class='para rdfs-comment'> This function returns the UID for the given message sequence number. An UID is a unique identifier that will not change over time while a message sequence number may change whenever the content of the mailbox changes. </p> <p class='para'> This function is the inverse of <a href='http://www.php.net/manual/en/function.imap-msgno.php' class='function'>imap_msgno()</a>. </p> </div> <a name='function.imap-uid.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msg_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message number. </p> </dd> </dl> <p> </p> </div> <a name='function.imap-uid.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The UID of the given message. </p> </div> <a name='function.imap-uid.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function is not supported by POP3 mailboxes. <br /> </p></blockquote> </div> <a name='function.imap-uid.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-msgno.php' class='function' rel='rdfs-seeAlso'>imap_msgno()</a> - Gets the message sequence number for the given UID</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_timeout" value="<div id='function.imap-timeout' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-timeout.php'>imap_timeout</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.3, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_timeout</span> &amp;mdash; <span class='dc-title'>Set or fetch imap timeout</span></p> </div> <a name='function.imap-timeout.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>imap_timeout</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timeout_type</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timeout</tt><span class='initializer'> = -1</span></span> ] )</div> <p class='para rdfs-comment'> Sets or fetches the imap timeout. </p> </div> <a name='function.imap-timeout.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timeout_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> One of the following: <b><tt class='constant'>IMAP_OPENTIMEOUT</tt></b>, <b><tt class='constant'>IMAP_READTIMEOUT</tt></b>, <b><tt class='constant'>IMAP_WRITETIMEOUT</tt></b>, or <b><tt class='constant'>IMAP_CLOSETIMEOUT</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timeout</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The timeout, in seconds. </p> </dd> </dl> <p> </p> </div> <a name='function.imap-timeout.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If the <i><tt class='parameter'>timeout</tt></i> parameter is set, this function returns <b><tt class='constant'>TRUE</tt></b> on success and <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> If <i><tt class='parameter'>timeout</tt></i> is not provided or evaluates to -1, the current timeout value of <i><tt class='parameter'>timeout_type</tt></i> is returned as an integer. </p> </div> <a name='function.imap-timeout.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_timeout()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;current&amp;nbsp;read&amp;nbsp;timeout&amp;nbsp;is&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_timeout</span><span style='color: #007700'>(</span><span style='color: #0000BB'>IMAP_READTIMEOUT</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_thread" value="<div id='function.imap-thread' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-thread.php'>imap_thread</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_thread</span> &amp;mdash; <span class='dc-title'>Returns a tree of threaded message</span></p> </div> <a name='function.imap-thread.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_thread</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = SE_FREE</span></span> ] )</div> <p class='para rdfs-comment'> Gets a tree of a threaded message. </p> </div> <a name='function.imap-thread.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-thread.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>imap_thread()</b> returns an associative array containing a tree of messages threaded by <i>REFERENCES</i>, or <b><tt class='constant'>FALSE</tt></b> on error. </p> <p class='para'> Every message in the current mailbox will be represented by three entries in the resulting array: </p><ul class='itemizedlist'> <li class='listitem'><p class='para'> <var class='varname'>$thread['XX.num']</var> - current message number </p></li> <li class='listitem'><p class='para'> <var class='varname'>$thread['XX.next']</var> </p></li> <li class='listitem'><p class='para'> <var class='varname'>$thread['XX.branch']</var> </p></li> </ul><p> </p> </div> <a name='function.imap-thread.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_thread()</b> Example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Here&amp;nbsp;we're&amp;nbsp;outputting&amp;nbsp;the&amp;nbsp;threads&amp;nbsp;of&amp;nbsp;a&amp;nbsp;newsgroup,&amp;nbsp;in&amp;nbsp;HTML<br /><br /></span><span style='color: #0000BB'>$nntp&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{news.example.com:119/nntp}some.newsgroup'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$threads&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_thread</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$nntp</span><span style='color: #007700'>);<br /><br />foreach&amp;nbsp;(</span><span style='color: #0000BB'>$threads&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$key&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$tree&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>explode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$key</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$tree</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]&amp;nbsp;==&amp;nbsp;</span><span style='color: #DD0000'>'num'</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$header&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_headerinfo</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$nntp</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;ul&amp;gt;\n\t&amp;lt;li&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$header</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fromaddress&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;elseif&amp;nbsp;(</span><span style='color: #0000BB'>$tree</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]&amp;nbsp;==&amp;nbsp;</span><span style='color: #DD0000'>'branch'</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\t&amp;lt;/li&amp;gt;\n&amp;lt;/ul&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$nntp</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_subscribe" value="<div id='function.imap-subscribe' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-subscribe.php'>imap_subscribe</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_subscribe</span> &amp;mdash; <span class='dc-title'>Subscribe to a mailbox</span></p> </div> <a name='function.imap-subscribe.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_subscribe</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> )</div> <p class='para rdfs-comment'> Subscribe to a new mailbox. </p> </div> <a name='function.imap-subscribe.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> </dl> <p> </p> </div> <a name='function.imap-subscribe.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-subscribe.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-unsubscribe.php' class='function' rel='rdfs-seeAlso'>imap_unsubscribe()</a> - Unsubscribe from a mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_status" value="<div id='function.imap-status' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-status.php'>imap_status</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_status</span> &amp;mdash; <span class='dc-title'>Returns status information on a mailbox</span></p> </div> <a name='function.imap-status.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>imap_status</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt></span> )</div> <p class='para rdfs-comment'> Gets status information about the given <i><tt class='parameter'>mailbox</tt></i> . </p> </div> <a name='function.imap-status.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Valid flags are: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SA_MESSAGES</tt></b> - set <var class='varname'>$status->messages</var> to the number of messages in the mailbox </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SA_RECENT</tt></b> - set <var class='varname'>$status->recent</var> to the number of recent messages in the mailbox </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SA_UNSEEN</tt></b> - set <var class='varname'>$status->unseen</var> to the number of unseen (new) messages in the mailbox </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SA_UIDNEXT</tt></b> - set <var class='varname'>$status->uidnext</var> to the next uid to be used in the mailbox </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SA_UIDVALIDITY</tt></b> - set <var class='varname'>$status->uidvalidity</var> to a constant that changes when uids for the mailbox may no longer be valid </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SA_ALL</tt></b> - set all of the above </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-status.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> This function returns an object containing status information. The object has the following properties: <i>messages</i>, <i>recent</i>, <i>unseen</i>, <i>uidnext</i>, and <i>uidvalidity</i>. </p> <p class='para'> <i>flags</i> is also set, which contains a bitmask which can be checked against any of the above constants. </p> </div> <a name='function.imap-status.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_status()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.com}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OP_HALFOPEN</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$status&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_status</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'{imap.example.org}INBOX'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SA_ALL</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Messages:&amp;nbsp;&amp;nbsp;&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>messages&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Recent:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>recent&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unseen:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>unseen&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'UIDnext:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>uidnext&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'UIDvalidity:'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>uidvalidity&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'imap_status&amp;nbsp;failed:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_sort" value="<div id='function.imap-sort' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-sort.php'>imap_sort</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_sort</span> &amp;mdash; <span class='dc-title'>Gets and sort messages</span></p> </div> <a name='function.imap-sort.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_sort</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$criteria</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$reverse</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$search_criteria</tt><span class='initializer'> = NULL</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt><span class='initializer'> = NIL</span></span> ]]] )</div> <p class='para rdfs-comment'> Gets and sorts message numbers by the given parameters. </p> </div> <a name='function.imap-sort.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>criteria</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Criteria can be one (and only one) of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SORTDATE</tt></b> - message Date </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SORTARRIVAL</tt></b> - arrival date </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SORTFROM</tt></b> - mailbox in first From address </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SORTSUBJECT</tt></b> - message subject </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SORTTO</tt></b> - mailbox in first To address </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SORTCC</tt></b> - mailbox in first cc address </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SORTSIZE</tt></b> - size of message in octets </span> </li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>reverse</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Set this to 1 for reverse sorting </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>options</tt></i> are a bitmask of one or more of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SE_UID</tt></b> - Return UIDs instead of sequence numbers </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>SE_NOPREFETCH</tt></b> - Don&amp;#039;t prefetch searched messages </span> </li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>search_criteria</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-sort.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of message numbers sorted by the given parameters. </p> </div> <a name='function.imap-sort.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.3</td> <td align='left'> The <i><tt class='parameter'>charset</tt></i> parameter was added </td> </tr> </tbody> </table> <p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_setflag_full" value="<div id='function.imap-setflag-full' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-setflag-full.php'>imap_setflag_full</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_setflag_full</span> &amp;mdash; <span class='dc-title'>Sets flags on messages</span></p> </div> <a name='function.imap-setflag-full.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_setflag_full</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$sequence</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$flag</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = NIL</span></span> ] )</div> <p class='para rdfs-comment'> Causes a store to add the specified <i><tt class='parameter'>flag</tt></i> to the flags set for the messages in the specified <i><tt class='parameter'>sequence</tt></i> . </p> </div> <a name='function.imap-setflag-full.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>sequence</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A sequence of message numbers. You can enumerate desired messages with the <i>X,Y</i> syntax, or retrieve all messages within an interval with the <i>X:Y</i> syntax </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flag</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The flags which you can set are <i>\Seen</i>, <i>\Answered</i>, <i>\Flagged</i>, <i>\Deleted</i>, and <i>\Draft</i> as defined by <a href='http://www.faqs.org/rfcs/rfc2060' class='link external'>&amp;raquo; RFC2060</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A bit mask that may contain the single option: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>ST_UID</tt></b> - The sequence argument contains UIDs instead of sequence numbers </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-setflag-full.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-setflag-full.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_setflag_full()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org:143}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$status&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_setflag_full</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'2,5'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\\Seen&amp;nbsp;\\Flagged'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>gettype</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$status&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imap-setflag-full.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-clearflag-full.php' class='function' rel='rdfs-seeAlso'>imap_clearflag_full()</a> - Clears flags on messages</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_setacl" value="<div id='function.imap-setacl' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-setacl.php'>imap_setacl</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_setacl</span> &amp;mdash; <span class='dc-title'>Sets the ACL for a giving mailbox</span></p> </div> <a name='function.imap-setacl.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_setacl</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$rights</tt></span> )</div> <p class='para rdfs-comment'> Sets the ACL for a giving mailbox. </p> </div> <a name='function.imap-setacl.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The user to give the rights to. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>rights</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The rights to give to the user. Passing an empty string will delete acl. </p> </dd> </dl> <p> </p> </div> <a name='function.imap-setacl.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-setacl.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <p class='para'> This function is currently only available to users of the c-client2000 or greater library. </p> </div> <a name='function.imap-setacl.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-getacl.php' class='function' rel='rdfs-seeAlso'>imap_getacl()</a> - Gets the ACL for a given mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_set_quota" value="<div id='function.imap-set-quota' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-set-quota.php'>imap_set_quota</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_set_quota</span> &amp;mdash; <span class='dc-title'>Sets a quota for a given mailbox</span></p> </div> <a name='function.imap-set-quota.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_set_quota</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$quota_root</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$quota_limit</tt></span> )</div> <p class='para rdfs-comment'> Sets an upper limit quota on a per mailbox basis. </p> </div> <a name='function.imap-set-quota.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>quota_root</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox to have a quota set. This should follow the IMAP standard format for a mailbox: <i>user.name</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>quota_limit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The maximum size (in KB) for the <i><tt class='parameter'>quota_root</tt></i> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-set-quota.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-set-quota.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_set_quota()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org:143}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mailadmin'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>imap_set_quota</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user.kalowsky'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3000</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Error&amp;nbsp;in&amp;nbsp;setting&amp;nbsp;quota\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return;<br />}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imap-set-quota.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <p class='para'> This function is currently only available to users of the c-client2000 or greater library. </p> <p class='para'> The given <i><tt class='parameter'>imap_stream</tt></i> must be opened as the mail administrator, other wise this function will fail. </p> </div> <a name='function.imap-set-quota.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-open.php' class='function' rel='rdfs-seeAlso'>imap_open()</a> - Open an IMAP stream to a mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-get-quota.php' class='function' rel='rdfs-seeAlso'>imap_get_quota()</a> - Retrieve the quota level settings, and usage statics per mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_search" value="<div id='function.imap-search' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-search.php'>imap_search</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_search</span> &amp;mdash; <span class='dc-title'>This function returns an array of messages matching the given search criteria</span></p> </div> <a name='function.imap-search.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_search</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$criteria</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = SE_FREE</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt><span class='initializer'> = NIL</span></span> ]] )</div> <p class='para rdfs-comment'> This function performs a search on the mailbox currently opened in the given <acronym title='Internet Message Access Protocol'>IMAP</acronym> stream. </p> <p class='para'> For example, to match all unanswered messages sent by Mom, you&amp;#039;d use: &amp;quot;UNANSWERED FROM mom&amp;quot;. Searches appear to be case insensitive. This list of criteria is from a reading of the UW c-client source code and may be incomplete or inaccurate (see also <a href='http://www.faqs.org/rfcs/rfc2060' class='link external'>&amp;raquo; RFC2060</a>, section 6.4.4). </p> </div> <a name='function.imap-search.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>criteria</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A string, delimited by spaces, in which the following keywords are allowed. Any multi-word arguments (e.g. <i>FROM &amp;quot;joey smith&amp;quot;</i>) must be quoted. </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> ALL - return all messages matching the rest of the criteria </span> </li> <li class='listitem'> <span class='simpara'> ANSWERED - match messages with the \\ANSWERED flag set </span> </li> <li class='listitem'> <span class='simpara'> BCC &amp;quot;string&amp;quot; - match messages with &amp;quot;string&amp;quot; in the Bcc: field </span> </li> <li class='listitem'> <span class='simpara'> BEFORE &amp;quot;date&amp;quot; - match messages with Date: before &amp;quot;date&amp;quot; </span> </li> <li class='listitem'> <span class='simpara'> BODY &amp;quot;string&amp;quot; - match messages with &amp;quot;string&amp;quot; in the body of the message </span> </li> <li class='listitem'> <span class='simpara'> CC &amp;quot;string&amp;quot; - match messages with &amp;quot;string&amp;quot; in the Cc: field </span> </li> <li class='listitem'> <span class='simpara'> DELETED - match deleted messages </span> </li> <li class='listitem'> <span class='simpara'> FLAGGED - match messages with the \\FLAGGED (sometimes referred to as Important or Urgent) flag set </span> </li> <li class='listitem'> <span class='simpara'> FROM &amp;quot;string&amp;quot; - match messages with &amp;quot;string&amp;quot; in the From: field </span> </li> <li class='listitem'> <span class='simpara'> KEYWORD &amp;quot;string&amp;quot; - match messages with &amp;quot;string&amp;quot; as a keyword </span> </li> <li class='listitem'> <span class='simpara'> NEW - match new messages </span> </li> <li class='listitem'> <span class='simpara'> OLD - match old messages </span> </li> <li class='listitem'> <span class='simpara'> ON &amp;quot;date&amp;quot; - match messages with Date: matching &amp;quot;date&amp;quot; </span> </li> <li class='listitem'> <span class='simpara'> RECENT - match messages with the \\RECENT flag set </span> </li> <li class='listitem'> <span class='simpara'> SEEN - match messages that have been read (the \\SEEN flag is set) </span> </li> <li class='listitem'> <span class='simpara'> SINCE &amp;quot;date&amp;quot; - match messages with Date: after &amp;quot;date&amp;quot; </span> </li> <li class='listitem'> <span class='simpara'> SUBJECT &amp;quot;string&amp;quot; - match messages with &amp;quot;string&amp;quot; in the Subject: </span> </li> <li class='listitem'> <span class='simpara'> TEXT &amp;quot;string&amp;quot; - match messages with text &amp;quot;string&amp;quot; </span> </li> <li class='listitem'> <span class='simpara'> TO &amp;quot;string&amp;quot; - match messages with &amp;quot;string&amp;quot; in the To: </span> </li> <li class='listitem'> <span class='simpara'> UNANSWERED - match messages that have not been answered </span> </li> <li class='listitem'> <span class='simpara'> UNDELETED - match messages that are not deleted </span> </li> <li class='listitem'> <span class='simpara'> UNFLAGGED - match messages that are not flagged </span> </li> <li class='listitem'> <span class='simpara'> UNKEYWORD &amp;quot;string&amp;quot; - match messages that do not have the keyword &amp;quot;string&amp;quot; </span> </li> <li class='listitem'> <span class='simpara'> UNSEEN - match messages which have not been read yet </span> </li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Valid values for <i><tt class='parameter'>options</tt></i> are <b><tt class='constant'>SE_UID</tt></b>, which causes the returned array to contain UIDs instead of messages sequence numbers. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-search.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of message numbers or UIDs. </p> <p class='para'> Return <b><tt class='constant'>FALSE</tt></b> if it does not understand the search <i><tt class='parameter'>criteria</tt></i> or no messages have been found. </p> </div> <a name='function.imap-search.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.3</td> <td align='left'> The <i><tt class='parameter'>charset</tt></i> parameter was added </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imap-search.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-listscan.php' class='function' rel='rdfs-seeAlso'>imap_listscan()</a> - Returns the list of mailboxes that matches the given text</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_scanmailbox" value="<div id='function.imap-scanmailbox' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-scanmailbox.php'>imap_scanmailbox</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_scanmailbox</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.imap-listscan.php' class='function'>imap_listscan()</a></span></p> </div> <a name='function.imap-scanmailbox.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.imap-listscan.php' class='function'>imap_listscan()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_savebody" value="<div id='function.imap-savebody' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-savebody.php'>imap_savebody</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.3)</p><p class='refpurpose'><span class='refname'>imap_savebody</span> &amp;mdash; <span class='dc-title'>Save a specific body section to a file</span></p> </div> <a name='function.imap-savebody.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_savebody</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$file</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$msg_number</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$part_number</tt><span class='initializer'> = &amp;quot;&amp;quot;</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ]] )</div> <p class='para rdfs-comment'> Saves a part or the whole body of the specified message. </p> </div> <a name='function.imap-savebody.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path to the saved file as a string, or a valid file descriptor returned by <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msg_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message number </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>part_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The part number. It is a string of integers delimited by period which index into a body part list as per the IMAP4 specification </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A bitmask with one or more of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_UID</tt></b> - The <i><tt class='parameter'>msg_number</tt></i> is a UID </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_PEEK</tt></b> - Do not set the \Seen flag if not already set </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_INTERNAL</tt></b> - The return string is in internal format, will not canonicalize to CRLF. </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-savebody.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-savebody.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-fetchbody.php' class='function' rel='rdfs-seeAlso'>imap_fetchbody()</a> - Fetch a particular section of the body of the message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_rfc822_write_address" value="<div id='function.imap-rfc822-write-address' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-rfc822-write-address.php'>imap_rfc822_write_address</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_rfc822_write_address</span> &amp;mdash; <span class='dc-title'>Returns a properly formatted email address given the mailbox, host, and personal info</span></p> </div> <a name='function.imap-rfc822-write-address.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_rfc822_write_address</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$host</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$personal</tt></span> )</div> <p class='para rdfs-comment'> Returns a properly formatted email address as defined in <a href='http://www.faqs.org/rfcs/rfc2822' class='link external'>&amp;raquo; RFC2822</a> given the needed information. </p> </div> <a name='function.imap-rfc822-write-address.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>host</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The email host part </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>personal</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the account owner </p> </dd> </dl> <p> </p> </div> <a name='function.imap-rfc822-write-address.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string properly formatted email address as defined in <a href='http://www.faqs.org/rfcs/rfc2822' class='link external'>&amp;raquo; RFC2822</a>. </p> </div> <a name='function.imap-rfc822-write-address.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_rfc822_write_address()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>imap_rfc822_write_address</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'hartmut'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'example.com'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Hartmut&amp;nbsp;Holzgraefe'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Hartmut Holzgraefe &amp;lt;hartmut@example.com&amp;gt; </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_rfc822_parse_headers" value="<div id='function.imap-rfc822-parse-headers' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-rfc822-parse-headers.php'>imap_rfc822_parse_headers</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_rfc822_parse_headers</span> &amp;mdash; <span class='dc-title'>Parse mail headers from a string</span></p> </div> <a name='function.imap-rfc822-parse-headers.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>imap_rfc822_parse_headers</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$headers</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$defaulthost</tt><span class='initializer'> = &amp;quot;UNKNOWN&amp;quot;</span></span> ] )</div> <p class='para rdfs-comment'> Gets an object of various header elements, similar to <a href='http://www.php.net/manual/en/function.imap-header.php' class='function'>imap_header()</a>. </p> </div> <a name='function.imap-rfc822-parse-headers.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>headers</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The parsed headers data </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>defaulthost</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The default host name </p> </dd> </dl> <p> </p> </div> <a name='function.imap-rfc822-parse-headers.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object similar to the one returned by <a href='http://www.php.net/manual/en/function.imap-header.php' class='function'>imap_header()</a>, except for the flags and other properties that come from the IMAP server. </p> </div> <a name='function.imap-rfc822-parse-headers.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-rfc822-parse-adrlist.php' class='function' rel='rdfs-seeAlso'>imap_rfc822_parse_adrlist()</a> - Parses an address string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_rfc822_parse_adrlist" value="<div id='function.imap-rfc822-parse-adrlist' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-rfc822-parse-adrlist.php'>imap_rfc822_parse_adrlist</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_rfc822_parse_adrlist</span> &amp;mdash; <span class='dc-title'>Parses an address string</span></p> </div> <a name='function.imap-rfc822-parse-adrlist.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_rfc822_parse_adrlist</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$address</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$default_host</tt></span> )</div> <p class='para rdfs-comment'> Parses the address string as defined in <a href='http://www.faqs.org/rfcs/rfc2822' class='link external'>&amp;raquo; RFC2822</a> and for each address. </p> </div> <a name='function.imap-rfc822-parse-adrlist.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>address</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A string containing addresses </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>default_host</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The default host name </p> </dd> </dl> <p> </p> </div> <a name='function.imap-rfc822-parse-adrlist.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of objects. The objects properties are: </p> <p class='para'> </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> mailbox - the mailbox name (username) </span> </li> <li class='listitem'> <span class='simpara'> host - the host name </span> </li> <li class='listitem'> <span class='simpara'> personal - the personal name </span> </li> <li class='listitem'> <span class='simpara'> adl - at domain source route </span> </li> </ul><p> </p> </div> <a name='function.imap-rfc822-parse-adrlist.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_rfc822_parse_adrlist()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$address_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Joe&amp;nbsp;Doe&amp;nbsp;&amp;lt;doe@example.com&amp;gt;,&amp;nbsp;postmaster@example.com,&amp;nbsp;root'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$address_array&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_rfc822_parse_adrlist</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$address_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'example.com'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>is_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$address_array</span><span style='color: #007700'>)&amp;nbsp;||&amp;nbsp;</span><span style='color: #0000BB'>count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$address_array</span><span style='color: #007700'>)&amp;nbsp;&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'something&amp;nbsp;is&amp;nbsp;wrong\n'</span><span style='color: #007700'>);<br />}<br /><br />foreach&amp;nbsp;(</span><span style='color: #0000BB'>$address_array&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$id&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'#&amp;nbsp;</span><span style='color: #0000BB'>$id</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;nbsp;mailbox&amp;nbsp;:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>mailbox&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;nbsp;host&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>host&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;nbsp;personal:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>personal&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;nbsp;adl&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>adl&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> # 0 mailbox : doe host : example.com personal: Joe Doe adl : # 1 mailbox : postmaster host : example.com personal: adl : # 2 mailbox : root host : example.com personal: adl : </pre></div> </div> </div><p> </p> </div> <a name='function.imap-rfc822-parse-adrlist.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-rfc822-parse-headers.php' class='function' rel='rdfs-seeAlso'>imap_rfc822_parse_headers()</a> - Parse mail headers from a string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_reopen" value="<div id='function.imap-reopen' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-reopen.php'>imap_reopen</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_reopen</span> &amp;mdash; <span class='dc-title'>Reopen <acronym title='Internet Message Access Protocol'>IMAP</acronym> stream to new mailbox</span></p> </div> <a name='function.imap-reopen.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_reopen</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$n_retries</tt><span class='initializer'> = 0</span></span> ]] )</div> <p class='para rdfs-comment'> Reopens the specified stream to a new <i><tt class='parameter'>mailbox</tt></i> on an <acronym title='Internet Message Access Protocol'>IMAP</acronym> or <acronym title='Network News Transfer Protocol'>NNTP</acronym> server. </p> </div> <a name='function.imap-reopen.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>options</tt></i> are a bit mask with one or more of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_READONLY</tt></b> - Open mailbox read-only </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_ANONYMOUS</tt></b> - Don&amp;#039;t use or update a <var class='filename'>.newsrc</var> for news (<acronym title='Network News Transfer Protocol'>NNTP</acronym> only) </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_HALFOPEN</tt></b> - For <acronym title='Internet Message Access Protocol'>IMAP</acronym> and <acronym title='Network News Transfer Protocol'>NNTP</acronym> names, open a connection but don&amp;#039;t open a mailbox. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_EXPUNGE</tt></b> - Silently expunge recycle stream </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>CL_EXPUNGE</tt></b> - Expunge mailbox automatically upon mailbox close (see also <a href='http://www.php.net/manual/en/function.imap-delete.php' class='function'>imap_delete()</a> and <a href='http://www.php.net/manual/en/function.imap-expunge.php' class='function'>imap_expunge()</a>) </span> </li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>n_retries</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Number of maximum connect attempts </p> </dd> </dl> <p> </p> </div> <a name='function.imap-reopen.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-reopen.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.2.0</td> <td align='left'><i><tt class='parameter'>n_retries</tt></i> added</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imap-reopen.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_reopen()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org:143}INBOX'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #0000BB'>implode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>',&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imap_errors</span><span style='color: #007700'>()));<br /></span><span style='color: #FF8000'>//&amp;nbsp;...<br /></span><span style='color: #0000BB'>imap_reopen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'{imap.example.org:143}INBOX.Sent'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #0000BB'>implode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>',&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imap_errors</span><span style='color: #007700'>()));<br /></span><span style='color: #FF8000'>//&amp;nbsp;..<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_renamemailbox" value="<div id='function.imap-renamemailbox' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-renamemailbox.php'>imap_renamemailbox</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_renamemailbox</span> &amp;mdash; <span class='dc-title'>Rename an old mailbox to new mailbox</span></p> </div> <a name='function.imap-renamemailbox.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_renamemailbox</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$old_mbox</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$new_mbox</tt></span> )</div> <p class='para rdfs-comment'> This function renames on old mailbox to new mailbox (see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for the format of <i><tt class='parameter'>mbox</tt></i> names). </p> </div> <a name='function.imap-renamemailbox.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>old_mbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The old mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>new_mbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> </dl> <p> </p> </div> <a name='function.imap-renamemailbox.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-renamemailbox.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-createmailbox.php' class='function' rel='rdfs-seeAlso'>imap_createmailbox()</a> - Create a new mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-deletemailbox.php' class='function' rel='rdfs-seeAlso'>imap_deletemailbox()</a> - Delete a mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_qprint" value="<div id='function.imap-qprint' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-qprint.php'>imap_qprint</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_qprint</span> &amp;mdash; <span class='dc-title'>Convert a quoted-printable string to an 8 bit string</span></p> </div> <a name='function.imap-qprint.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_qprint</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> )</div> <p class='para rdfs-comment'> Convert a quoted-printable string to an 8 bit string according to <a href='http://www.faqs.org/rfcs/rfc2045' class='link external'>&amp;raquo; RFC2045</a>, section 6.7. </p> </div> <a name='function.imap-qprint.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A quoted-printable string </p> </dd> </dl> <p> </p> </div> <a name='function.imap-qprint.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an 8 bits string. </p> </div> <a name='function.imap-qprint.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-8bit.php' class='function' rel='rdfs-seeAlso'>imap_8bit()</a> - Convert an 8bit string to a quoted-printable string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_ping" value="<div id='function.imap-ping' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-ping.php'>imap_ping</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_ping</span> &amp;mdash; <span class='dc-title'>Check if the IMAP stream is still active</span></p> </div> <a name='function.imap-ping.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_ping</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> )</div> <p class='para rdfs-comment'> <b>imap_ping()</b> pings the stream to see if it&amp;#039;s still active. It may discover new mail; this is the preferred method for a periodic &amp;quot;new mail check&amp;quot; as well as a &amp;quot;keep alive&amp;quot; for servers which have inactivity timeout. </p> </div> <a name='function.imap-ping.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imap-ping.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the stream is still alive, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.imap-ping.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_ping()</b> Example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$imap&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mailadmin'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;after&amp;nbsp;some&amp;nbsp;sleeping<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>imap_ping</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imap</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;do&amp;nbsp;some&amp;nbsp;stuff&amp;nbsp;to&amp;nbsp;reconnect<br /></span><span style='color: #007700'>}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_open" value="<div id='function.imap-open' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-open.php'>imap_open</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_open</span> &amp;mdash; <span class='dc-title'>Open an <acronym title='Internet Message Access Protocol'>IMAP</acronym> stream to a mailbox</span></p> </div> <a name='function.imap-open.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>imap_open</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = NIL</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$n_retries</tt><span class='initializer'> = 0</span></span> ]] )</div> <p class='para rdfs-comment'> Opens an <acronym title='Internet Message Access Protocol'>IMAP</acronym> stream to a <i><tt class='parameter'>mailbox</tt></i> . </p> <p class='para'> This function can also be used to open streams to <acronym title='Post Office Protocol version 3'>POP3</acronym> and <acronym title='Network News Transfer Protocol'>NNTP</acronym> servers, but some functions and features are only available on <acronym title='Internet Message Access Protocol'>IMAP</acronym> servers. </p> </div> <a name='function.imap-open.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A mailbox name consists of a server and a mailbox path on this server. The special name <i>INBOX</i> stands for the current users personal mailbox. Mailbox names that contain international characters besides those in the printable ASCII space have to be encoded width <a href='http://www.php.net/manual/en/function.imap-utf7-encode.php' class='function'>imap_utf7_encode()</a>. </p> <p class='para'> The server part, which is enclosed in &amp;#039;{&amp;#039; and &amp;#039;}&amp;#039;, consists of the servers name or ip address, an optional port (prefixed by &amp;#039;:&amp;#039;), and an optional protocol specification (prefixed by &amp;#039;/&amp;#039;). </p> <p class='para'> The server part is mandatory in all mailbox parameters. </p> <p class='para'> All names which start with <i>{</i> are remote names, and are in the form <i>&amp;quot;{&amp;quot; remote_system_name [&amp;quot;:&amp;quot; port] [flags] &amp;quot;}&amp;quot; [mailbox_name]</i> where: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <i>remote_system_name</i> - Internet domain name or bracketed IP address of server. </span> </li> <li class='listitem'> <span class='simpara'> <i>port</i> - optional TCP port number, default is the default port for that service </span> </li> <li class='listitem'> <span class='simpara'> <i>flags</i> - optional flags, see following table. </span> </li> <li class='listitem'> <span class='simpara'> <i>mailbox_name</i> - remote mailbox name, default is INBOX </span> </li> </ul><p> </p> <p class='para'> </p><table class='doctable table'> <caption><b>Optional flags for names</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Flag</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><i>/service=</i><em class='emphasis'>service</em></td> <td align='left'>mailbox access service, default is &amp;quot;imap&amp;quot;</td> </tr> <tr valign='middle'> <td align='left'><i>/user=</i><em class='emphasis'>user</em></td> <td align='left'>remote user name for login on the server</td> </tr> <tr valign='middle'> <td align='left'><i>/authuser=</i><em class='emphasis'>user</em></td> <td align='left'>remote authentication user; if specified this is the user name whose password is used (e.g. administrator)</td> </tr> <tr valign='middle'> <td align='left'><i>/anonymous</i></td> <td align='left'>remote access as anonymous user</td> </tr> <tr valign='middle'> <td align='left'><i>/debug</i></td> <td align='left'>record protocol telemetry in application&amp;#039;s debug log</td> </tr> <tr valign='middle'> <td align='left'><i>/secure</i></td> <td align='left'>do not transmit a plaintext password over the network</td> </tr> <tr valign='middle'> <td align='left'><i>/imap</i>, <i>/imap2</i>, <i>/imap2bis</i>, <i>/imap4</i>, <i>/imap4rev1</i></td> <td align='left'>equivalent to <i>/service=imap</i></td> </tr> <tr valign='middle'> <td align='left'><i>/pop3</i></td> <td align='left'>equivalent to <i>/service=pop3</i></td> </tr> <tr valign='middle'> <td align='left'><i>/nntp</i></td> <td align='left'>equivalent to <i>/service=nntp</i></td> </tr> <tr valign='middle'> <td align='left'><i>/norsh</i></td> <td align='left'>do not use rsh or ssh to establish a preauthenticated IMAP session</td> </tr> <tr valign='middle'> <td align='left'><i>/ssl</i></td> <td align='left'>use the <i>Secure Socket Layer</i> to encrypt the session</td> </tr> <tr valign='middle'> <td align='left'><i>/validate-cert</i></td> <td align='left'>validate certificates from TLS/SSL server (this is the default behavior)</td> </tr> <tr valign='middle'> <td align='left'><i>/novalidate-cert</i></td> <td align='left'>do not validate certificates from TLS/SSL server, needed if server uses self-signed certificates</td> </tr> <tr valign='middle'> <td align='left'><i>/tls</i></td> <td align='left'>force use of <i>start-TLS</i> to encrypt the session, and reject connection to servers that do not support it</td> </tr> <tr valign='middle'> <td align='left'><i>/notls</i></td> <td align='left'>do not do <i>start-TLS</i> to encrypt the session, even with servers that support it</td> </tr> <tr valign='middle'> <td align='left'><i>/readonly</i></td> <td align='left'>request read-only mailbox open (IMAP only; ignored on NNTP, and an error with SMTP and POP3)</td> </tr> </tbody> </table> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The user name </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password associated with the <i><tt class='parameter'>username</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>options</tt></i> are a bit mask with one or more of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_READONLY</tt></b> - Open mailbox read-only </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_ANONYMOUS</tt></b> - Don&amp;#039;t use or update a <var class='filename'>.newsrc</var> for news (NNTP only) </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_HALFOPEN</tt></b> - For <acronym title='Internet Message Access Protocol'>IMAP</acronym> and <acronym title='Network News Transfer Protocol'>NNTP</acronym> names, open a connection but don&amp;#039;t open a mailbox. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>CL_EXPUNGE</tt></b> - Expunge mailbox automatically upon mailbox close (see also <a href='http://www.php.net/manual/en/function.imap-delete.php' class='function'>imap_delete()</a> and <a href='http://www.php.net/manual/en/function.imap-expunge.php' class='function'>imap_expunge()</a>) </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_DEBUG</tt></b> - Debug protocol negotiations </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_SHORTCACHE</tt></b> - Short (<i>elt</i>-only) caching </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_SILENT</tt></b> - Don&amp;#039;t pass up events (internal use) </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_PROTOTYPE</tt></b> - Return driver prototype </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>OP_SECURE</tt></b> - Don&amp;#039;t do non-secure authentication </span> </li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>n_retries</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Number of maximum connect attempts </p> </dd> </dl> <p> </p> </div> <a name='function.imap-open.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an IMAP stream on success or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.imap-open.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.2.0</td> <td align='left'><i><tt class='parameter'>n_retries</tt></i> added</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imap-open.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Different use of <b>imap_open()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;To&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;an&amp;nbsp;IMAP&amp;nbsp;server&amp;nbsp;running&amp;nbsp;on&amp;nbsp;port&amp;nbsp;143&amp;nbsp;on&amp;nbsp;the&amp;nbsp;local&amp;nbsp;machine,<br />//&amp;nbsp;do&amp;nbsp;the&amp;nbsp;following:<br /></span><span style='color: #0000BB'>$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{localhost:143}INBOX'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user_id'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;To&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;POP3&amp;nbsp;server&amp;nbsp;on&amp;nbsp;port&amp;nbsp;110&amp;nbsp;on&amp;nbsp;the&amp;nbsp;local&amp;nbsp;server,&amp;nbsp;use:<br /></span><span style='color: #0000BB'>$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{localhost:110/pop3}INBOX'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user_id'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;To&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;an&amp;nbsp;SSL&amp;nbsp;IMAP&amp;nbsp;or&amp;nbsp;POP3&amp;nbsp;server,&amp;nbsp;add&amp;nbsp;/ssl&amp;nbsp;after&amp;nbsp;the&amp;nbsp;protocol<br />//&amp;nbsp;specification:<br /></span><span style='color: #0000BB'>$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{localhost:993/imap/ssl}INBOX'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user_id'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;To&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;an&amp;nbsp;SSL&amp;nbsp;IMAP&amp;nbsp;or&amp;nbsp;POP3&amp;nbsp;server&amp;nbsp;with&amp;nbsp;a&amp;nbsp;self-signed&amp;nbsp;certificate,<br />//&amp;nbsp;add&amp;nbsp;/ssl/novalidate-cert&amp;nbsp;after&amp;nbsp;the&amp;nbsp;protocol&amp;nbsp;specification:<br /></span><span style='color: #0000BB'>$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{localhost:995/pop3/ssl/novalidate-cert}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user_id'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;To&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;an&amp;nbsp;NNTP&amp;nbsp;server&amp;nbsp;on&amp;nbsp;port&amp;nbsp;119&amp;nbsp;on&amp;nbsp;the&amp;nbsp;local&amp;nbsp;server,&amp;nbsp;use:<br /></span><span style='color: #0000BB'>$nntp&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{localhost:119/nntp}comp.test'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//&amp;nbsp;To&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;remote&amp;nbsp;server&amp;nbsp;replace&amp;nbsp;'localhost'&amp;nbsp;with&amp;nbsp;the&amp;nbsp;name&amp;nbsp;or&amp;nbsp;the<br />//&amp;nbsp;IP&amp;nbsp;address&amp;nbsp;of&amp;nbsp;the&amp;nbsp;server&amp;nbsp;you&amp;nbsp;want&amp;nbsp;to&amp;nbsp;connect&amp;nbsp;to.<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 <b>imap_open()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org:143}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;h1&amp;gt;Mailboxes&amp;lt;/h1&amp;gt;\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$folders&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_listmailbox</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'{imap.example.org:143}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'*'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$folders&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Call&amp;nbsp;failed&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach&amp;nbsp;(</span><span style='color: #0000BB'>$folders&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;h1&amp;gt;Headers&amp;nbsp;in&amp;nbsp;INBOX&amp;lt;/h1&amp;gt;\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$headers&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_headers</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$headers&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Call&amp;nbsp;failed&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach&amp;nbsp;(</span><span style='color: #0000BB'>$headers&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imap-open.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-close.php' class='function' rel='rdfs-seeAlso'>imap_close()</a> - Close an IMAP stream</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_num_recent" value="<div id='function.imap-num-recent' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-num-recent.php'>imap_num_recent</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_num_recent</span> &amp;mdash; <span class='dc-title'>Gets the number of recent messages in current mailbox</span></p> </div> <a name='function.imap-num-recent.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>imap_num_recent</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> )</div> <p class='para rdfs-comment'> Gets the number of recent messages in the current mailbox. </p> </div> <a name='function.imap-num-recent.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imap-num-recent.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of recent messages in the current mailbox, as an integer. </p> </div> <a name='function.imap-num-recent.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-num-msg.php' class='function' rel='rdfs-seeAlso'>imap_num_msg()</a> - Gets the number of messages in the current mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-status.php' class='function' rel='rdfs-seeAlso'>imap_status()</a> - Returns status information on a mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_num_msg" value="<div id='function.imap-num-msg' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-num-msg.php'>imap_num_msg</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_num_msg</span> &amp;mdash; <span class='dc-title'>Gets the number of messages in the current mailbox</span></p> </div> <a name='function.imap-num-msg.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>imap_num_msg</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> )</div> <p class='para rdfs-comment'> Gets the number of messages in the current mailbox. </p> </div> <a name='function.imap-num-msg.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imap-num-msg.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Return the number of messages in the current mailbox, as an integer. </p> </div> <a name='function.imap-num-msg.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-num-recent.php' class='function' rel='rdfs-seeAlso'>imap_num_recent()</a> - Gets the number of recent messages in current mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-status.php' class='function' rel='rdfs-seeAlso'>imap_status()</a> - Returns status information on a mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_msgno" value="<div id='function.imap-msgno' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-msgno.php'>imap_msgno</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_msgno</span> &amp;mdash; <span class='dc-title'>Gets the message sequence number for the given UID</span></p> </div> <a name='function.imap-msgno.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>imap_msgno</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$uid</tt></span> )</div> <p class='para rdfs-comment'> Returns the message sequence number for the given <i><tt class='parameter'>uid</tt></i> . </p> <p class='para'> This function is the inverse of <a href='http://www.php.net/manual/en/function.imap-uid.php' class='function'>imap_uid()</a>. </p> </div> <a name='function.imap-msgno.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>uid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message UID </p> </dd> </dl> <p> </p> </div> <a name='function.imap-msgno.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the message sequence number for the given <i><tt class='parameter'>uid</tt></i> . </p> </div> <a name='function.imap-msgno.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-uid.php' class='function' rel='rdfs-seeAlso'>imap_uid()</a> - This function returns the UID for the given message sequence number</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_mime_header_decode" value="<div id='function.imap-mime-header-decode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-mime-header-decode.php'>imap_mime_header_decode</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_mime_header_decode</span> &amp;mdash; <span class='dc-title'>Decode MIME header elements</span></p> </div> <a name='function.imap-mime-header-decode.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_mime_header_decode</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text</tt></span> )</div> <p class='para rdfs-comment'> Decodes MIME message header extensions that are non ASCII text (see <a href='http://www.faqs.org/rfcs/rfc2047' class='link external'>&amp;raquo; RFC2047</a>). </p> </div> <a name='function.imap-mime-header-decode.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The MIME text </p> </dd> </dl> <p> </p> </div> <a name='function.imap-mime-header-decode.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The decoded elements are returned in an array of objects, where each object has two properties, <i>charset</i> and <i>text</i>. </p> <p class='para'> If the element hasn&amp;#039;t been encoded, and in other words is in plain US-ASCII, the <i>charset</i> property of that element is set to <i>default</i>. </p> </div> <a name='function.imap-mime-header-decode.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_mime_header_decode()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$text&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?=&amp;nbsp;&amp;lt;keld@example.com&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$elements&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_mime_header_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>);<br />for&amp;nbsp;(</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>=</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>&amp;lt;</span><span style='color: #0000BB'>count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$elements</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Charset:&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$elements</span><span style='color: #007700'>[</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>]-&amp;gt;</span><span style='color: #0000BB'>charset</span><span style='color: #007700'>}</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Text:&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$elements</span><span style='color: #007700'>[</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>]-&amp;gt;</span><span style='color: #0000BB'>text</span><span style='color: #007700'>}</span><span style='color: #DD0000'>\n\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Charset: ISO-8859-1 Text: Keld J&amp;Atilde;&amp;cedil;rn Simonsen Charset: default Text: &amp;lt;keld@example.com&amp;gt; </pre></div> </div> </div><p> </p> <p class='para'> In the above example we would have two elements, whereas the first element had previously been encoded with ISO-8859-1, and the second element would be plain US-ASCII. </p> </div> <a name='function.imap-mime-header-decode.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-utf8.php' class='function' rel='rdfs-seeAlso'>imap_utf8()</a> - Converts MIME-encoded text to UTF-8</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_mailboxmsginfo" value="<div id='function.imap-mailboxmsginfo' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-mailboxmsginfo.php'>imap_mailboxmsginfo</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_mailboxmsginfo</span> &amp;mdash; <span class='dc-title'>Get information about the current mailbox</span></p> </div> <a name='function.imap-mailboxmsginfo.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>imap_mailboxmsginfo</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> )</div> <p class='para rdfs-comment'> Checks the current mailbox status on the server. It is similar to <a href='http://www.php.net/manual/en/function.imap-status.php' class='function'>imap_status()</a>, but will additionally sum up the size of all messages in the mailbox, which will take some additional time to execute. </p> </div> <a name='function.imap-mailboxmsginfo.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imap-mailboxmsginfo.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the information in an object with following properties: </p><table class='doctable table'> <caption><b>Mailbox properties</b></caption> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>Date</td> <td align='left'>date of last change (current datetime)</td> </tr> <tr valign='middle'> <td align='left'>Driver</td> <td align='left'>driver</td> </tr> <tr valign='middle'> <td align='left'>Mailbox</td> <td align='left'>name of the mailbox</td> </tr> <tr valign='middle'> <td align='left'>Nmsgs</td> <td align='left'>number of messages</td> </tr> <tr valign='middle'> <td align='left'>Recent</td> <td align='left'>number of recent messages</td> </tr> <tr valign='middle'> <td align='left'>Unread</td> <td align='left'>number of unread messages</td> </tr> <tr valign='middle'> <td align='left'>Deleted</td> <td align='left'>number of deleted messages</td> </tr> <tr valign='middle'> <td align='left'>Size</td> <td align='left'>mailbox size</td> </tr> </tbody> </table> <p> </p> <p class='para'> Returns <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-mailboxmsginfo.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_mailboxmsginfo()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}INBOX'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$check&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_mailboxmsginfo</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Date:&amp;nbsp;'&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Date&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'&amp;nbsp;</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Driver:&amp;nbsp;'&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Driver&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'&amp;nbsp;</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Mailbox:&amp;nbsp;'&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Mailbox&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'&amp;nbsp;</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Messages:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Nmsgs&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'&amp;nbsp;</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Recent:&amp;nbsp;'&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Recent&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'&amp;nbsp;</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unread:&amp;nbsp;'&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Unread&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'&amp;nbsp;</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Deleted:&amp;nbsp;'&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Deleted&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'&amp;nbsp;</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Size:&amp;nbsp;'&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Size&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'&amp;nbsp;</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'imap_check()&amp;nbsp;failed:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_mail_move" value="<div id='function.imap-mail-move' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-mail-move.php'>imap_mail_move</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_mail_move</span> &amp;mdash; <span class='dc-title'>Move specified messages to a mailbox</span></p> </div> <a name='function.imap-mail-move.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_mail_move</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$msglist</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Moves mail messages specified by <i><tt class='parameter'>msglist</tt></i> to the specified <i><tt class='parameter'>mailbox</tt></i> . </p> </div> <a name='function.imap-mail-move.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msglist</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>msglist</tt></i> is a range not just message numbers (as described in <a href='http://www.faqs.org/rfcs/rfc2060' class='link external'>&amp;raquo; RFC2060</a>). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>options</tt></i> is a bitmask and may contain the single option: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>CP_UID</tt></b> - the sequence numbers contain UIDS </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-mail-move.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-mail-move.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-mail-copy.php' class='function' rel='rdfs-seeAlso'>imap_mail_copy()</a> - Copy specified messages to a mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_mail_copy" value="<div id='function.imap-mail-copy' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-mail-copy.php'>imap_mail_copy</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_mail_copy</span> &amp;mdash; <span class='dc-title'>Copy specified messages to a mailbox</span></p> </div> <a name='function.imap-mail-copy.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_mail_copy</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$msglist</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Copies mail messages specified by <i><tt class='parameter'>msglist</tt></i> to specified mailbox. </p> </div> <a name='function.imap-mail-copy.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msglist</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>msglist</tt></i> is a range not just message numbers (as described in <a href='http://www.faqs.org/rfcs/rfc2060' class='link external'>&amp;raquo; RFC2060</a>). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>options</tt></i> is a bitmask of one or more of </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>CP_UID</tt></b> - the sequence numbers contain UIDS </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>CP_MOVE</tt></b> - Delete the messages from the current mailbox after copying </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-mail-copy.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-mail-copy.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-mail-move.php' class='function' rel='rdfs-seeAlso'>imap_mail_move()</a> - Move specified messages to a mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_mail_compose" value="<div id='function.imap-mail-compose' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-mail-compose.php'>imap_mail_compose</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_mail_compose</span> &amp;mdash; <span class='dc-title'>Create a MIME message based on given envelope and body sections</span></p> </div> <a name='function.imap-mail-compose.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_mail_compose</b></span> ( <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$envelope</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$body</tt></span> )</div> <p class='para rdfs-comment'> Create a MIME message based on the given <i><tt class='parameter'>envelope</tt></i> and <i><tt class='parameter'>body</tt></i> sections. </p> </div> <a name='function.imap-mail-compose.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>envelope</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An associative array of headers fields </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>body</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An indexed array of bodies </p> <p class='para'> A body is an associative array which can consist of the following keys: &amp;quot;type&amp;quot;, &amp;quot;encoding&amp;quot;, &amp;quot;subtype&amp;quot;, &amp;quot;description&amp;quot; and &amp;quot;contents.data&amp;quot; </p> </dd> </dl> <p> </p> </div> <a name='function.imap-mail-compose.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the MIME message. </p> </div> <a name='function.imap-mail-compose.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_mail_compose()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$envelope</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'from'</span><span style='color: #007700'>]=&amp;nbsp;</span><span style='color: #DD0000'>'joe@example.com'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$envelope</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'to'</span><span style='color: #007700'>]&amp;nbsp;&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'foo@example.com'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$envelope</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'cc'</span><span style='color: #007700'>]&amp;nbsp;&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'bar@example.com'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$part1</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'type'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>TYPEMULTIPART</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$part1</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'subtype'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'mixed'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$filename&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'/tmp/imap.c.gz'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$fp&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>fopen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'r'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$contents&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>fread</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>filesize</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>fclose</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$part2</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'type'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>TYPEAPPLICATION</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$part2</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'encoding'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>ENCBINARY</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$part2</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'subtype'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'octet-stream'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$part2</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'description'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>basename</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$part2</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'contents.data'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>$contents</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$part3</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'type'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>TYPETEXT</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$part3</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'subtype'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'plain'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$part3</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'description'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'description3'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$part3</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'contents.data'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'contents.data3\n\n\n\t'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$body</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>$part1</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$body</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>$part2</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$body</span><span style='color: #007700'>[</span><span style='color: #0000BB'>3</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>$part3</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>nl2br</span><span style='color: #007700'>(</span><span style='color: #0000BB'>imap_mail_compose</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$envelope</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$body</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_mail" value="<div id='function.imap-mail' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-mail.php'>imap_mail</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_mail</span> &amp;mdash; <span class='dc-title'>Send an email message</span></p> </div> <a name='function.imap-mail.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_mail</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$to</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$subject</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$message</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$additional_headers</tt><span class='initializer'> = NULL</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$cc</tt><span class='initializer'> = NULL</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$bcc</tt><span class='initializer'> = NULL</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$rpath</tt><span class='initializer'> = NULL</span></span> ]]]] )</div> <p class='para rdfs-comment'> This function allows sending of emails with correct handling of Cc and Bcc receivers. </p> <p class='para'> The parameters <i><tt class='parameter'>to</tt></i> , <i><tt class='parameter'>cc</tt></i> and <i><tt class='parameter'>bcc</tt></i> are all strings and are all parsed as <a href='http://www.faqs.org/rfcs/rfc822' class='link external'>&amp;raquo; RFC822</a> address lists. </p> </div> <a name='function.imap-mail.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>to</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The receiver </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>subject</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mail subject </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>message</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mail body </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>additional_headers</tt></i> </span> </dt><dd class='listitem'> <p class='para'> As string with additional headers to be set on the mail </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cc</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>bcc</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The receivers specified in <i><tt class='parameter'>bcc</tt></i> will get the mail, but are excluded from the headers. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>rpath</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Use this parameter to specify return path upon mail delivery failure. This is useful when using PHP as a mail client for multiple users. </p> </dd> </dl> <p> </p> </div> <a name='function.imap-mail.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-mail.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mail.php' class='function' rel='rdfs-seeAlso'>mail()</a> - Send mail</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_lsub" value="<div id='function.imap-lsub' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-lsub.php'>imap_lsub</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_lsub</span> &amp;mdash; <span class='dc-title'>List all the subscribed mailboxes</span></p> </div> <a name='function.imap-lsub.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_lsub</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$ref</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> )</div> <p class='para rdfs-comment'> Gets an array of all the mailboxes that you have subscribed. </p> </div> <a name='function.imap-lsub.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ref</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>ref</tt></i> should normally be just the server specification as described in <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Specifies where in the mailbox hierarchy to start searching.</p><p class='para'>There are two special characters you can pass as part of the <i><tt class='parameter'>pattern</tt></i> : &amp;#039;<i>*</i>&amp;#039; and &amp;#039;<i>%</i>&amp;#039;. &amp;#039;<i>*</i>&amp;#039; means to return all mailboxes. If you pass <i><tt class='parameter'>pattern</tt></i> as &amp;#039;<i>*</i>&amp;#039;, you will get a list of the entire mailbox hierarchy. &amp;#039;<i>%</i>&amp;#039; means to return the current level only. &amp;#039;<i>%</i>&amp;#039; as the <i><tt class='parameter'>pattern</tt></i> parameter will return only the top level mailboxes; &amp;#039;<i>~/mail/%</i>&amp;#039; on <i>UW_IMAPD</i> will return every mailbox in the <var class='filename'>~/mail</var> directory, but none in subfolders of that directory.</p> </dd> </dl> <p> </p> </div> <a name='function.imap-lsub.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of all the subscribed mailboxes. </p> </div> <a name='function.imap-lsub.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-list.php' class='function' rel='rdfs-seeAlso'>imap_list()</a> - Read the list of mailboxes</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-getmailboxes.php' class='function' rel='rdfs-seeAlso'>imap_getmailboxes()</a> - Read the list of mailboxes, returning detailed information on each one</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_listsubscribed" value="<div id='function.imap-listsubscribed' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-listsubscribed.php'>imap_listsubscribed</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_listsubscribed</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.imap-lsub.php' class='function'>imap_lsub()</a></span></p> </div> <a name='function.imap-listsubscribed.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.imap-lsub.php' class='function'>imap_lsub()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_listmailbox" value="<div id='function.imap-listmailbox' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-listmailbox.php'>imap_listmailbox</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_listmailbox</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.imap-list.php' class='function'>imap_list()</a></span></p> </div> <a name='function.imap-listmailbox.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.imap-list.php' class='function'>imap_list()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_list" value="<div id='function.imap-list' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-list.php'>imap_list</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_list</span> &amp;mdash; <span class='dc-title'>Read the list of mailboxes</span></p> </div> <a name='function.imap-list.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_list</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$ref</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> )</div> <p class='para rdfs-comment'> Read the list of mailboxes. </p> </div> <a name='function.imap-list.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ref</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>ref</tt></i> should normally be just the server specification as described in <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Specifies where in the mailbox hierarchy to start searching.</p><p class='para'>There are two special characters you can pass as part of the <i><tt class='parameter'>pattern</tt></i> : &amp;#039;<i>*</i>&amp;#039; and &amp;#039;<i>%</i>&amp;#039;. &amp;#039;<i>*</i>&amp;#039; means to return all mailboxes. If you pass <i><tt class='parameter'>pattern</tt></i> as &amp;#039;<i>*</i>&amp;#039;, you will get a list of the entire mailbox hierarchy. &amp;#039;<i>%</i>&amp;#039; means to return the current level only. &amp;#039;<i>%</i>&amp;#039; as the <i><tt class='parameter'>pattern</tt></i> parameter will return only the top level mailboxes; &amp;#039;<i>~/mail/%</i>&amp;#039; on <i>UW_IMAPD</i> will return every mailbox in the <var class='filename'>~/mail</var> directory, but none in subfolders of that directory.</p> </dd> </dl> <p> </p> </div> <a name='function.imap-list.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array containing the names of the mailboxes. </p> </div> <a name='function.imap-list.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_list()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OP_HALFOPEN</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$list&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_list</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'{imap.example.org}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'*'</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$list</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach&amp;nbsp;(</span><span style='color: #0000BB'>$list&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>imap_utf7_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'imap_list&amp;nbsp;failed:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imap-list.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-getmailboxes.php' class='function' rel='rdfs-seeAlso'>imap_getmailboxes()</a> - Read the list of mailboxes, returning detailed information on each one</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-lsub.php' class='function' rel='rdfs-seeAlso'>imap_lsub()</a> - List all the subscribed mailboxes</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_last_error" value="<div id='function.imap-last-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-last-error.php'>imap_last_error</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_last_error</span> &amp;mdash; <span class='dc-title'>Gets the last IMAP error that occurred during this page request</span></p> </div> <a name='function.imap-last-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_last_error</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Gets the full text of the last <acronym title='Internet Message Access Protocol'>IMAP</acronym> error message that occurred on the current page. The error stack is untouched; calling <b>imap_last_error()</b> subsequently, with no intervening errors, will return the same error. </p> </div> <a name='function.imap-last-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the full text of the last IMAP error message that occurred on the current page. Returns <b><tt class='constant'>FALSE</tt></b> if no error messages are available. </p> </div> <a name='function.imap-last-error.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-errors.php' class='function' rel='rdfs-seeAlso'>imap_errors()</a> - Returns all of the IMAP errors that have occured</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_headers" value="<div id='function.imap-headers' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-headers.php'>imap_headers</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_headers</span> &amp;mdash; <span class='dc-title'>Returns headers for all messages in a mailbox</span></p> </div> <a name='function.imap-headers.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_headers</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> )</div> <p class='para rdfs-comment'> Returns headers for all messages in a mailbox. </p> </div> <a name='function.imap-headers.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imap-headers.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of string formatted with header info. One element per mail message. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_headerinfo" value="<div id='function.imap-headerinfo' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-headerinfo.php'>imap_headerinfo</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_headerinfo</span> &amp;mdash; <span class='dc-title'>Read the header of the message</span></p> </div> <a name='function.imap-headerinfo.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>imap_headerinfo</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$msg_number</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$fromlength</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$subjectlength</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$defaulthost</tt><span class='initializer'> = NULL</span></span> ]]] )</div> <p class='para rdfs-comment'> Gets information about the given message number by reading its headers. </p> </div> <a name='function.imap-headerinfo.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msg_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message number </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fromlength</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Number of characters for the <i>fetchfrom</i> property. Must be greater than or equal to zero. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>subjectlength</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Number of characters for the <i>fetchsubject</i> property Must be greater than or equal to zero. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>defaulthost</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-headerinfo.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the information in an object with following properties: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> toaddress - full to: line, up to 1024 characters </span> </li> <li class='listitem'> <span class='simpara'> to - an array of objects from the To: line, with the following properties: <i>personal</i>, <i>adl</i>, <i>mailbox</i>, and <i>host</i> </span> </li> <li class='listitem'> <span class='simpara'> fromaddress - full from: line, up to 1024 characters </span> </li> <li class='listitem'> <span class='simpara'> from - an array of objects from the From: line, with the following properties: <i>personal</i>, <i>adl</i>, <i>mailbox</i>, and <i>host</i> </span> </li> <li class='listitem'> <span class='simpara'> ccaddress - full cc: line, up to 1024 characters </span> </li> <li class='listitem'> <span class='simpara'> cc - an array of objects from the Cc: line, with the following properties: <i>personal</i>, <i>adl</i>, <i>mailbox</i>, and <i>host</i> </span> </li> <li class='listitem'> <span class='simpara'> bccaddress - full bcc: line, up to 1024 characters </span> </li> <li class='listitem'> <span class='simpara'> bcc - an array of objects from the Bcc: line, with the following properties: <i>personal</i>, <i>adl</i>, <i>mailbox</i>, and <i>host</i> </span> </li> <li class='listitem'> <span class='simpara'> reply_toaddress - full Reply-To: line, up to 1024 characters </span> </li> <li class='listitem'> <span class='simpara'> reply_to - an array of objects from the Reply-To: line, with the following properties: <i>personal</i>, <i>adl</i>, <i>mailbox</i>, and <i>host</i> </span> </li> <li class='listitem'> <span class='simpara'> senderaddress - full sender: line, up to 1024 characters </span> </li> <li class='listitem'> <span class='simpara'> sender - an array of objects from the Sender: line, with the following properties: <i>personal</i>, <i>adl</i>, <i>mailbox</i>, and <i>host</i> </span> </li> <li class='listitem'> <span class='simpara'> return_pathaddress - full Return-Path: line, up to 1024 characters </span> </li> <li class='listitem'> <span class='simpara'> return_path - an array of objects from the Return-Path: line, with the following properties: <i>personal</i>, <i>adl</i>, <i>mailbox</i>, and <i>host</i> </span> </li> <li class='listitem'> <span class='simpara'> remail - </span> </li> <li class='listitem'> <span class='simpara'> date - The message date as found in its headers </span> </li> <li class='listitem'> <span class='simpara'> Date - Same as date </span> </li> <li class='listitem'> <span class='simpara'> subject - The message subject </span> </li> <li class='listitem'> <span class='simpara'> Subject - Same a subject </span> </li> <li class='listitem'> <span class='simpara'> in_reply_to - </span> </li> <li class='listitem'> <span class='simpara'> message_id - </span> </li> <li class='listitem'> <span class='simpara'> newsgroups - </span> </li> <li class='listitem'> <span class='simpara'> followup_to - </span> </li> <li class='listitem'> <span class='simpara'> references - </span> </li> <li class='listitem'> <span class='simpara'> Recent - <i>R</i> if recent and seen, <i>N</i> if recent and not seen, &amp;#039; &amp;#039; if not recent. </span> </li> <li class='listitem'> <span class='simpara'> Unseen - <i>U</i> if not seen AND not recent, &amp;#039; &amp;#039; if seen OR not seen and recent </span> </li> <li class='listitem'> <span class='simpara'> Flagged - <i>F</i> if flagged, &amp;#039; &amp;#039; if not flagged </span> </li> <li class='listitem'> <span class='simpara'> Answered - <i>A</i> if answered, &amp;#039; &amp;#039; if unanswered </span> </li> <li class='listitem'> <span class='simpara'> Deleted - <i>D</i> if deleted, &amp;#039; &amp;#039; if not deleted </span> </li> <li class='listitem'> <span class='simpara'> Draft - <i>X</i> if draft, &amp;#039; &amp;#039; if not draft </span> </li> <li class='listitem'> <span class='simpara'> Msgno - The message number </span> </li> <li class='listitem'> <span class='simpara'> MailDate - </span> </li> <li class='listitem'> <span class='simpara'> Size - The message size </span> </li> <li class='listitem'> <span class='simpara'> udate - mail message date in Unix time </span> </li> <li class='listitem'> <span class='simpara'> fetchfrom - from line formatted to fit <i><tt class='parameter'>fromlength</tt></i> characters </span> </li> <li class='listitem'> <span class='simpara'> fetchsubject - subject line formatted to fit <i><tt class='parameter'>subjectlength</tt></i> characters </span> </li> </ul><p> </p> </div> <a name='function.imap-headerinfo.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-fetch-overview.php' class='function' rel='rdfs-seeAlso'>imap_fetch_overview()</a> - Read an overview of the information in the headers of the given message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_header" value="<div id='function.imap-header' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-header.php'>imap_header</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_header</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.imap-headerinfo.php' class='function'>imap_headerinfo()</a></span></p> </div> <a name='function.imap-header.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.imap-headerinfo.php' class='function'>imap_headerinfo()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_getsubscribed" value="<div id='function.imap-getsubscribed' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-getsubscribed.php'>imap_getsubscribed</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_getsubscribed</span> &amp;mdash; <span class='dc-title'>List all the subscribed mailboxes</span></p> </div> <a name='function.imap-getsubscribed.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_getsubscribed</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$ref</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> )</div> <p class='para rdfs-comment'> Gets information about the subscribed mailboxes. </p> <p class='para'> Identical to <a href='http://www.php.net/manual/en/function.imap-getmailboxes.php' class='function'>imap_getmailboxes()</a>, except that it only returns mailboxes that the user is subscribed to. </p> </div> <a name='function.imap-getsubscribed.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ref</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>ref</tt></i> should normally be just the server specification as described in <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Specifies where in the mailbox hierarchy to start searching.</p><p class='para'>There are two special characters you can pass as part of the <i><tt class='parameter'>pattern</tt></i> : &amp;#039;<i>*</i>&amp;#039; and &amp;#039;<i>%</i>&amp;#039;. &amp;#039;<i>*</i>&amp;#039; means to return all mailboxes. If you pass <i><tt class='parameter'>pattern</tt></i> as &amp;#039;<i>*</i>&amp;#039;, you will get a list of the entire mailbox hierarchy. &amp;#039;<i>%</i>&amp;#039; means to return the current level only. &amp;#039;<i>%</i>&amp;#039; as the <i><tt class='parameter'>pattern</tt></i> parameter will return only the top level mailboxes; &amp;#039;<i>~/mail/%</i>&amp;#039; on <i>UW_IMAPD</i> will return every mailbox in the <var class='filename'>~/mail</var> directory, but none in subfolders of that directory.</p> </dd> </dl> <p> </p> </div> <a name='function.imap-getsubscribed.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of objects containing mailbox information. Each object has the attributes <i><tt class='parameter'>name</tt></i> , specifying the full name of the mailbox; <i><tt class='parameter'>delimiter</tt></i> , which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and <i><tt class='parameter'>attributes</tt></i> . <i><tt class='parameter'>Attributes</tt></i> is a bitmask that can be tested against: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LATT_NOINFERIORS</tt></b> - This mailbox has no &amp;quot;children&amp;quot; (there are no mailboxes below this one). </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LATT_NOSELECT</tt></b> - This is only a container, not a mailbox - you cannot open it. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LATT_MARKED</tt></b> - This mailbox is marked. Only used by UW-IMAPD. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LATT_UNMARKED</tt></b> - This mailbox is not marked. Only used by UW-IMAPD. </span> </li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_getmailboxes" value="<div id='function.imap-getmailboxes' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-getmailboxes.php'>imap_getmailboxes</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_getmailboxes</span> &amp;mdash; <span class='dc-title'>Read the list of mailboxes, returning detailed information on each one</span></p> </div> <a name='function.imap-getmailboxes.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_getmailboxes</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$ref</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> )</div> <p class='para rdfs-comment'> Gets information on the mailboxes. </p> </div> <a name='function.imap-getmailboxes.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ref</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>ref</tt></i> should normally be just the server specification as described in <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Specifies where in the mailbox hierarchy to start searching.</p><p class='para'>There are two special characters you can pass as part of the <i><tt class='parameter'>pattern</tt></i> : &amp;#039;<i>*</i>&amp;#039; and &amp;#039;<i>%</i>&amp;#039;. &amp;#039;<i>*</i>&amp;#039; means to return all mailboxes. If you pass <i><tt class='parameter'>pattern</tt></i> as &amp;#039;<i>*</i>&amp;#039;, you will get a list of the entire mailbox hierarchy. &amp;#039;<i>%</i>&amp;#039; means to return the current level only. &amp;#039;<i>%</i>&amp;#039; as the <i><tt class='parameter'>pattern</tt></i> parameter will return only the top level mailboxes; &amp;#039;<i>~/mail/%</i>&amp;#039; on <i>UW_IMAPD</i> will return every mailbox in the <var class='filename'>~/mail</var> directory, but none in subfolders of that directory.</p> </dd> </dl> <p> </p> </div> <a name='function.imap-getmailboxes.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of objects containing mailbox information. Each object has the attributes <i><tt class='parameter'>name</tt></i> , specifying the full name of the mailbox; <i><tt class='parameter'>delimiter</tt></i> , which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and <i><tt class='parameter'>attributes</tt></i> . <i><tt class='parameter'>Attributes</tt></i> is a bitmask that can be tested against: </p><ul class='itemizedlist'> <li class='listitem'> <p class='para'> <b><tt class='constant'>LATT_NOINFERIORS</tt></b> - This mailbox contains, and may not contain any &amp;quot;children&amp;quot; (there are no mailboxes below this one). Calling <a href='http://www.php.net/manual/en/function.imap-createmailbox.php' class='function'>imap_createmailbox()</a> will not work on this mailbox. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>LATT_NOSELECT</tt></b> - This is only a container, not a mailbox - you cannot open it. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>LATT_MARKED</tt></b> - This mailbox is marked. This means that it may contain new messages since the last time it was checked. Not provided by all IMAP servers. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>LATT_UNMARKED</tt></b> - This mailbox is not marked, does not contain new messages. If either <b><tt class='constant'>MARKED</tt></b> or <b><tt class='constant'>UNMARKED</tt></b> is provided, you can assume the IMAP server supports this feature for this mailbox. </p> </li> </ul><p> </p> </div> <a name='function.imap-getmailboxes.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_getmailboxes()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OP_HALFOPEN</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$list&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_getmailboxes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'{imap.example.org}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'*'</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$list</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach&amp;nbsp;(</span><span style='color: #0000BB'>$list&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$key&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'(</span><span style='color: #0000BB'>$key</span><span style='color: #DD0000'>)&amp;nbsp;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>imap_utf7_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>','</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'''&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>delimiter&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'','</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>attributes&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'imap_getmailboxes&amp;nbsp;failed:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imap-getmailboxes.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-getsubscribed.php' class='function' rel='rdfs-seeAlso'>imap_getsubscribed()</a> - List all the subscribed mailboxes</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_getacl" value="<div id='function.imap-getacl' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-getacl.php'>imap_getacl</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>imap_getacl</span> &amp;mdash; <span class='dc-title'>Gets the ACL for a given mailbox</span></p> </div> <a name='function.imap-getacl.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_getacl</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> )</div> <p class='para rdfs-comment'> Gets the ACL for a given mailbox. </p> </div> <a name='function.imap-getacl.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> </dl> <p> </p> </div> <a name='function.imap-getacl.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array of &amp;quot;folder&amp;quot; =&amp;gt; &amp;quot;acl&amp;quot; pairs. </p> </div> <a name='function.imap-getacl.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_getacl()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>imap_getacl</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user.joecool'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Array ( [asubfolder] =&amp;gt; lrswipcda [anothersubfolder] =&amp;gt; lrswipcda ) </pre></div> </div> </div><p> </p> </div> <a name='function.imap-getacl.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <p class='para'> This function is currently only available to users of the c-client2000 or greater library. </p> </div> <a name='function.imap-getacl.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-setacl.php' class='function' rel='rdfs-seeAlso'>imap_setacl()</a> - Sets the ACL for a giving mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_get_quotaroot" value="<div id='function.imap-get-quotaroot' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-get-quotaroot.php'>imap_get_quotaroot</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_get_quotaroot</span> &amp;mdash; <span class='dc-title'>Retrieve the quota settings per user</span></p> </div> <a name='function.imap-get-quotaroot.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_get_quotaroot</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$quota_root</tt></span> )</div> <p class='para rdfs-comment'> Retrieve the quota settings per user. The limit value represents the total amount of space allowed for this user&amp;#039;s total mailbox usage. The usage value represents the user&amp;#039;s current total mailbox capacity. </p> </div> <a name='function.imap-get-quotaroot.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>quota_root</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>quota_root</tt></i> should normally be in the form of which mailbox (i.e. INBOX). </p> </dd> </dl> <p> </p> </div> <a name='function.imap-get-quotaroot.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of integer values pertaining to the specified user mailbox. All values contain a key based upon the resource name, and a corresponding array with the usage and limit values within. </p> <p class='para'> This function will return <b><tt class='constant'>FALSE</tt></b> in the case of call failure, and an array of information about the connection upon an un-parsable response from the server. </p> </div> <a name='function.imap-get-quotaroot.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_get_quotaroot()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'kalowsky'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OP_HALFOPEN</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$quota&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_get_quotaroot</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INBOX'</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$quota</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$storage&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$quota_values</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'STORAGE'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'STORAGE&amp;nbsp;usage&amp;nbsp;level&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$storage</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'usage'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'STORAGE&amp;nbsp;limit&amp;nbsp;level&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$storage</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'limit'</span><span style='color: #007700'>];<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$message&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$quota_values</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'MESSAGE'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MESSAGE&amp;nbsp;usage&amp;nbsp;level&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$message</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'usage'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MESSAGE&amp;nbsp;limit&amp;nbsp;level&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$message</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'limit'</span><span style='color: #007700'>];<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;...&amp;nbsp;&amp;nbsp;*/<br /><br /></span><span style='color: #007700'>}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imap-get-quotaroot.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <p class='para'> This function is currently only available to users of the c-client2000 or greater library. </p> <p class='para'> The <i><tt class='parameter'>imap_stream</tt></i> should be opened as the user whose mailbox you wish to check. </p> </div> <a name='function.imap-get-quotaroot.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-open.php' class='function' rel='rdfs-seeAlso'>imap_open()</a> - Open an IMAP stream to a mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-set-quota.php' class='function' rel='rdfs-seeAlso'>imap_set_quota()</a> - Sets a quota for a given mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-get-quota.php' class='function' rel='rdfs-seeAlso'>imap_get_quota()</a> - Retrieve the quota level settings, and usage statics per mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_get_quota" value="<div id='function.imap-get-quota' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-get-quota.php'>imap_get_quota</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_get_quota</span> &amp;mdash; <span class='dc-title'>Retrieve the quota level settings, and usage statics per mailbox</span></p> </div> <a name='function.imap-get-quota.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_get_quota</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$quota_root</tt></span> )</div> <p class='para rdfs-comment'> Retrieve the quota level settings, and usage statics per mailbox. </p> <p class='para'> For a non-admin user version of this function, please see the <a href='http://www.php.net/manual/en/function.imap-get-quotaroot.php' class='function'>imap_get_quotaroot()</a> function of PHP. </p> </div> <a name='function.imap-get-quota.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>quota_root</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>quota_root</tt></i> should normally be in the form of <i>user.name</i> where name is the mailbox you wish to retrieve information about. </p> </dd> </dl> <p> </p> </div> <a name='function.imap-get-quota.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array with integer values limit and usage for the given mailbox. The value of limit represents the total amount of space allowed for this mailbox. The usage value represents the mailboxes current level of capacity. Will return <b><tt class='constant'>FALSE</tt></b> in the case of failure. </p> <p class='para'> As of PHP 4.3, the function more properly reflects the functionality as dictated by the <a href='http://www.faqs.org/rfcs/rfc2087' class='link external'>&amp;raquo; RFC2087</a>. The array return value has changed to support an unlimited number of returned resources (i.e. messages, or sub-folders) with each named resource receiving an individual array key. Each key value then contains an another array with the usage and limit values within it. </p> <p class='para'> For backwards compatibility reasons, the original access methods are still available for use, although it is suggested to update. </p> </div> <a name='function.imap-get-quota.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_get_quota()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mailadmin'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OP_HALFOPEN</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$quota_value&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_get_quota</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user.kalowsky'</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$quota_value</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Usage&amp;nbsp;level&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$quota_value</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'usage'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Limit&amp;nbsp;level&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$quota_value</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'limit'</span><span style='color: #007700'>];<br />}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 <b>imap_get_quota()</b> 4.3 or greater example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mailadmin'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OP_HALFOPEN</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$quota_values&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_get_quota</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user.kalowsky'</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$quota_values</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$storage&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$quota_values</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'STORAGE'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'STORAGE&amp;nbsp;usage&amp;nbsp;level&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$storage</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'usage'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'STORAGE&amp;nbsp;limit&amp;nbsp;level&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$storage</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'limit'</span><span style='color: #007700'>];<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$message&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$quota_values</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'MESSAGE'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MESSAGE&amp;nbsp;usage&amp;nbsp;level&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$message</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'usage'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MESSAGE&amp;nbsp;limit&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$message</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'limit'</span><span style='color: #007700'>];<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;...&amp;nbsp;&amp;nbsp;*/<br /></span><span style='color: #007700'>}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imap-get-quota.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <p class='para'> This function is currently only available to users of the c-client2000 or greater library. </p> <p class='para'> The given <i><tt class='parameter'>imap_stream</tt></i> must be opened as the mail administrator, otherwise this function will fail. </p> </div> <a name='function.imap-get-quota.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-open.php' class='function' rel='rdfs-seeAlso'>imap_open()</a> - Open an IMAP stream to a mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-set-quota.php' class='function' rel='rdfs-seeAlso'>imap_set_quota()</a> - Sets a quota for a given mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-get-quotaroot.php' class='function' rel='rdfs-seeAlso'>imap_get_quotaroot()</a> - Retrieve the quota settings per user</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_fetchstructure" value="<div id='function.imap-fetchstructure' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-fetchstructure.php'>imap_fetchstructure</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_fetchstructure</span> &amp;mdash; <span class='dc-title'>Read the structure of a particular message</span></p> </div> <a name='function.imap-fetchstructure.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>imap_fetchstructure</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$msg_number</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Fetches all the structured information for a given message. </p> </div> <a name='function.imap-fetchstructure.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msg_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message number </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This optional parameter only has a single option, <b><tt class='constant'>FT_UID</tt></b>, which tells the function to treat the <i><tt class='parameter'>msg_number</tt></i> argument as a <i>UID</i>. </p> </dd> </dl> <p> </p> </div> <a name='function.imap-fetchstructure.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object includes the envelope, internal date, size, flags and body structure along with a similar object for each mime attachment. The structure of the returned objects is as follows: </p> <p class='para'> </p><table class='doctable table'> <caption><b> Returned Objects for <b>imap_fetchstructure()</b> </b></caption> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>type</td> <td align='left'>Primary body type</td> </tr> <tr valign='middle'> <td align='left'>encoding</td> <td align='left'>Body transfer encoding</td> </tr> <tr valign='middle'> <td align='left'>ifsubtype</td> <td align='left'><b><tt class='constant'>TRUE</tt></b> if there is a subtype string</td> </tr> <tr valign='middle'> <td align='left'>subtype</td> <td align='left'><acronym title='Multipurpose Internet Mail Extensions'>MIME</acronym> subtype</td> </tr> <tr valign='middle'> <td align='left'>ifdescription</td> <td align='left'><b><tt class='constant'>TRUE</tt></b> if there is a description string</td> </tr> <tr valign='middle'> <td align='left'>description</td> <td align='left'>Content description string</td> </tr> <tr valign='middle'> <td align='left'>ifid</td> <td align='left'><b><tt class='constant'>TRUE</tt></b> if there is an identification string</td> </tr> <tr valign='middle'> <td align='left'>id</td> <td align='left'>Identification string</td> </tr> <tr valign='middle'> <td align='left'>lines</td> <td align='left'>Number of lines</td> </tr> <tr valign='middle'> <td align='left'>bytes</td> <td align='left'>Number of bytes</td> </tr> <tr valign='middle'> <td align='left'>ifdisposition</td> <td align='left'><b><tt class='constant'>TRUE</tt></b> if there is a disposition string</td> </tr> <tr valign='middle'> <td align='left'>disposition</td> <td align='left'>Disposition string</td> </tr> <tr valign='middle'> <td align='left'>ifdparameters</td> <td align='left'><b><tt class='constant'>TRUE</tt></b> if the <var class='varname'>dparameters</var> array exists</td> </tr> <tr valign='middle'> <td align='left'>dparameters</td> <td align='left'>An array of objects where each object has an <i>&amp;quot;attribute&amp;quot;</i> and a <i>&amp;quot;value&amp;quot;</i> property corresponding to the parameters on the <i>Content-disposition</i> <acronym title='Multipurpose Internet Mail Extensions'>MIME</acronym> header.</td> </tr> <tr valign='middle'> <td align='left'>ifparameters</td> <td align='left'><b><tt class='constant'>TRUE</tt></b> if the parameters array exists</td> </tr> <tr valign='middle'> <td align='left'>parameters</td> <td align='left'>An array of objects where each object has an <i>&amp;quot;attribute&amp;quot;</i> and a <i>&amp;quot;value&amp;quot;</i> property.</td> </tr> <tr valign='middle'> <td align='left'>parts</td> <td align='left'>An array of objects identical in structure to the top-level object, each of which corresponds to a <acronym title='Multipurpose Internet Mail Extensions'>MIME</acronym> body part.</td> </tr> </tbody> </table> <p> </p> <p class='para'> </p><table class='doctable table'> <caption><b>Primary body type</b></caption> <tbody valign='middle' class='tbody'> <tr valign='middle'><td align='left'>0</td><td align='left'>text</td></tr> <tr valign='middle'><td align='left'>1</td><td align='left'>multipart</td></tr> <tr valign='middle'><td align='left'>2</td><td align='left'>message</td></tr> <tr valign='middle'><td align='left'>3</td><td align='left'>application</td></tr> <tr valign='middle'><td align='left'>4</td><td align='left'>audio</td></tr> <tr valign='middle'><td align='left'>5</td><td align='left'>image</td></tr> <tr valign='middle'><td align='left'>6</td><td align='left'>video</td></tr> <tr valign='middle'><td align='left'>7</td><td align='left'>other</td></tr> </tbody> </table> <p> </p> <p class='para'> </p><table class='doctable table'> <caption><b>Transfer encodings</b></caption> <tbody valign='middle' class='tbody'> <tr valign='middle'><td align='left'>0</td><td align='left'>7BIT</td></tr> <tr valign='middle'><td align='left'>1</td><td align='left'>8BIT</td></tr> <tr valign='middle'><td align='left'>2</td><td align='left'>BINARY</td></tr> <tr valign='middle'><td align='left'>3</td><td align='left'>BASE64</td></tr> <tr valign='middle'><td align='left'>4</td><td align='left'>QUOTED-PRINTABLE</td></tr> <tr valign='middle'><td align='left'>5</td><td align='left'>OTHER</td></tr> </tbody> </table> <p> </p> </div> <a name='function.imap-fetchstructure.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-fetchbody.php' class='function' rel='rdfs-seeAlso'>imap_fetchbody()</a> - Fetch a particular section of the body of the message</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-bodystruct.php' class='function' rel='rdfs-seeAlso'>imap_bodystruct()</a> - Read the structure of a specified body section of a specific message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_fetchheader" value="<div id='function.imap-fetchheader' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-fetchheader.php'>imap_fetchheader</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_fetchheader</span> &amp;mdash; <span class='dc-title'>Returns header for a message</span></p> </div> <a name='function.imap-fetchheader.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_fetchheader</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$msg_number</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> This function causes a fetch of the complete, unfiltered <a href='http://www.faqs.org/rfcs/rfc2822' class='link external'>&amp;raquo; RFC2822</a> format header of the specified message. </p> </div> <a name='function.imap-fetchheader.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msg_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message number </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The possible <i><tt class='parameter'>options</tt></i> are: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_UID</tt></b> - The <i><tt class='parameter'>msgno</tt></i> argument is a UID </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_INTERNAL</tt></b> - The return string is in &amp;quot;internal&amp;quot; format, without any attempt to canonicalize to CRLF newlines </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_PREFETCHTEXT</tt></b> - The RFC822.TEXT should be pre-fetched at the same time. This avoids an extra RTT on an <acronym title='Internet Message Access Protocol'>IMAP</acronym> connection if a full message text is desired (e.g. in a &amp;quot;save to local file&amp;quot; operation) </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-fetchheader.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the header of the specified message as a text string. </p> </div> <a name='function.imap-fetchheader.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-fetch-overview.php' class='function' rel='rdfs-seeAlso'>imap_fetch_overview()</a> - Read an overview of the information in the headers of the given message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_fetchbody" value="<div id='function.imap-fetchbody' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-fetchbody.php'>imap_fetchbody</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_fetchbody</span> &amp;mdash; <span class='dc-title'>Fetch a particular section of the body of the message</span></p> </div> <a name='function.imap-fetchbody.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_fetchbody</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$msg_number</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$section</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Fetch of a particular section of the body of the specified messages. Body parts are not decoded by this function. </p> </div> <a name='function.imap-fetchbody.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msg_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message number </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>section</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The part number. It is a string of integers delimited by period which index into a body part list as per the IMAP4 specification </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A bitmask with one or more of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_UID</tt></b> - The <i><tt class='parameter'>msg_number</tt></i> is a UID </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_PEEK</tt></b> - Do not set the \Seen flag if not already set </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_INTERNAL</tt></b> - The return string is in internal format, will not canonicalize to CRLF. </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-fetchbody.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a particular section of the body of the specified messages as a text string. </p> </div> <a name='function.imap-fetchbody.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-savebody.php' class='function' rel='rdfs-seeAlso'>imap_savebody()</a> - Save a specific body section to a file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-fetchstructure.php' class='function' rel='rdfs-seeAlso'>imap_fetchstructure()</a> - Read the structure of a particular message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_fetch_overview" value="<div id='function.imap-fetch-overview' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-fetch-overview.php'>imap_fetch_overview</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_fetch_overview</span> &amp;mdash; <span class='dc-title'>Read an overview of the information in the headers of the given message</span></p> </div> <a name='function.imap-fetch-overview.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_fetch_overview</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$sequence</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> This function fetches mail headers for the given <i><tt class='parameter'>sequence</tt></i> and returns an overview of their contents. </p> </div> <a name='function.imap-fetch-overview.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>sequence</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A message sequence description. You can enumerate desired messages with the <i>X,Y</i> syntax, or retrieve all messages within an interval with the <i>X:Y</i> syntax </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>sequence</tt></i> will contain a sequence of message indices or UIDs, if this parameter is set to <b><tt class='constant'>FT_UID</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.imap-fetch-overview.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of objects describing one message header each. The object will only define a property if it exists. The possible properties are: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <i>subject</i> - the messages subject </span> </li> <li class='listitem'> <span class='simpara'> <i>from</i> - who sent it </span> </li> <li class='listitem'> <span class='simpara'> <i>to</i> - recipient </span> </li> <li class='listitem'> <span class='simpara'> <i>date</i> - when was it sent </span> </li> <li class='listitem'> <span class='simpara'> <i>message_id</i> - Message-ID </span> </li> <li class='listitem'> <span class='simpara'> <i>references</i> - is a reference to this message id </span> </li> <li class='listitem'> <span class='simpara'> <i>in_reply_to</i> - is a reply to this message id </span> </li> <li class='listitem'> <span class='simpara'> <i>size</i> - size in bytes </span> </li> <li class='listitem'> <span class='simpara'> <i>uid</i> - UID the message has in the mailbox </span> </li> <li class='listitem'> <span class='simpara'> <i>msgno</i> - message sequence number in the mailbox </span> </li> <li class='listitem'> <span class='simpara'> <i>recent</i> - this message is flagged as recent </span> </li> <li class='listitem'> <span class='simpara'> <i>flagged</i> - this message is flagged </span> </li> <li class='listitem'> <span class='simpara'> <i>answered</i> - this message is flagged as answered </span> </li> <li class='listitem'> <span class='simpara'> <i>deleted</i> - this message is flagged for deletion </span> </li> <li class='listitem'> <span class='simpara'> <i>seen</i> - this message is flagged as already read </span> </li> <li class='listitem'> <span class='simpara'> <i>draft</i> - this message is flagged as being a draft </span> </li> </ul><p> </p> </div> <a name='function.imap-fetch-overview.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_fetch_overview()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org:143}INBOX'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$MC&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_check</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Fetch&amp;nbsp;an&amp;nbsp;overview&amp;nbsp;for&amp;nbsp;all&amp;nbsp;messages&amp;nbsp;in&amp;nbsp;INBOX<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_fetch_overview</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'1:</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$MC</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Nmsgs</span><span style='color: #007700'>}</span><span style='color: #DD0000'>'</span><span style='color: #007700'>,</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br />foreach&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$overview</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'#</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$overview</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>msgno</span><span style='color: #007700'>}</span><span style='color: #DD0000'>&amp;nbsp;(</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$overview</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>date</span><span style='color: #007700'>}</span><span style='color: #DD0000'>)&amp;nbsp;-&amp;nbsp;From:&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$overview</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>from</span><span style='color: #007700'>}</span><span style='color: #DD0000'><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$overview</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>subject</span><span style='color: #007700'>}</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imap-fetch-overview.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-fetchheader.php' class='function' rel='rdfs-seeAlso'>imap_fetchheader()</a> - Returns header for a message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_expunge" value="<div id='function.imap-expunge' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-expunge.php'>imap_expunge</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_expunge</span> &amp;mdash; <span class='dc-title'>Delete all messages marked for deletion</span></p> </div> <a name='function.imap-expunge.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_expunge</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> )</div> <p class='para rdfs-comment'> Deletes all the messages marked for deletion by <a href='http://www.php.net/manual/en/function.imap-delete.php' class='function'>imap_delete()</a>, <a href='http://www.php.net/manual/en/function.imap-mail-move.php' class='function'>imap_mail_move()</a>, or <a href='http://www.php.net/manual/en/function.imap-setflag-full.php' class='function'>imap_setflag_full()</a>. </p> </div> <a name='function.imap-expunge.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imap-expunge.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_errors" value="<div id='function.imap-errors' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-errors.php'>imap_errors</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_errors</span> &amp;mdash; <span class='dc-title'>Returns all of the IMAP errors that have occured</span></p> </div> <a name='function.imap-errors.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_errors</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Gets all of the <acronym title='Internet Message Access Protocol'>IMAP</acronym> errors (if any) that have occurred during this page request or since the error stack was reset. </p> <p class='para'> When <b>imap_errors()</b> is called, the error stack is subsequently cleared. </p> </div> <a name='function.imap-errors.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> This function returns an array of all of the IMAP error messages generated since the last <b>imap_errors()</b> call, or the beginning of the page. Returns <b><tt class='constant'>FALSE</tt></b> if no error messages are available. </p> </div> <a name='function.imap-errors.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-last-error.php' class='function' rel='rdfs-seeAlso'>imap_last_error()</a> - Gets the last IMAP error that occurred during this page request</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-alerts.php' class='function' rel='rdfs-seeAlso'>imap_alerts()</a> - Returns all IMAP alert messages that have occurred</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_deletemailbox" value="<div id='function.imap-deletemailbox' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-deletemailbox.php'>imap_deletemailbox</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_deletemailbox</span> &amp;mdash; <span class='dc-title'>Delete a mailbox</span></p> </div> <a name='function.imap-deletemailbox.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_deletemailbox</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> )</div> <p class='para rdfs-comment'> Deletes the specified <i><tt class='parameter'>mailbox</tt></i> . </p> </div> <a name='function.imap-deletemailbox.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> </dl> <p> </p> </div> <a name='function.imap-deletemailbox.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-deletemailbox.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-createmailbox.php' class='function' rel='rdfs-seeAlso'>imap_createmailbox()</a> - Create a new mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-renamemailbox.php' class='function' rel='rdfs-seeAlso'>imap_renamemailbox()</a> - Rename an old mailbox to new mailbox</li> <li class='member'> <a href='http://www.php.net/manual/en/function.imap-open.php' class='function' rel='rdfs-seeAlso'>imap_open()</a> - Open an IMAP stream to a mailbox for the format of <i><tt class='parameter'>mbox</tt></i> </li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_delete" value="<div id='function.imap-delete' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-delete.php'>imap_delete</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_delete</span> &amp;mdash; <span class='dc-title'>Mark a message for deletion from current mailbox</span></p> </div> <a name='function.imap-delete.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_delete</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$msg_number</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Marks messages listed in <i><tt class='parameter'>msg_number</tt></i> for deletion. Messages marked for deletion will stay in the mailbox until either <a href='http://www.php.net/manual/en/function.imap-expunge.php' class='function'>imap_expunge()</a> is called or <a href='http://www.php.net/manual/en/function.imap-close.php' class='function'>imap_close()</a> is called with the optional parameter <b><tt class='constant'>CL_EXPUNGE</tt></b>. </p> </div> <a name='function.imap-delete.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msg_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message number </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> You can set the <b><tt class='constant'>FT_UID</tt></b> which tells the function to treat the <i><tt class='parameter'>msg_number</tt></i> argument as an <i>UID</i>. </p> </dd> </dl> <p> </p> </div> <a name='function.imap-delete.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b>. </p> </div> <a name='function.imap-delete.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_delete()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}INBOX'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$check&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_mailboxmsginfo</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Messages&amp;nbsp;before&amp;nbsp;delete:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Nmsgs&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>imap_delete</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$check&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_mailboxmsginfo</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Messages&amp;nbsp;after&amp;nbsp;&amp;nbsp;delete:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Nmsgs&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>imap_expunge</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$check&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_mailboxmsginfo</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Messages&amp;nbsp;after&amp;nbsp;expunge:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Nmsgs&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imap-delete.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: POP3 mailboxes do not have their message flags saved between connections, so <a href='http://www.php.net/manual/en/function.imap-expunge.php' class='function'>imap_expunge()</a> must be called during the same connection in order for messages marked for deletion to actually be purged. <br /> </p></blockquote> </div> <a name='function.imap-delete.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-undelete.php' class='function' rel='rdfs-seeAlso'>imap_undelete()</a> - Unmark the message which is marked deleted</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-expunge.php' class='function' rel='rdfs-seeAlso'>imap_expunge()</a> - Delete all messages marked for deletion</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-close.php' class='function' rel='rdfs-seeAlso'>imap_close()</a> - Close an IMAP stream</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_createmailbox" value="<div id='function.imap-createmailbox' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-createmailbox.php'>imap_createmailbox</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_createmailbox</span> &amp;mdash; <span class='dc-title'>Create a new mailbox</span></p> </div> <a name='function.imap-createmailbox.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_createmailbox</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> )</div> <p class='para rdfs-comment'> Creates a new mailbox specified by <i><tt class='parameter'>mailbox</tt></i> . </p> </div> <a name='function.imap-createmailbox.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information. Names containing international characters should be encoded by <a href='http://www.php.net/manual/en/function.imap-utf7-encode.php' class='function'>imap_utf7_encode()</a> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-createmailbox.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-createmailbox.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_createmailbox()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OP_HALFOPEN</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'can't&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$name1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'phpnewbox'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$name2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_utf7_encode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'phpnewb&amp;amp;ouml;x'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$newname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$name1</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Newname&amp;nbsp;will&amp;nbsp;be&amp;nbsp;'</span><span style='color: #0000BB'>$name1</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;we&amp;nbsp;will&amp;nbsp;now&amp;nbsp;create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;mailbox&amp;nbsp;'phptestbox'&amp;nbsp;in&amp;nbsp;your&amp;nbsp;inbox&amp;nbsp;folder,<br />//&amp;nbsp;check&amp;nbsp;its&amp;nbsp;status&amp;nbsp;after&amp;nbsp;creation&amp;nbsp;and&amp;nbsp;finaly&amp;nbsp;remove&amp;nbsp;it&amp;nbsp;to&amp;nbsp;restore<br />//&amp;nbsp;your&amp;nbsp;inbox&amp;nbsp;to&amp;nbsp;its&amp;nbsp;initial&amp;nbsp;state<br /><br /></span><span style='color: #007700'>if&amp;nbsp;(@</span><span style='color: #0000BB'>imap_createmailbox</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imap_utf7_encode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}INBOX.</span><span style='color: #0000BB'>$newname</span><span style='color: #DD0000'>'</span><span style='color: #007700'>)))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$status&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>imap_status</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'{imap.example.org}INBOX.</span><span style='color: #0000BB'>$newname</span><span style='color: #DD0000'>'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SA_ALL</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'your&amp;nbsp;new&amp;nbsp;mailbox&amp;nbsp;'</span><span style='color: #0000BB'>$name1</span><span style='color: #DD0000'>'&amp;nbsp;has&amp;nbsp;the&amp;nbsp;following&amp;nbsp;status:&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Messages:&amp;nbsp;&amp;nbsp;&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>messages&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Recent:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>recent&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unseen:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>unseen&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'UIDnext:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>uidnext&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'UIDvalidity:'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$status</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>uidvalidity&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>imap_renamemailbox</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'{imap.example.org}INBOX.</span><span style='color: #0000BB'>$newname</span><span style='color: #DD0000'>'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'{imap.example.org}INBOX.</span><span style='color: #0000BB'>$name2</span><span style='color: #DD0000'>'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'renamed&amp;nbsp;new&amp;nbsp;mailbox&amp;nbsp;from&amp;nbsp;'</span><span style='color: #0000BB'>$name1</span><span style='color: #DD0000'>'&amp;nbsp;to&amp;nbsp;'</span><span style='color: #0000BB'>$name2</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$newname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$name2</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'imap_renamemailbox&amp;nbsp;on&amp;nbsp;new&amp;nbsp;mailbox&amp;nbsp;failed:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'imap_status&amp;nbsp;on&amp;nbsp;new&amp;nbsp;mailbox&amp;nbsp;failed:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imap_last_error</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(@</span><span style='color: #0000BB'>imap_deletemailbox</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'{imap.example.org}INBOX.</span><span style='color: #0000BB'>$newname</span><span style='color: #DD0000'>'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'new&amp;nbsp;mailbox&amp;nbsp;removed&amp;nbsp;to&amp;nbsp;restore&amp;nbsp;initial&amp;nbsp;state&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'imap_deletemailbox&amp;nbsp;on&amp;nbsp;new&amp;nbsp;mailbox&amp;nbsp;failed:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>implode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imap_errors</span><span style='color: #007700'>())&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'could&amp;nbsp;not&amp;nbsp;create&amp;nbsp;new&amp;nbsp;mailbox:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>implode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imap_errors</span><span style='color: #007700'>())&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mbox</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imap-createmailbox.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-renamemailbox.php' class='function' rel='rdfs-seeAlso'>imap_renamemailbox()</a> - Rename an old mailbox to new mailbox</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-deletemailbox.php' class='function' rel='rdfs-seeAlso'>imap_deletemailbox()</a> - Delete a mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_close" value="<div id='function.imap-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-close.php'>imap_close</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_close</span> &amp;mdash; <span class='dc-title'>Close an IMAP stream</span></p> </div> <a name='function.imap-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_close</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flag</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Closes the imap stream. </p> </div> <a name='function.imap-close.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flag</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If set to <b><tt class='constant'>CL_EXPUNGE</tt></b>, the function will silently expunge the mailbox before closing, removing all messages marked for deletion. You can achieve the same thing by using <a href='http://www.php.net/manual/en/function.imap-expunge.php' class='function'>imap_expunge()</a> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-close.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-open.php' class='function' rel='rdfs-seeAlso'>imap_open()</a> - Open an IMAP stream to a mailbox</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_clearflag_full" value="<div id='function.imap-clearflag-full' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-clearflag-full.php'>imap_clearflag_full</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_clearflag_full</span> &amp;mdash; <span class='dc-title'>Clears flags on messages</span></p> </div> <a name='function.imap-clearflag-full.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_clearflag_full</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$sequence</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$flag</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> This function causes a store to delete the specified <i><tt class='parameter'>flag</tt></i> to the flags set for the messages in the specified <i><tt class='parameter'>sequence</tt></i> . </p> </div> <a name='function.imap-clearflag-full.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>sequence</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A sequence of message numbers. You can enumerate desired messages with the <i>X,Y</i> syntax, or retrieve all messages within an interval with the <i>X:Y</i> syntax </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flag</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The flags which you can unset are &amp;quot;\\Seen&amp;quot;, &amp;quot;\\Answered&amp;quot;, &amp;quot;\\Flagged&amp;quot;, &amp;quot;\\Deleted&amp;quot;, and &amp;quot;\\Draft&amp;quot; (as defined by <a href='http://www.faqs.org/rfcs/rfc2060' class='link external'>&amp;raquo; RFC2060</a>) </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>options</tt></i> are a bit mask and may contain the single option: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>ST_UID</tt></b> - The sequence argument contains UIDs instead of sequence numbers </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-clearflag-full.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-clearflag-full.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-setflag-full.php' class='function' rel='rdfs-seeAlso'>imap_setflag_full()</a> - Sets flags on messages</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_check" value="<div id='function.imap-check' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-check.php'>imap_check</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_check</span> &amp;mdash; <span class='dc-title'>Check current mailbox</span></p> </div> <a name='function.imap-check.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>imap_check</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> )</div> <p class='para rdfs-comment'> Checks information about the current mailbox. </p> </div> <a name='function.imap-check.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imap-check.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the information in an object with following properties: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>Date</tt></b> - current system time formatted according to <a href='http://www.faqs.org/rfcs/rfc2822' class='link external'>&amp;raquo; RFC2822</a> </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>Driver</tt></b> - protocol used to access this mailbox: <acronym title='Post Office Protocol version 3'>POP3</acronym>, <acronym title='Internet Message Access Protocol'>IMAP</acronym>, <acronym title='Network News Transfer Protocol'>NNTP</acronym> </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>Mailbox</tt></b> - the mailbox name </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>Nmsgs</tt></b> - number of messages in the mailbox </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>Recent</tt></b> - number of recent messages in the mailbox </span> </li> </ul><p> </p> <p class='para'> Returns <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-check.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_check()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$imap_obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_check</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imap_stream</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imap_obj</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> object(stdClass)(5) { [&amp;quot;Date&amp;quot;]=&amp;gt; string(37) &amp;quot;Wed, 10 Dec 2003 17:56:54 +0100 (CET)&amp;quot; [&amp;quot;Driver&amp;quot;]=&amp;gt; string(4) &amp;quot;imap&amp;quot; [&amp;quot;Mailbox&amp;quot;]=&amp;gt; string(54) &amp;quot;{www.example.com:143/imap/user=&amp;quot;foo@example.com&amp;quot;}INBOX&amp;quot; [&amp;quot;Nmsgs&amp;quot;]=&amp;gt; int(1) [&amp;quot;Recent&amp;quot;]=&amp;gt; int(0) } </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_bodystruct" value="<div id='function.imap-bodystruct' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-bodystruct.php'>imap_bodystruct</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_bodystruct</span> &amp;mdash; <span class='dc-title'>Read the structure of a specified body section of a specific message</span></p> </div> <a name='function.imap-bodystruct.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>imap_bodystruct</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$msg_number</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$section</tt></span> )</div> <p class='para rdfs-comment'> Read the structure of a specified body section of a specific message. </p> </div> <a name='function.imap-bodystruct.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msg_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message number </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>section</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The body section to read </p> </dd> </dl> <p> </p> </div> <a name='function.imap-bodystruct.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the information in an object, for a detailed description of the object structure and properties see <a href='http://www.php.net/manual/en/function.imap-fetchstructure.php' class='function'>imap_fetchstructure()</a>. </p> </div> <a name='function.imap-bodystruct.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-fetchstructure.php' class='function' rel='rdfs-seeAlso'>imap_fetchstructure()</a> - Read the structure of a particular message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_body" value="<div id='function.imap-body' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-body.php'>imap_body</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_body</span> &amp;mdash; <span class='dc-title'>Read the message body</span></p> </div> <a name='function.imap-body.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_body</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$msg_number</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>imap_body()</b> returns the body of the message, numbered <i><tt class='parameter'>msg_number</tt></i> in the current mailbox. </p> <p class='para'> <b>imap_body()</b> will only return a verbatim copy of the message body. To extract single parts of a multipart MIME-encoded message you have to use <a href='http://www.php.net/manual/en/function.imap-fetchstructure.php' class='function'>imap_fetchstructure()</a> to analyze its structure and <a href='http://www.php.net/manual/en/function.imap-fetchbody.php' class='function'>imap_fetchbody()</a> to extract a copy of a single body component. </p> </div> <a name='function.imap-body.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msg_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message number </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional <i><tt class='parameter'>options</tt></i> are a bit mask with one or more of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_UID</tt></b> - The <i><tt class='parameter'>msg_number</tt></i> is a UID </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_PEEK</tt></b> - Do not set the \Seen flag if not already set </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>FT_INTERNAL</tt></b> - The return string is in internal format, will not canonicalize to CRLF. </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-body.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the body of the specified message, as a string. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_binary" value="<div id='function.imap-binary' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-binary.php'>imap_binary</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_binary</span> &amp;mdash; <span class='dc-title'>Convert an 8bit string to a base64 string</span></p> </div> <a name='function.imap-binary.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_binary</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> )</div> <p class='para rdfs-comment'> Convert an 8bit string to a base64 string according to <a href='http://www.faqs.org/rfcs/rfc2045' class='link external'>&amp;raquo; RFC2045</a>, Section 6.8. </p> </div> <a name='function.imap-binary.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The 8bit string </p> </dd> </dl> <p> </p> </div> <a name='function.imap-binary.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a base64 encoded string. </p> </div> <a name='function.imap-binary.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-base64.php' class='function' rel='rdfs-seeAlso'>imap_base64()</a> - Decode BASE64 encoded text</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_base64" value="<div id='function.imap-base64' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-base64.php'>imap_base64</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_base64</span> &amp;mdash; <span class='dc-title'>Decode BASE64 encoded text</span></p> </div> <a name='function.imap-base64.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_base64</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text</tt></span> )</div> <p class='para rdfs-comment'> Decodes the given BASE-64 encoded <i><tt class='parameter'>text</tt></i> . </p> </div> <a name='function.imap-base64.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The encoded text </p> </dd> </dl> <p> </p> </div> <a name='function.imap-base64.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the decoded message as a string. </p> </div> <a name='function.imap-base64.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-binary.php' class='function' rel='rdfs-seeAlso'>imap_binary()</a> - Convert an 8bit string to a base64 string</li> <li class='member'><a href='http://www.php.net/manual/en/function.base64-encode.php' class='function' rel='rdfs-seeAlso'>base64_encode()</a> - Encodes data with MIME base64</li> <li class='member'><a href='http://www.php.net/manual/en/function.base64-decode.php' class='function' rel='rdfs-seeAlso'>base64_decode()</a> - Decodes data encoded with MIME base64</li> <li class='member'><a href='http://www.faqs.org/rfcs/rfc2045' class='link external'>&amp;raquo; RFC2045</a>, Section 6.8</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_append" value="<div id='function.imap-append' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-append.php'>imap_append</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_append</span> &amp;mdash; <span class='dc-title'>Append a string message to a specified mailbox</span></p> </div> <a name='function.imap-append.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>imap_append</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$imap_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mailbox</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$message</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$options</tt><span class='initializer'> = NULL</span></span> ] )</div> <p class='para rdfs-comment'> Appends a string <i><tt class='parameter'>message</tt></i> to the specified <i><tt class='parameter'>mailbox</tt></i> . </p> </div> <a name='function.imap-append.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> imap_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An IMAP stream returned by <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mailbox</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mailbox name, see <a href='http://www.php.net/manual/en/function.imap-open.php' class='function'>imap_open()</a> for more information </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>message</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message to be append, as a string </p> <p class='para'> When talking to the Cyrus IMAP server, you must use &amp;quot;\r\n&amp;quot; as your end-of-line terminator instead of &amp;quot;\n&amp;quot; or the operation will fail </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If provided, the <i><tt class='parameter'>options</tt></i> will also be written to the <i><tt class='parameter'>mailbox</tt></i> </p> </dd> </dl> <p> </p> </div> <a name='function.imap-append.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imap-append.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imap_append()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$stream&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_open</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'{imap.example.org}INBOX.Drafts'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$check&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_check</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stream</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Msg&amp;nbsp;Count&amp;nbsp;before&amp;nbsp;append:&amp;nbsp;'</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Nmsgs&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>imap_append</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stream</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'{imap.example.org}INBOX.Drafts'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'From:&amp;nbsp;me@example.com\r\n'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'To:&amp;nbsp;you@example.com\r\n'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'Subject:&amp;nbsp;test\r\n'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\r\n'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'this&amp;nbsp;is&amp;nbsp;a&amp;nbsp;test&amp;nbsp;message,&amp;nbsp;please&amp;nbsp;ignore\r\n'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$check&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imap_check</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stream</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Msg&amp;nbsp;Count&amp;nbsp;after&amp;nbsp;append&amp;nbsp;:&amp;nbsp;'</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$check</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Nmsgs&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>imap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stream</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_alerts" value="<div id='function.imap-alerts' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-alerts.php'>imap_alerts</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_alerts</span> &amp;mdash; <span class='dc-title'>Returns all IMAP alert messages that have occurred</span></p> </div> <a name='function.imap-alerts.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imap_alerts</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns all of the <acronym title='Internet Message Access Protocol'>IMAP</acronym> alert messages generated since the last <b>imap_alerts()</b> call, or the beginning of the page. </p> <p class='para'> When <b>imap_alerts()</b> is called, the alert stack is subsequently cleared. The <acronym title='Internet Message Access Protocol'>IMAP</acronym> specification requires that these messages be passed to the user. </p> </div> <a name='function.imap-alerts.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of all of the IMAP alert messages generated or <b><tt class='constant'>FALSE</tt></b> if no alert messages are available. </p> </div> <a name='function.imap-alerts.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-errors.php' class='function' rel='rdfs-seeAlso'>imap_errors()</a> - Returns all of the IMAP errors that have occured</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="imap_8bit" value="<div id='function.imap-8bit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imap-8bit.php'>imap_8bit</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imap_8bit</span> &amp;mdash; <span class='dc-title'>Convert an 8bit string to a quoted-printable string</span></p> </div> <a name='function.imap-8bit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>imap_8bit</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> )</div> <p class='para rdfs-comment'> Convert an 8bit string to a quoted-printable string (according to <a href='http://www.faqs.org/rfcs/rfc2045' class='link external'>&amp;raquo; RFC2045</a>, section 6.7). </p> </div> <a name='function.imap-8bit.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The 8bit string to convert </p> </dd> </dl> <p> </p> </div> <a name='function.imap-8bit.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a quoted-printable string. </p> </div> <a name='function.imap-8bit.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-qprint.php' class='function' rel='rdfs-seeAlso'>imap_qprint()</a> - Convert a quoted-printable string to an 8 bit string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="iconv_substr" value="<div id='function.iconv-substr' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iconv-substr.php'>iconv_substr</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>iconv_substr</span> &amp;mdash; <span class='dc-title'>Cut out part of a string</span></p> </div> <a name='function.iconv-substr.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>iconv_substr</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt><span class='initializer'> = ini_set(&amp;quot;iconv.internal_encoding&amp;quot;)</span></span> ]] )</div> <p class='para rdfs-comment'> Cuts a portion of <i><tt class='parameter'>str</tt></i> specified by the <i><tt class='parameter'>offset</tt></i> and <i><tt class='parameter'>length</tt></i> parameters. </p> </div> <a name='function.iconv-substr.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>str</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The original string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>offset</tt></i> is non-negative, <b>iconv_substr()</b> cuts the portion out of <i><tt class='parameter'>str</tt></i> beginning at <i><tt class='parameter'>offset</tt></i> &amp;#039;th character, counting from zero. </p> <p class='para'> If <i><tt class='parameter'>offset</tt></i> is negative, <b>iconv_substr()</b> cuts out the portion beginning at the position, <i><tt class='parameter'>offset</tt></i> characters away from the end of <i><tt class='parameter'>str</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>length</tt></i> is given and is positive, the return value will contain at most <i><tt class='parameter'>length</tt></i> characters of the portion that begins at <i><tt class='parameter'>offset</tt></i> (depending on the length of <i><tt class='parameter'>string</tt></i> ). </p> <p class='para'> If negative <i><tt class='parameter'>length</tt></i> is passed, <b>iconv_substr()</b> cuts the portion out of <i><tt class='parameter'>str</tt></i> from the <i><tt class='parameter'>offset</tt></i> &amp;#039;th character up to the character that is <i><tt class='parameter'>length</tt></i> characters away from the end of the string. In case <i><tt class='parameter'>offset</tt></i> is also negative, the start position is calculated beforehand according to the rule explained above. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>charset</tt></i> parameter is omitted, <i><tt class='parameter'>string</tt></i> are assumed to be encoded in <a href='http://www.php.net/manual/en/iconv.configuration.php' class='link'>iconv.internal_encoding</a>. </p> <p class='para'> Note that <i><tt class='parameter'>offset</tt></i> and <i><tt class='parameter'>length</tt></i> parameters are always deemed to represent offsets that are calculated on the basis of the character set determined by <i><tt class='parameter'>charset</tt></i> , whilst the counterpart <a href='http://www.php.net/manual/en/function.substr.php' class='function'>substr()</a> always takes these for byte offsets. </p> </dd> </dl> <p> </p> </div> <a name='function.iconv-substr.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the portion of <i><tt class='parameter'>str</tt></i> specified by the <i><tt class='parameter'>offset</tt></i> and <i><tt class='parameter'>length</tt></i> parameters. </p> <p class='para'> If <i><tt class='parameter'>str</tt></i> is shorter than <i><tt class='parameter'>offset</tt></i> characters long, <b><tt class='constant'>FALSE</tt></b> will be returned. </p> </div> <a name='function.iconv-substr.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.substr.php' class='function' rel='rdfs-seeAlso'>substr()</a> - Return part of a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-substr.php' class='function' rel='rdfs-seeAlso'>mb_substr()</a> - Get part of string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-strcut.php' class='function' rel='rdfs-seeAlso'>mb_strcut()</a> - Get part of string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="iconv_strrpos" value="<div id='function.iconv-strrpos' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iconv-strrpos.php'>iconv_strrpos</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>iconv_strrpos</span> &amp;mdash; <span class='dc-title'>Finds the last occurrence of a needle within a haystack</span></p> </div> <a name='function.iconv-strrpos.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>iconv_strrpos</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$haystack</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$needle</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt><span class='initializer'> = ini_set(&amp;quot;iconv.internal_encoding&amp;quot;)</span></span> ] )</div> <p class='para rdfs-comment'> In contrast to <a href='http://www.php.net/manual/en/function.strpos.php' class='function'>strpos()</a>, the return value of <b>iconv_strrpos()</b> is the number of characters that appear before the needle, rather than the offset in bytes to the position where the needle has been found. </p> </div> <a name='function.iconv-strrpos.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>haystack</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The entire string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The searched substring. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>charset</tt></i> parameter is omitted, <i><tt class='parameter'>string</tt></i> are assumed to be encoded in <a href='http://www.php.net/manual/en/iconv.configuration.php' class='link'>iconv.internal_encoding</a>. </p> </dd> </dl> <p> </p> <p class='para'> If <i><tt class='parameter'>haystack</tt></i> or <i><tt class='parameter'>needle</tt></i> is not a string, it is converted to a string and applied as the ordinal value of a character. </p> </div> <a name='function.iconv-strrpos.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the numeric position of the last occurrence of <i><tt class='parameter'>needle</tt></i> in <i><tt class='parameter'>haystack</tt></i> . The characters are counted on the basis of the specified character set <i><tt class='parameter'>charset</tt></i> . </p> <p class='para'> If <i><tt class='parameter'>needle</tt></i> is not found, <b>iconv_strrpos()</b> will return <b><tt class='constant'>FALSE</tt></b>. </p> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function may return Boolean <b><tt class='constant'>FALSE</tt></b>, but may also return a non-Boolean value which evaluates to <b><tt class='constant'>FALSE</tt></b>, such as <i>0</i> or &amp;quot;&amp;quot;. Please read the section on <a href='http://www.php.net/manual/en/language.types.boolean.php' class='link'>Booleans</a> for more information. Use <a href='http://www.php.net/manual/en/language.operators.comparison.php' class='link'>the === operator</a> for testing the return value of this function.</p></div> </div> <a name='function.iconv-strrpos.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.strrpos.php' class='function' rel='rdfs-seeAlso'>strrpos()</a> - Find position of last occurrence of a char in a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.iconv-strpos.php' class='function' rel='rdfs-seeAlso'>iconv_strpos()</a> - Finds position of first occurrence of a needle within a haystack</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-strrpos.php' class='function' rel='rdfs-seeAlso'>mb_strrpos()</a> - Find position of last occurrence of a string in a string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="iconv_strpos" value="<div id='function.iconv-strpos' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iconv-strpos.php'>iconv_strpos</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>iconv_strpos</span> &amp;mdash; <span class='dc-title'>Finds position of first occurrence of a needle within a haystack</span></p> </div> <a name='function.iconv-strpos.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>iconv_strpos</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$haystack</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$needle</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt><span class='initializer'> = ini_set(&amp;quot;iconv.internal_encoding&amp;quot;)</span></span> ]] )</div> <p class='para rdfs-comment'> Finds position of first occurrence of a needle within a haystack. </p> <p class='para'> In contrast to <a href='http://www.php.net/manual/en/function.strpos.php' class='function'>strpos()</a>, the return value of <b>iconv_strpos()</b> is the number of characters that appear before the needle, rather than the offset in bytes to the position where the needle has been found. The characters are counted on the basis of the specified character set <i><tt class='parameter'>charset</tt></i> . </p> </div> <a name='function.iconv-strpos.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>haystack</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The entire string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The searched substring. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional <i><tt class='parameter'>offset</tt></i> parameter specifies the position from which the search should be performed. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>charset</tt></i> parameter is omitted, <i><tt class='parameter'>string</tt></i> are assumed to be encoded in <a href='http://www.php.net/manual/en/iconv.configuration.php' class='link'>iconv.internal_encoding</a>. </p> </dd> </dl> <p> </p> <p class='para'> If <i><tt class='parameter'>haystack</tt></i> or <i><tt class='parameter'>needle</tt></i> is not a string, it is converted to a string and applied as the ordinal value of a character. </p> </div> <a name='function.iconv-strpos.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the numeric position of the first occurrence of <i><tt class='parameter'>needle</tt></i> in <i><tt class='parameter'>haystack</tt></i> . </p> <p class='para'> If <i><tt class='parameter'>needle</tt></i> is not found, <b>iconv_strpos()</b> will return <b><tt class='constant'>FALSE</tt></b>. </p> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function may return Boolean <b><tt class='constant'>FALSE</tt></b>, but may also return a non-Boolean value which evaluates to <b><tt class='constant'>FALSE</tt></b>, such as <i>0</i> or &amp;quot;&amp;quot;. Please read the section on <a href='http://www.php.net/manual/en/language.types.boolean.php' class='link'>Booleans</a> for more information. Use <a href='http://www.php.net/manual/en/language.operators.comparison.php' class='link'>the === operator</a> for testing the return value of this function.</p></div> </div> <a name='function.iconv-strpos.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.strpos.php' class='function' rel='rdfs-seeAlso'>strpos()</a> - Find position of first occurrence of a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.iconv-strrpos.php' class='function' rel='rdfs-seeAlso'>iconv_strrpos()</a> - Finds the last occurrence of a needle within a haystack</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-strpos.php' class='function' rel='rdfs-seeAlso'>mb_strpos()</a> - Find position of first occurrence of string in a string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="iconv_strlen" value="<div id='function.iconv-strlen' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iconv-strlen.php'>iconv_strlen</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>iconv_strlen</span> &amp;mdash; <span class='dc-title'>Returns the character count of string</span></p> </div> <a name='function.iconv-strlen.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>iconv_strlen</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt><span class='initializer'> = ini_set(&amp;quot;iconv.internal_encoding&amp;quot;)</span></span> ] )</div> <p class='para rdfs-comment'> In contrast to <a href='http://www.php.net/manual/en/function.strlen.php' class='function'>strlen()</a>, <b>iconv_strlen()</b> counts the occurrences of characters in the given byte sequence <i><tt class='parameter'>str</tt></i> on the basis of the specified character set, the result of which is not necessarily identical to the length of the string in byte. </p> </div> <a name='function.iconv-strlen.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>str</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>charset</tt></i> parameter is omitted, <i><tt class='parameter'>str</tt></i> is assumed to be encoded in <a href='http://www.php.net/manual/en/iconv.configuration.php' class='link'>iconv.internal_encoding</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.iconv-strlen.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the character count of <i><tt class='parameter'>str</tt></i> , as an integer. </p> </div> <a name='function.iconv-strlen.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.strlen.php' class='function' rel='rdfs-seeAlso'>strlen()</a> - Get string length</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-strlen.php' class='function' rel='rdfs-seeAlso'>mb_strlen()</a> - Get string length</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="iconv_set_encoding" value="<div id='function.iconv-set-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iconv-set-encoding.php'>iconv_set_encoding</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>iconv_set_encoding</span> &amp;mdash; <span class='dc-title'>Set current setting for character encoding conversion</span></p> </div> <a name='function.iconv-set-encoding.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>iconv_set_encoding</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$type</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> )</div> <p class='para rdfs-comment'> Changes the value of the internal configuration variable specified by <i><tt class='parameter'>type</tt></i> to <i><tt class='parameter'>charset</tt></i> . </p> </div> <a name='function.iconv-set-encoding.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value of <i><tt class='parameter'>type</tt></i> can be any one of those: </p><ul class='simplelist'> <li class='member'>input_encoding</li> <li class='member'>output_encoding</li> <li class='member'>internal_encoding</li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The character set. </p> </dd> </dl> <p> </p> </div> <a name='function.iconv-set-encoding.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.iconv-set-encoding.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>iconv_set_encoding()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />iconv_set_encoding</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'internal_encoding'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>iconv_set_encoding</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'output_encoding'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ISO-8859-1'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.iconv-set-encoding.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.iconv-get-encoding.php' class='function' rel='rdfs-seeAlso'>iconv_get_encoding()</a> - Retrieve internal configuration variables of iconv extension</li> <li class='member'><a href='http://www.php.net/manual/en/function.ob-iconv-handler.php' class='function' rel='rdfs-seeAlso'>ob_iconv_handler()</a> - Convert character encoding as output buffer handler</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="iconv_mime_encode" value="<div id='function.iconv-mime-encode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iconv-mime-encode.php'>iconv_mime_encode</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>iconv_mime_encode</span> &amp;mdash; <span class='dc-title'>Composes a <i>MIME</i> header field</span></p> </div> <a name='function.iconv-mime-encode.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>iconv_mime_encode</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$field_name</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$field_value</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$preferences</tt><span class='initializer'> = NULL</span></span> ] )</div> <p class='para rdfs-comment'> Composes and returns a string that represents a valid <i>MIME</i> header field, which looks like the following: <div class='example-contents screen'> <div class='cdata'><pre> Subject: =?ISO-8859-1?Q?Pr=FCfung_f=FCr?= Entwerfen von einer MIME kopfzeile </pre></div> </div> In the above example, &amp;quot;Subject&amp;quot; is the field name and the portion that begins with &amp;quot;=?ISO-8859-1?...&amp;quot; is the field value. </p> </div> <a name='function.iconv-mime-encode.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_value</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field value. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>preferences</tt></i> </span> </dt><dd class='listitem'> <p class='para'> You can control the behaviour of <b>iconv_mime_encode()</b> by specifying an associative array that contains configuration items to the optional third parameter <i><tt class='parameter'>preferences</tt></i> . The items supported by <b>iconv_mime_encode()</b> are listed below. Note that item names are treated case-sensitive. </p><table class='doctable table'> <caption><b>Configuration items supported by <b>iconv_mime_encode()</b></b></caption> <thead valign='middle'> <tr valign='middle'> <th>Item</th> <th>Type</th> <th>Description</th> <th>Default value</th> <th>Example</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>scheme</td> <td align='left'><a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a></td> <td align='left'> Specifies the method to encode a field value by. The value of this item may be either &amp;quot;B&amp;quot; or &amp;quot;Q&amp;quot;, where &amp;quot;B&amp;quot; stands for <i>base64</i> encoding scheme and &amp;quot;Q&amp;quot; stands for <i>quoted-printable</i> encoding scheme. </td> <td align='left'>B</td> <td align='left'>B</td> </tr> <tr valign='middle'> <td align='left'>input-charset</td> <td align='left'><a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a></td> <td align='left'> Specifies the character set in which the first parameter <i><tt class='parameter'>field_name</tt></i> and the second parameter <i><tt class='parameter'>field_value</tt></i> are presented. If not given, <b>iconv_mime_encode()</b> assumes those parameters are presented to it in the <a href='http://www.php.net/manual/en/iconv.configuration.php' class='link'>iconv.internal_encoding</a> ini setting. </td> <td align='left'> <a href='http://www.php.net/manual/en/iconv.configuration.php' class='link'>iconv.internal_encoding</a> </td> <td align='left'>ISO-8859-1</td> </tr> <tr valign='middle'> <td align='left'>output-charset</td> <td align='left'><a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a></td> <td align='left'> Specifies the character set to use to compose the <i>MIME</i> header. If not given, the same value as <i>input-charset</i> will be used. </td> <td align='left'> <a href='http://www.php.net/manual/en/iconv.configuration.php' class='link'>iconv.internal_encoding</a> </td> <td align='left'>UTF-8</td> </tr> <tr valign='middle'> <td align='left'>line-length</td> <td align='left'><a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a></td> <td align='left'> Specifies the maximum length of the header lines. The resulting header is &amp;quot;folded&amp;quot; to a set of multiple lines in case the resulting header field would be longer than the value of this parameter, according to <a href='http://www.faqs.org/rfcs/rfc2822' class='link external'>&amp;raquo; RFC2822 - Internet Message Format</a>. If not given, the length will be limited to 76 characters. </td> <td align='left'>76</td> <td align='left'>996</td> </tr> <tr valign='middle'> <td align='left'>line-break-chars</td> <td align='left'><a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a></td> <td align='left'> Specifies the sequence of characters to append to each line as an end-of-line sign when &amp;quot;folding&amp;quot; is performed on a long header field. If not given, this defaults to &amp;quot;\r\n&amp;quot; (<i>CR</i> <i>LF</i>). Note that this parameter is always treated as an ASCII string regardless of the value of <i>input-charset</i>. </td> <td align='left'>\r\n</td> <td align='left'>\n</td> </tr> </tbody> </table> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.iconv-mime-encode.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an encoded <i>MIME</i> field on success, or <b><tt class='constant'>FALSE</tt></b> if an error occurs during the encoding. </p> </div> <a name='function.iconv-mime-encode.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>iconv_mime_encode()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$preferences&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'input-charset'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'ISO-8859-1'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'output-charset'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'line-length'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>76</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'line-break-chars'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'\n'<br /></span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$preferences</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'scheme'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'Q'</span><span style='color: #007700'>;<br /></span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;yields&amp;nbsp;'Subject:&amp;nbsp;=?UTF-8?Q?Pr=C3=BCfung_Pr=C3=BCfung?='<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>iconv_mime_encode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Subject'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Pr&amp;Atilde;&amp;frac14;fung&amp;nbsp;Pr&amp;Atilde;&amp;frac14;fung'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$preferences</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$preferences</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'scheme'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'B'</span><span style='color: #007700'>;<br /></span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;yields&amp;nbsp;'Subject:&amp;nbsp;=?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?='<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>iconv_mime_encode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Subject'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Pr&amp;Atilde;&amp;frac14;fung&amp;nbsp;Pr&amp;Atilde;&amp;frac14;fung'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$preferences</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.iconv-mime-encode.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.imap-binary.php' class='function' rel='rdfs-seeAlso'>imap_binary()</a> - Convert an 8bit string to a base64 string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-encode-mimeheader.php' class='function' rel='rdfs-seeAlso'>mb_encode_mimeheader()</a> - Encode string for MIME header</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-8bit.php' class='function' rel='rdfs-seeAlso'>imap_8bit()</a> - Convert an 8bit string to a quoted-printable string</li> <li class='member'><a href='http://www.php.net/manual/en/function.quoted-printable-encode.php' class='function' rel='rdfs-seeAlso'>quoted_printable_encode()</a> - Convert a 8 bit string to a quoted-printable string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="iconv_mime_decode_headers" value="<div id='function.iconv-mime-decode-headers' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iconv-mime-decode-headers.php'>iconv_mime_decode_headers</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>iconv_mime_decode_headers</span> &amp;mdash; <span class='dc-title'>Decodes multiple <i>MIME</i> header fields at once</span></p> </div> <a name='function.iconv-mime-decode-headers.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>iconv_mime_decode_headers</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoded_headers</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt><span class='initializer'> = ini_set(&amp;quot;iconv.internal_encoding&amp;quot;)</span></span> ]] )</div> <p class='para rdfs-comment'> Decodes multiple <i>MIME</i> header fields at once. </p> </div> <a name='function.iconv-mime-decode-headers.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoded_headers</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The encoded headers, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>mode</tt></i> determines the behaviour in the event <b>iconv_mime_decode_headers()</b> encounters a malformed <i>MIME</i> header field. You can specify any combination of the following bitmasks. </p><table class='doctable table'> <caption><b>Bitmasks acceptable to <b>iconv_mime_decode_headers()</b></b></caption> <thead valign='middle'> <tr valign='middle'> <th>Value</th> <th>Constant</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>1</td> <td align='left'>ICONV_MIME_DECODE_STRICT</td> <td align='left'> If set, the given header is decoded in full conformance with the standards defined in <a href='http://www.faqs.org/rfcs/rfc2047' class='link external'>&amp;raquo; RFC2047</a>. This option is disabled by default because there are a lot of broken mail user agents that don&amp;#039;t follow the specification and don&amp;#039;t produce correct <i>MIME</i> headers. </td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</td> <td align='left'> If set, <b>iconv_mime_decode_headers()</b> attempts to ignore any grammatical errors and continue to process a given header. </td> </tr> </tbody> </table> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional <i><tt class='parameter'>charset</tt></i> parameter specifies the character set to represent the result by. If omitted, <a href='http://www.php.net/manual/en/iconv.configuration.php' class='link'>iconv.internal_encoding</a> will be used. </p> </dd> </dl> <p> </p> </div> <a name='function.iconv-mime-decode-headers.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array that holds a whole set of <i>MIME</i> header fields specified by <i><tt class='parameter'>encoded_headers</tt></i> on success, or <b><tt class='constant'>FALSE</tt></b> if an error occurs during the decoding. </p> <p class='para'> Each key of the return value represents an individual field name and the corresponding element represents a field value. If more than one field of the same name are present, <b>iconv_mime_decode_headers()</b> automatically incorporates them into a numerically indexed array in the order of occurrence. </p> </div> <a name='function.iconv-mime-decode-headers.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>iconv_mime_decode_headers()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$headers_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;EOF<br /></span><span style='color: #DD0000'>Subject:&amp;nbsp;=?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?=<br />To:&amp;nbsp;example@example.com<br />Date:&amp;nbsp;Thu,&amp;nbsp;1&amp;nbsp;Jan&amp;nbsp;1970&amp;nbsp;00:00:00&amp;nbsp;+0000<br />Message-Id:&amp;nbsp;&amp;lt;example@example.com&amp;gt;<br />Received:&amp;nbsp;from&amp;nbsp;localhost&amp;nbsp;(localhost&amp;nbsp;[127.0.0.1])&amp;nbsp;by&amp;nbsp;localhost<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;with&amp;nbsp;SMTP&amp;nbsp;id&amp;nbsp;example&amp;nbsp;for&amp;nbsp;&amp;lt;example@example.com&amp;gt;;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;Thu,&amp;nbsp;1&amp;nbsp;Jan&amp;nbsp;1970&amp;nbsp;00:00:00&amp;nbsp;+0000&amp;nbsp;(UTC)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;(envelope-from&amp;nbsp;example-return-0000-example=example.com@example.com)<br />Received:&amp;nbsp;(qmail&amp;nbsp;0&amp;nbsp;invoked&amp;nbsp;by&amp;nbsp;uid&amp;nbsp;65534);&amp;nbsp;1&amp;nbsp;Thu&amp;nbsp;2003&amp;nbsp;00:00:00&amp;nbsp;+0000<br /><br /></span><span style='color: #007700'>EOF;<br /><br /></span><span style='color: #0000BB'>$headers&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>iconv_mime_decode_headers</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$headers_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ISO-8859-1'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$headers</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Array ( [Subject] =&amp;gt; Pr&amp;Atilde;&amp;frac14;fung Pr&amp;Atilde;&amp;frac14;fung [To] =&amp;gt; example@example.com [Date] =&amp;gt; Thu, 1 Jan 1970 00:00:00 +0000 [Message-Id] =&amp;gt; &amp;lt;example@example.com&amp;gt; [Received] =&amp;gt; Array ( [0] =&amp;gt; from localhost (localhost [127.0.0.1]) by localhost with SMTP id example for &amp;lt;example@example.com&amp;gt;; Thu, 1 Jan 1970 00:00:00 +0000 (UTC) (envelope-from example-return-0000-example=example.com@example.com) [1] =&amp;gt; (qmail 0 invoked by uid 65534); 1 Thu 2003 00:00:00 +0000 ) ) </pre></div> </div> </div><p> </p> </div> <a name='function.iconv-mime-decode-headers.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.iconv-mime-decode.php' class='function' rel='rdfs-seeAlso'>iconv_mime_decode()</a> - Decodes a MIME header field</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-decode-mimeheader.php' class='function' rel='rdfs-seeAlso'>mb_decode_mimeheader()</a> - Decode string in MIME header field</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-mime-header-decode.php' class='function' rel='rdfs-seeAlso'>imap_mime_header_decode()</a> - Decode MIME header elements</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-base64.php' class='function' rel='rdfs-seeAlso'>imap_base64()</a> - Decode BASE64 encoded text</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-qprint.php' class='function' rel='rdfs-seeAlso'>imap_qprint()</a> - Convert a quoted-printable string to an 8 bit string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="iconv_mime_decode" value="<div id='function.iconv-mime-decode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iconv-mime-decode.php'>iconv_mime_decode</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>iconv_mime_decode</span> &amp;mdash; <span class='dc-title'>Decodes a <i>MIME</i> header field</span></p> </div> <a name='function.iconv-mime-decode.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>iconv_mime_decode</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoded_header</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt><span class='initializer'> = ini_set(&amp;quot;iconv.internal_encoding&amp;quot;)</span></span> ]] )</div> <p class='para rdfs-comment'> Decodes a <i>MIME</i> header field. </p> </div> <a name='function.iconv-mime-decode.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoded_header</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The encoded header, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>mode</tt></i> determines the behaviour in the event <b>iconv_mime_decode()</b> encounters a malformed <i>MIME</i> header field. You can specify any combination of the following bitmasks. </p><table class='doctable table'> <caption><b>Bitmasks acceptable to <b>iconv_mime_decode()</b></b></caption> <thead valign='middle'> <tr valign='middle'> <th>Value</th> <th>Constant</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>1</td> <td align='left'>ICONV_MIME_DECODE_STRICT</td> <td align='left'> If set, the given header is decoded in full conformance with the standards defined in <a href='http://www.faqs.org/rfcs/rfc2047' class='link external'>&amp;raquo; RFC2047</a>. This option is disabled by default because there are a lot of broken mail user agents that don&amp;#039;t follow the specification and don&amp;#039;t produce correct <i>MIME</i> headers. </td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</td> <td align='left'> If set, <a href='http://www.php.net/manual/en/function.iconv-mime-decode-headers.php' class='function'>iconv_mime_decode_headers()</a> attempts to ignore any grammatical errors and continue to process a given header. </td> </tr> </tbody> </table> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional <i><tt class='parameter'>charset</tt></i> parameter specifies the character set to represent the result by. If omitted, <a href='http://www.php.net/manual/en/iconv.configuration.php' class='link'>iconv.internal_encoding</a> will be used. </p> </dd> </dl> <p> </p> </div> <a name='function.iconv-mime-decode.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a decoded <i>MIME</i> field on success, or <b><tt class='constant'>FALSE</tt></b> if an error occurs during the decoding. </p> </div> <a name='function.iconv-mime-decode.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>iconv_mime_decode()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;yields&amp;nbsp;'Subject:&amp;nbsp;Pr&amp;Atilde;&amp;frac14;fung&amp;nbsp;Pr&amp;Atilde;&amp;frac14;fung'<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>iconv_mime_decode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Subject:&amp;nbsp;=?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?='</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ISO-8859-1'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.iconv-mime-decode.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.iconv-mime-decode-headers.php' class='function' rel='rdfs-seeAlso'>iconv_mime_decode_headers()</a> - Decodes multiple MIME header fields at once</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-decode-mimeheader.php' class='function' rel='rdfs-seeAlso'>mb_decode_mimeheader()</a> - Decode string in MIME header field</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-mime-header-decode.php' class='function' rel='rdfs-seeAlso'>imap_mime_header_decode()</a> - Decode MIME header elements</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-base64.php' class='function' rel='rdfs-seeAlso'>imap_base64()</a> - Decode BASE64 encoded text</li> <li class='member'><a href='http://www.php.net/manual/en/function.imap-qprint.php' class='function' rel='rdfs-seeAlso'>imap_qprint()</a> - Convert a quoted-printable string to an 8 bit string</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="iconv_get_encoding" value="<div id='function.iconv-get-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iconv-get-encoding.php'>iconv_get_encoding</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>iconv_get_encoding</span> &amp;mdash; <span class='dc-title'>Retrieve internal configuration variables of iconv extension</span></p> </div> <a name='function.iconv-get-encoding.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>iconv_get_encoding</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$type</tt><span class='initializer'> = &amp;quot;all&amp;quot;</span></span> ] )</div> <p class='para rdfs-comment'> Retrieve internal configuration variables of iconv extension. </p> </div> <a name='function.iconv-get-encoding.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value of the optional <i><tt class='parameter'>type</tt></i> can be: </p><ul class='simplelist'> <li class='member'>all</li> <li class='member'>input_encoding</li> <li class='member'>output_encoding</li> <li class='member'>internal_encoding</li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.iconv-get-encoding.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the current value of the internal configuration variable if successful, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> If <i><tt class='parameter'>type</tt></i> is omitted or set to &amp;quot;all&amp;quot;, <b>iconv_get_encoding()</b> returns an array that stores all these variables. </p> </div> <a name='function.iconv-get-encoding.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>iconv_get_encoding()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> &amp;lt;pre&amp;gt;<br /><span style='color: #0000BB'>&amp;lt;?php<br />iconv_set_encoding</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'internal_encoding'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>iconv_set_encoding</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'output_encoding'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ISO-8859-1'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>iconv_get_encoding</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'all'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>?&amp;gt;<br /></span>&amp;lt;/pre&amp;gt;</span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Array ( [input_encoding] =&amp;gt; ISO-8859-1 [output_encoding] =&amp;gt; ISO-8859-1 [internal_encoding] =&amp;gt; UTF-8 ) </pre></div> </div> </div><p> </p> </div> <a name='function.iconv-get-encoding.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.iconv-set-encoding.php' class='function' rel='rdfs-seeAlso'>iconv_set_encoding()</a> - Set current setting for character encoding conversion</li> <li class='member'><a href='http://www.php.net/manual/en/function.ob-iconv-handler.php' class='function' rel='rdfs-seeAlso'>ob_iconv_handler()</a> - Convert character encoding as output buffer handler</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="iconv" value="<div id='function.iconv' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iconv.php'>iconv</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>iconv</span> &amp;mdash; <span class='dc-title'>Convert string to requested character encoding</span></p> </div> <a name='function.iconv.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>iconv</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$in_charset</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$out_charset</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str</tt></span> )</div> <p class='para rdfs-comment'> Performs a character set conversion on the string <i><tt class='parameter'>str</tt></i> from <i><tt class='parameter'>in_charset</tt></i> to <i><tt class='parameter'>out_charset</tt></i> . </p> </div> <a name='function.iconv.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>in_charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The input charset. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>out_charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The output charset. </p> <p class='para'> If you append the string <i>//TRANSLIT</i> to <i><tt class='parameter'>out_charset</tt></i> transliteration is activated. This means that when a character can&amp;#039;t be represented in the target charset, it can be approximated through one or several similarly looking characters. If you append the string <i>//IGNORE</i>, characters that cannot be represented in the target charset are silently discarded. Otherwise, <i><tt class='parameter'>str</tt></i> is cut from the first illegal character and an <b><tt class='constant'>E_NOTICE</tt></b> is generated. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>str</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to be converted. </p> </dd> </dl> <p> </p> </div> <a name='function.iconv.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the converted string or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.iconv.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>iconv()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$text&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'This&amp;nbsp;is&amp;nbsp;the&amp;nbsp;Euro&amp;nbsp;symbol&amp;nbsp;'&amp;acirc;&amp;#130;&amp;not;'.'</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Original&amp;nbsp;:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'TRANSLIT&amp;nbsp;:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>iconv</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ISO-8859-1//TRANSLIT'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'IGNORE&amp;nbsp;&amp;nbsp;&amp;nbsp;:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>iconv</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ISO-8859-1//IGNORE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Plain&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>iconv</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ISO-8859-1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Original : This is the Euro symbol &amp;#039;&amp;acirc;&amp;#130;&amp;not;&amp;#039;. TRANSLIT : This is the Euro symbol &amp;#039;EUR&amp;#039;. IGNORE : This is the Euro symbol &amp;#039;&amp;#039;. Plain : Notice: iconv(): Detected an illegal character in input string in .\iconv-example.php on line 7 This is the Euro symbol &amp;#039; </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gregoriantojd" value="<div id='function.gregoriantojd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gregoriantojd.php'>GregorianToJD</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>GregorianToJD</span> &amp;mdash; <span class='dc-title'>Converts a Gregorian date to Julian Day Count</span></p> </div> <a name='function.gregoriantojd.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gregoriantojd</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$month</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$day</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$year</tt></span> )</div> <p class='para rdfs-comment'> Valid Range for Gregorian Calendar 4714 B.C. to 9999 A.D.</p> <p class='para'> Although this function can handle dates all the way back to 4714 B.C., such use may not be meaningful. The Gregorian calendar was not instituted until October 15, 1582 (or October 5, 1582 in the Julian calendar). Some countries did not accept it until much later. For example, Britain converted in 1752, The USSR in 1918 and Greece in 1923. Most European countries used the Julian calendar prior to the Gregorian. </p> </div> <a name='function.gregoriantojd.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>month</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The month as a number from 1 (for January) to 12 (for December) </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>day</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The day as a number from 1 to 31 </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>year</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The year as a number between -4714 and 9999 </p> </dd> </dl> <p> </p> </div> <a name='function.gregoriantojd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The julian day for the given gregorian date as an integer. </p> </div> <a name='function.gregoriantojd.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Calendar functions</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$jd&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>GregorianToJD</span><span style='color: #007700'>(</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>11</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1970</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$jd</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$gregorian&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>JDToGregorian</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$jd</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$gregorian</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.gregoriantojd.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.jdtogregorian.php' class='function' rel='rdfs-seeAlso'>jdtogregorian()</a> - Converts Julian Day Count to Gregorian date</li> <li class='member'><a href='http://www.php.net/manual/en/function.cal-to-jd.php' class='function' rel='rdfs-seeAlso'>cal_to_jd()</a> - Converts from a supported calendar to Julian Day Count</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_xor" value="<div id='function.gmp-xor' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-xor.php'>gmp_xor</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_xor</span> &amp;mdash; <span class='dc-title'>Bitwise XOR</span></p> </div> <a name='function.gmp-xor.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_xor</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Calculates bitwise exclusive OR (XOR) of two GMP numbers. </p> </div> <a name='function.gmp-xor.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-xor.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-xor.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_xor()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$xor1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1101101110011101'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$xor2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0110011001011001'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$xor3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_xor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$xor1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$xor2</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$xor3</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1011110111000100 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_sub" value="<div id='function.gmp-sub' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-sub.php'>gmp_sub</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_sub</span> &amp;mdash; <span class='dc-title'>Subtract numbers</span></p> </div> <a name='function.gmp-sub.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_sub</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Subtracts <i><tt class='parameter'>b</tt></i> from <i><tt class='parameter'>a</tt></i> and returns the result. </p> </div> <a name='function.gmp-sub.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number being subtracted from. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number subtracted from <i><tt class='parameter'>a</tt></i> . </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-sub.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-sub.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_sub()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$sub&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_sub</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'281474976710656'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'4294967296'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;2^48&amp;nbsp;-&amp;nbsp;2^32<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sub</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 281470681743360 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_strval" value="<div id='function.gmp-strval' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-strval.php'>gmp_strval</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_strval</span> &amp;mdash; <span class='dc-title'>Convert GMP number to string</span></p> </div> <a name='function.gmp-strval.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>gmp_strval</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$gmpnumber</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$base</tt></span> ] )</div> <p class='para rdfs-comment'> Convert GMP number to string representation in base <i><tt class='parameter'>base</tt></i> . The default base is 10. </p> </div> <a name='function.gmp-strval.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>gmpnumber</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The GMP number that will be converted to a string. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>base</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The base of the returned number. The default base is 10. Allowed values for the base are from 2 to 36. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-strval.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The number, as a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.gmp-strval.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Converting a GMP number to a string</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0x41682179fbf5'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Decimal:&amp;nbsp;%s,&amp;nbsp;36-based:&amp;nbsp;%s'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,</span><span style='color: #0000BB'>36</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_sqrtrem" value="<div id='function.gmp-sqrtrem' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-sqrtrem.php'>gmp_sqrtrem</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_sqrtrem</span> &amp;mdash; <span class='dc-title'>Square root with remainder</span></p> </div> <a name='function.gmp-sqrtrem.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>gmp_sqrtrem</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> )</div> <p class='para rdfs-comment'> Calculate the square root of a number, with remainder. </p> </div> <a name='function.gmp-sqrtrem.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number being square rooted. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-sqrtrem.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns array where first element is the integer square root of <i><tt class='parameter'>a</tt></i> and the second is the remainder (i.e., the difference between <i><tt class='parameter'>a</tt></i> and the first element squared). </p> </div> <a name='function.gmp-sqrtrem.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_sqrtrem()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>list(</span><span style='color: #0000BB'>$sqrt1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sqrt1rem</span><span style='color: #007700'>)&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>gmp_sqrtrem</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'9'</span><span style='color: #007700'>);<br />list(</span><span style='color: #0000BB'>$sqrt2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sqrt2rem</span><span style='color: #007700'>)&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>gmp_sqrtrem</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'7'</span><span style='color: #007700'>);<br />list(</span><span style='color: #0000BB'>$sqrt3</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sqrt3rem</span><span style='color: #007700'>)&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>gmp_sqrtrem</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1048576'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sqrt1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>',&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sqrt1rem</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sqrt2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>',&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sqrt2rem</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sqrt3</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>',&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sqrt3rem</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 3, 0 2, 3 1024, 0 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_sqrt" value="<div id='function.gmp-sqrt' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-sqrt.php'>gmp_sqrt</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_sqrt</span> &amp;mdash; <span class='dc-title'>Calculate square root</span></p> </div> <a name='function.gmp-sqrt.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_sqrt</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> )</div> <p class='para rdfs-comment'> Calculates square root of <i><tt class='parameter'>a</tt></i> . </p> </div> <a name='function.gmp-sqrt.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-sqrt.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The integer portion of the square root, as a GMP number. </p> </div> <a name='function.gmp-sqrt.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_sqrt()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$sqrt1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_sqrt</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'9'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$sqrt2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_sqrt</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'7'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$sqrt3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_sqrt</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1524157875019052100'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sqrt1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sqrt2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sqrt3</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 3 2 1234567890 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_sign" value="<div id='function.gmp-sign' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-sign.php'>gmp_sign</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_sign</span> &amp;mdash; <span class='dc-title'>Sign of number</span></p> </div> <a name='function.gmp-sign.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gmp_sign</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> )</div> <p class='para rdfs-comment'> Checks the sign of a number. </p> </div> <a name='function.gmp-sign.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-sign.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns 1 if <i><tt class='parameter'>a</tt></i> is positive, -1 if <i><tt class='parameter'>a</tt></i> is negative, and 0 if <i><tt class='parameter'>a</tt></i> is zero. </p> </div> <a name='function.gmp-sign.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_sign()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;positive<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_sign</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'500'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;negative<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_sign</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'-500'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;zero<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_sign</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1 -1 0 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_setbit" value="<div id='function.gmp-setbit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-setbit.php'>gmp_setbit</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_setbit</span> &amp;mdash; <span class='dc-title'>Set bit</span></p> </div> <a name='function.gmp-setbit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>gmp_setbit</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$index</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$set_clear</tt><span class='initializer'> = true</span></span> ] )</div> <p class='para rdfs-comment'> Sets bit <i><tt class='parameter'>index</tt></i> in <i><tt class='parameter'>a</tt></i> . </p> </div> <a name='function.gmp-setbit.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number being set to. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The set bit. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>set_clear</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Defines if the bit is set to 0 or 1. By default the bit is set to 1. Index starts at 0. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-setbit.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-setbit.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_setbit()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0xfd'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>gmp_setbit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;index&amp;nbsp;starts&amp;nbsp;at&amp;nbsp;0<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 255 </pre></div> </div> </div><p> </p> </div> <a name='function.gmp-setbit.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Unlike most of the other GMP functions, <b>gmp_setbit()</b> must be called with a GMP resource that already exists (using <a href='http://www.php.net/manual/en/function.gmp-init.php' class='function'>gmp_init()</a> for example). One will not be automatically created. <br /> </p></blockquote> </div> <a name='function.gmp-setbit.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-clrbit.php' class='function' rel='rdfs-seeAlso'>gmp_clrbit()</a> - Clear bit</li> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-testbit.php' class='function' rel='rdfs-seeAlso'>gmp_testbit()</a> - Tests if a bit is set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_scan1" value="<div id='function.gmp-scan1' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-scan1.php'>gmp_scan1</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_scan1</span> &amp;mdash; <span class='dc-title'>Scan for 1</span></p> </div> <a name='function.gmp-scan1.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gmp_scan1</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$start</tt></span> )</div> <p class='para rdfs-comment'> Scans <i><tt class='parameter'>a</tt></i> , starting with bit <i><tt class='parameter'>start</tt></i> , towards more significant bits, until the first set bit is found. </p> </div> <a name='function.gmp-scan1.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number to scan. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>start</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The starting bit. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-scan1.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the index of the found bit, as an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a>. If no set bit is found, -1 is returned. </p> </div> <a name='function.gmp-scan1.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_scan1()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;'1'&amp;nbsp;bit&amp;nbsp;is&amp;nbsp;found&amp;nbsp;at&amp;nbsp;position&amp;nbsp;3.&amp;nbsp;index&amp;nbsp;starts&amp;nbsp;at&amp;nbsp;0<br /></span><span style='color: #0000BB'>$s1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'01000'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_scan1</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$s1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;'1'&amp;nbsp;bit&amp;nbsp;is&amp;nbsp;found&amp;nbsp;at&amp;nbsp;position&amp;nbsp;9.&amp;nbsp;index&amp;nbsp;starts&amp;nbsp;at&amp;nbsp;5<br /></span><span style='color: #0000BB'>$s2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'01000001111'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_scan1</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$s2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 3 9 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_scan0" value="<div id='function.gmp-scan0' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-scan0.php'>gmp_scan0</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_scan0</span> &amp;mdash; <span class='dc-title'>Scan for 0</span></p> </div> <a name='function.gmp-scan0.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gmp_scan0</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$start</tt></span> )</div> <p class='para rdfs-comment'> Scans <i><tt class='parameter'>a</tt></i> , starting with bit <i><tt class='parameter'>start</tt></i> , towards more significant bits, until the first clear bit is found. </p> </div> <a name='function.gmp-scan0.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number to scan. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>start</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The starting bit. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-scan0.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the index of the found bit, as an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a>. The index starts from 0. </p> </div> <a name='function.gmp-scan0.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_scan0()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;'0'&amp;nbsp;bit&amp;nbsp;is&amp;nbsp;found&amp;nbsp;at&amp;nbsp;position&amp;nbsp;3.&amp;nbsp;index&amp;nbsp;starts&amp;nbsp;at&amp;nbsp;0<br /></span><span style='color: #0000BB'>$s1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'10111'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_scan0</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$s1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;'0'&amp;nbsp;bit&amp;nbsp;is&amp;nbsp;found&amp;nbsp;at&amp;nbsp;position&amp;nbsp;7.&amp;nbsp;index&amp;nbsp;starts&amp;nbsp;at&amp;nbsp;5<br /></span><span style='color: #0000BB'>$s2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'101110000'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_scan0</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$s2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 3 7 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_random" value="<div id='function.gmp-random' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-random.php'>gmp_random</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_random</span> &amp;mdash; <span class='dc-title'>Random number</span></p> </div> <a name='function.gmp-random.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_random</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$limiter</tt><span class='initializer'> = 20</span></span> ] )</div> <p class='para rdfs-comment'> Generate a random number. The number will be between zero and the number of bits per limb multiplied by <i><tt class='parameter'>limiter</tt></i> . If <i><tt class='parameter'>limiter</tt></i> is negative, negative numbers are generated. </p> <p class='para'> A limb is an internal GMP mechanism. The number of bits in a limb is not static, and can vary from system to system. Generally, the number of bits in a limb is either 16 or 32, but this is not guaranteed. </p> </div> <a name='function.gmp-random.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>limiter</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The limiter. Defaults to 20. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-random.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A random GMP number. </p> </div> <a name='function.gmp-random.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_random()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$rand1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_random</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;random&amp;nbsp;number&amp;nbsp;from&amp;nbsp;0&amp;nbsp;to&amp;nbsp;1&amp;nbsp;*&amp;nbsp;bits&amp;nbsp;per&amp;nbsp;limb<br /></span><span style='color: #0000BB'>$rand2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_random</span><span style='color: #007700'>(</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;random&amp;nbsp;number&amp;nbsp;from&amp;nbsp;0&amp;nbsp;to&amp;nbsp;2&amp;nbsp;*&amp;nbsp;bits&amp;nbsp;per&amp;nbsp;limb<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$rand1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$rand2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1915834968 8642564075890328087 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_prob_prime" value="<div id='function.gmp-prob-prime' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-prob-prime.php'>gmp_prob_prime</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_prob_prime</span> &amp;mdash; <span class='dc-title'>Check if number is &amp;quot;probably prime&amp;quot;</span></p> </div> <a name='function.gmp-prob-prime.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gmp_prob_prime</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$reps</tt><span class='initializer'> = 10</span></span> ] )</div> <p class='para rdfs-comment'> The function uses Miller-Rabin&amp;#039;s probabilistic test to check if a number is a prime. </p> </div> <a name='function.gmp-prob-prime.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number being checked as a prime. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>reps</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Reasonable values of <i><tt class='parameter'>reps</tt></i> vary from 5 to 10 (default being 10); a higher value lowers the probability for a non-prime to pass as a &amp;quot;probable&amp;quot; prime. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-prob-prime.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If this function returns 0, <i><tt class='parameter'>a</tt></i> is definitely not prime. If it returns 1, then <i><tt class='parameter'>a</tt></i> is &amp;quot;probably&amp;quot; prime. If it returns 2, then <i><tt class='parameter'>a</tt></i> is surely prime. </p> </div> <a name='function.gmp-prob-prime.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_prob_prime()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;definitely&amp;nbsp;not&amp;nbsp;a&amp;nbsp;prime<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_prob_prime</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'6'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;probably&amp;nbsp;a&amp;nbsp;prime<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_prob_prime</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1111111111111111111'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;definitely&amp;nbsp;a&amp;nbsp;prime<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_prob_prime</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'11'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 0 1 2 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_powm" value="<div id='function.gmp-powm' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-powm.php'>gmp_powm</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_powm</span> &amp;mdash; <span class='dc-title'>Raise number into power with modulo</span></p> </div> <a name='function.gmp-powm.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_powm</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$base</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$exp</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$mod</tt></span> )</div> <p class='para rdfs-comment'> Calculate (<i><tt class='parameter'>base</tt></i> raised into power <i><tt class='parameter'>exp</tt></i> ) modulo <i><tt class='parameter'>mod</tt></i> . If <i><tt class='parameter'>exp</tt></i> is negative, result is undefined. </p> </div> <a name='function.gmp-powm.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>base</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The base number. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>exp</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The positive power to raise the <i><tt class='parameter'>base</tt></i> . </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mod</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The modulo. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-powm.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The new (raised) number, as a GMP number. </p> </div> <a name='function.gmp-powm.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_powm()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$pow1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_powm</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'31'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'2147483649'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pow1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 2147483648 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_pow" value="<div id='function.gmp-pow' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-pow.php'>gmp_pow</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_pow</span> &amp;mdash; <span class='dc-title'>Raise number into power</span></p> </div> <a name='function.gmp-pow.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_pow</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$base</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$exp</tt></span> )</div> <p class='para rdfs-comment'> Raise <i><tt class='parameter'>base</tt></i> into power <i><tt class='parameter'>exp</tt></i> . </p> </div> <a name='function.gmp-pow.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>base</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The base number. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>exp</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The positive power to raise the <i><tt class='parameter'>base</tt></i> . </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-pow.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The new (raised) number, as a GMP number. The case of <i>0^0</i> yields 1. </p> </div> <a name='function.gmp-pow.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_pow()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$pow1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_pow</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>31</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pow1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$pow2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_pow</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pow2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$pow3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_pow</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Negative&amp;nbsp;exp,&amp;nbsp;generates&amp;nbsp;warning<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pow3</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 2147483648 1 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_popcount" value="<div id='function.gmp-popcount' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-popcount.php'>gmp_popcount</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_popcount</span> &amp;mdash; <span class='dc-title'>Population count</span></p> </div> <a name='function.gmp-popcount.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gmp_popcount</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> )</div> <p class='para rdfs-comment'> Get the population count. </p> </div> <a name='function.gmp-popcount.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-popcount.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The population count of <i><tt class='parameter'>a</tt></i> , as an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a>. </p> </div> <a name='function.gmp-popcount.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_popcount()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$pop1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'10000101'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;3&amp;nbsp;1's<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_popcount</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pop1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$pop2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'11111110'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;7&amp;nbsp;1's<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_popcount</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pop2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 3 7 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_perfect_square" value="<div id='function.gmp-perfect-square' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-perfect-square.php'>gmp_perfect_square</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_perfect_square</span> &amp;mdash; <span class='dc-title'>Perfect square check</span></p> </div> <a name='function.gmp-perfect-square.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>gmp_perfect_square</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> )</div> <p class='para rdfs-comment'> Check if a number is a perfect square. </p> </div> <a name='function.gmp-perfect-square.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number being checked as a perfect square. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-perfect-square.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if <i><tt class='parameter'>a</tt></i> is a perfect square, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.gmp-perfect-square.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_perfect_square()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;3&amp;nbsp;*&amp;nbsp;3,&amp;nbsp;perfect&amp;nbsp;square<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>gmp_perfect_square</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'9'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;not&amp;nbsp;a&amp;nbsp;perfect&amp;nbsp;square<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>gmp_perfect_square</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'7'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;1234567890&amp;nbsp;*&amp;nbsp;1234567890,&amp;nbsp;perfect&amp;nbsp;square<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>gmp_perfect_square</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1524157875019052100'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> bool(true) bool(false) bool(true) </pre></div> </div> </div><p> </p> </div> <a name='function.gmp-perfect-square.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-sqrt.php' class='function' rel='rdfs-seeAlso'>gmp_sqrt()</a> - Calculate square root</li> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-sqrtrem.php' class='function' rel='rdfs-seeAlso'>gmp_sqrtrem()</a> - Square root with remainder</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_or" value="<div id='function.gmp-or' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-or.php'>gmp_or</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_or</span> &amp;mdash; <span class='dc-title'>Bitwise OR</span></p> </div> <a name='function.gmp-or.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_or</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Calculates bitwise inclusive OR of two GMP numbers. </p> </div> <a name='function.gmp-or.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-or.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-or.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_or()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$or1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_or</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0xfffffff2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'4'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$or1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>16</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$or2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_or</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0xfffffff2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$or2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>16</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> fffffff6 fffffff2 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_nextprime" value="<div id='function.gmp-nextprime' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-nextprime.php'>gmp_nextprime</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0)</p><p class='refpurpose'><span class='refname'>gmp_nextprime</span> &amp;mdash; <span class='dc-title'>Find next prime number</span></p> </div> <a name='function.gmp-nextprime.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_nextprime</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$a</tt></span> )</div> <p class='para rdfs-comment'> Find next prime number </p> </div> <a name='function.gmp-nextprime.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-nextprime.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Return the next prime number greater than <i><tt class='parameter'>a</tt></i> , as a GMP number. </p> </div> <a name='function.gmp-nextprime.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_nextprime()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$prime1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_nextprime</span><span style='color: #007700'>(</span><span style='color: #0000BB'>10</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;next&amp;nbsp;prime&amp;nbsp;number&amp;nbsp;greater&amp;nbsp;than&amp;nbsp;10<br /></span><span style='color: #0000BB'>$prime2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_nextprime</span><span style='color: #007700'>(-</span><span style='color: #0000BB'>1000</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;next&amp;nbsp;prime&amp;nbsp;number&amp;nbsp;greater&amp;nbsp;than&amp;nbsp;-1000<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$prime1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$prime2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 11 -997 </pre></div> </div> </div><p> </p> </div> <a name='function.gmp-nextprime.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function uses a probabilistic algorithm to identify primes and chances to get a composite number are extremely small. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_neg" value="<div id='function.gmp-neg' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-neg.php'>gmp_neg</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_neg</span> &amp;mdash; <span class='dc-title'>Negate number</span></p> </div> <a name='function.gmp-neg.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_neg</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> )</div> <p class='para rdfs-comment'> Returns the negative value of a number. </p> </div> <a name='function.gmp-neg.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-neg.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns -<i><tt class='parameter'>a</tt></i> , as a GMP number. </p> </div> <a name='function.gmp-neg.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_neg()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$neg1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_neg</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$neg1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$neg2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_neg</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'-1'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$neg2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> -1 1 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_mul" value="<div id='function.gmp-mul' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-mul.php'>gmp_mul</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_mul</span> &amp;mdash; <span class='dc-title'>Multiply numbers</span></p> </div> <a name='function.gmp-mul.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_mul</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Multiplies <i><tt class='parameter'>a</tt></i> by <i><tt class='parameter'>b</tt></i> and returns the result. </p> </div> <a name='function.gmp-mul.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A number that will be multiplied by <i><tt class='parameter'>b</tt></i> . </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A number that will be multiplied by <i><tt class='parameter'>a</tt></i> . </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-mul.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-mul.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_mul()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mul&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_mul</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'12345678'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'2000'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mul</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 24691356000 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_mod" value="<div id='function.gmp-mod' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-mod.php'>gmp_mod</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_mod</span> &amp;mdash; <span class='dc-title'>Modulo operation</span></p> </div> <a name='function.gmp-mod.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_mod</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$n</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$d</tt></span> )</div> <p class='para rdfs-comment'> Calculates <i><tt class='parameter'>n</tt></i> modulo <i><tt class='parameter'>d</tt></i> . The result is always non-negative, the sign of <i><tt class='parameter'>d</tt></i> is ignored. </p> </div> <a name='function.gmp-mod.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>n</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>d</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The modulo that is being evaluated. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-mod.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-mod.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_mod()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mod&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_mod</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'8'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$mod</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 2 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_legendre" value="<div id='function.gmp-legendre' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-legendre.php'>gmp_legendre</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_legendre</span> &amp;mdash; <span class='dc-title'>Legendre symbol</span></p> </div> <a name='function.gmp-legendre.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gmp_legendre</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$p</tt></span> )</div> <p class='para rdfs-comment'> Compute the <a href='http://primes.utm.edu/glossary/page.php?sort=LegendreSymbol' class='link external'>&amp;raquo; Legendre symbol</a> of <i><tt class='parameter'>a</tt></i> and <i><tt class='parameter'>p</tt></i> . <i><tt class='parameter'>p</tt></i> should be odd and must be positive. </p> </div> <a name='function.gmp-legendre.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>p</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> <p class='para'> Should be odd and must be positive. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-legendre.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-legendre.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_legendre()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_legendre</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_legendre</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1 0 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_jacobi" value="<div id='function.gmp-jacobi' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-jacobi.php'>gmp_jacobi</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_jacobi</span> &amp;mdash; <span class='dc-title'>Jacobi symbol</span></p> </div> <a name='function.gmp-jacobi.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gmp_jacobi</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$p</tt></span> )</div> <p class='para rdfs-comment'> Computes <a href='http://primes.utm.edu/glossary/page.php?sort=JacobiSymbol' class='link external'>&amp;raquo; Jacobi symbol</a> of <i><tt class='parameter'>a</tt></i> and <i><tt class='parameter'>p</tt></i> . <i><tt class='parameter'>p</tt></i> should be odd and must be positive. </p> </div> <a name='function.gmp-jacobi.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>p</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> <p class='para'> Should be odd and must be positive. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-jacobi.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-jacobi.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_jacobi()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_jacobi</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_jacobi</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1 0 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_invert" value="<div id='function.gmp-invert' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-invert.php'>gmp_invert</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_invert</span> &amp;mdash; <span class='dc-title'>Inverse by modulo</span></p> </div> <a name='function.gmp-invert.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_invert</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Computes the inverse of <i><tt class='parameter'>a</tt></i> modulo <i><tt class='parameter'>b</tt></i> . </p> </div> <a name='function.gmp-invert.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-invert.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number on success or <b><tt class='constant'>FALSE</tt></b> if an inverse does not exist. </p> </div> <a name='function.gmp-invert.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_invert()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_invert</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'5'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'10'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;no&amp;nbsp;inverse,&amp;nbsp;outputs&amp;nbsp;nothing,&amp;nbsp;result&amp;nbsp;is&amp;nbsp;FALSE<br /></span><span style='color: #0000BB'>$invert&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_invert</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'5'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'11'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$invert</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 9 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_intval" value="<div id='function.gmp-intval' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-intval.php'>gmp_intval</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_intval</span> &amp;mdash; <span class='dc-title'>Convert GMP number to integer</span></p> </div> <a name='function.gmp-intval.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gmp_intval</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$gmpnumber</tt></span> )</div> <p class='para rdfs-comment'> This function allows to convert GMP number to integer. </p> </div> <a name='function.gmp-intval.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>gmpnumber</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A GMP number. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-intval.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> value of <i><tt class='parameter'>gmpnumber</tt></i> . </p> </div> <a name='function.gmp-intval.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_intval()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;displays&amp;nbsp;correct&amp;nbsp;result<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_intval</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2147483647'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;displays&amp;nbsp;wrong&amp;nbsp;result,&amp;nbsp;above&amp;nbsp;PHP&amp;nbsp;integer&amp;nbsp;limit<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_intval</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2147483648'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;displays&amp;nbsp;correct&amp;nbsp;result<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2147483648'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 2147483647 2147483647 2147483648 </pre></div> </div> </div><p> </p> </div> <a name='function.gmp-intval.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='warning'><b class='warning'>Warning</b> <p class='simpara'> This function returns a useful result only if the number actually fits the PHP integer (i.e., signed long type). If you want just to print the GMP number, use <a href='http://www.php.net/manual/en/function.gmp-strval.php' class='function'>gmp_strval()</a>. </p> </div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_init" value="<div id='function.gmp-init' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-init.php'>gmp_init</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_init</span> &amp;mdash; <span class='dc-title'>Create GMP number</span></p> </div> <a name='function.gmp-init.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_init</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$number</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$base</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Creates a GMP number from an integer or string. </p> </div> <a name='function.gmp-init.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An integer or a string. The string representation can be decimal, hexadecimal or octal. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>base</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The base. Defaults to 0. </p> <p class='para'> The base may vary from 2 to 36. If base is 0 (default value), the actual base is determined from the leading characters: if the first two characters are <i>0x</i> or <i>0X</i>, hexadecimal is assumed, otherwise if the first character is &amp;quot;0&amp;quot;, octal is assumed, otherwise decimal is assumed. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-init.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-init.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.1.0</td> <td align='left'> The optional <i><tt class='parameter'>base</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.gmp-init.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Creating GMP number</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #0000BB'>123456</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$b&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0xFFFFDEBACDFEDF7200'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.gmp-init.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: It is not necessary to call this function if you want to use integer or string in place of GMP number in GMP functions, like <a href='http://www.php.net/manual/en/function.gmp-add.php' class='function'>gmp_add()</a>. Function arguments are automatically converted to GMP numbers, if such conversion is possible and needed, using the same rules as <b>gmp_init()</b>. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_hamdist" value="<div id='function.gmp-hamdist' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-hamdist.php'>gmp_hamdist</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_hamdist</span> &amp;mdash; <span class='dc-title'>Hamming distance</span></p> </div> <a name='function.gmp-hamdist.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gmp_hamdist</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Returns the hamming distance between <i><tt class='parameter'>a</tt></i> and <i><tt class='parameter'>b</tt></i> . Both operands should be non-negative. </p> </div> <a name='function.gmp-hamdist.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> <p class='para'> It should be positive. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> <p class='para'> It should be positive. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-hamdist.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-hamdist.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_hamdist()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$ham1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1001010011'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$ham2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1011111100'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_hamdist</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ham1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ham2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;hamdist&amp;nbsp;is&amp;nbsp;equivilent&amp;nbsp;to:&amp;nbsp;*/<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_popcount</span><span style='color: #007700'>(</span><span style='color: #0000BB'>gmp_xor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ham1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ham2</span><span style='color: #007700'>))&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 6 6 </pre></div> </div> </div><p> </p> </div> <a name='function.gmp-hamdist.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-popcount.php' class='function' rel='rdfs-seeAlso'>gmp_popcount()</a> - Population count</li> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-xor.php' class='function' rel='rdfs-seeAlso'>gmp_xor()</a> - Bitwise XOR</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_gcdext" value="<div id='function.gmp-gcdext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-gcdext.php'>gmp_gcdext</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_gcdext</span> &amp;mdash; <span class='dc-title'>Calculate GCD and multipliers</span></p> </div> <a name='function.gmp-gcdext.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>gmp_gcdext</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Calculates g, s, and t, such that <i>a*s + b*t = g = gcd(a,b)</i>, where gcd is the greatest common divisor. Returns an array with respective elements g, s and t. </p> <p class='para'> This function can be used to solve linear Diophantine equations in two variables. These are equations that allow only integer solutions and have the form: <i>a*x + b*y = c</i>. For more information, go to the <a href='http://mathworld.wolfram.com/DiophantineEquation.html' class='link external'>&amp;raquo; &amp;quot;Diophantine Equation&amp;quot; page at MathWorld</a> </p> </div> <a name='function.gmp-gcdext.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-gcdext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> of GMP numbers. </p> </div> <a name='function.gmp-gcdext.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Solving a linear Diophantine equation</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Solve&amp;nbsp;the&amp;nbsp;equation&amp;nbsp;a*s&amp;nbsp;+&amp;nbsp;b*t&amp;nbsp;=&amp;nbsp;g<br />//&amp;nbsp;where&amp;nbsp;a&amp;nbsp;=&amp;nbsp;12,&amp;nbsp;b&amp;nbsp;=&amp;nbsp;21,&amp;nbsp;g&amp;nbsp;=&amp;nbsp;gcd(12,&amp;nbsp;21)&amp;nbsp;=&amp;nbsp;3<br /></span><span style='color: #0000BB'>$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #0000BB'>12</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$b&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #0000BB'>21</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$g&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_gcd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$r&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_gcdext</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$check_gcd&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;(</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$g</span><span style='color: #007700'>)&amp;nbsp;==&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'g'</span><span style='color: #007700'>]));<br /></span><span style='color: #0000BB'>$eq_res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_add</span><span style='color: #007700'>(</span><span style='color: #0000BB'>gmp_mul</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'s'</span><span style='color: #007700'>]),&amp;nbsp;</span><span style='color: #0000BB'>gmp_mul</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'t'</span><span style='color: #007700'>]));<br /></span><span style='color: #0000BB'>$check_res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;(</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$g</span><span style='color: #007700'>)&amp;nbsp;==&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$eq_res</span><span style='color: #007700'>));<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$check_gcd&amp;nbsp;</span><span style='color: #007700'>&amp;amp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>$check_res</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$fmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Solution:&amp;nbsp;%d*%d&amp;nbsp;+&amp;nbsp;%d*%d&amp;nbsp;=&amp;nbsp;%d\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'s'</span><span style='color: #007700'>]),&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'t'</span><span style='color: #007700'>]),&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'g'</span><span style='color: #007700'>]));<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Error&amp;nbsp;while&amp;nbsp;solving&amp;nbsp;the&amp;nbsp;equation\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;output:&amp;nbsp;Solution:&amp;nbsp;12*2&amp;nbsp;+&amp;nbsp;21*-1&amp;nbsp;=&amp;nbsp;3<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_gcd" value="<div id='function.gmp-gcd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-gcd.php'>gmp_gcd</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_gcd</span> &amp;mdash; <span class='dc-title'>Calculate GCD</span></p> </div> <a name='function.gmp-gcd.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_gcd</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Calculate greatest common divisor of <i><tt class='parameter'>a</tt></i> and <i><tt class='parameter'>b</tt></i> . The result is always positive even if either of, or both, input operands are negative. </p> </div> <a name='function.gmp-gcd.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-gcd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A positive GMP number that divides into both <i><tt class='parameter'>a</tt></i> and <i><tt class='parameter'>b</tt></i> . </p> </div> <a name='function.gmp-gcd.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_gcd()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$gcd&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_gcd</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'12'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'21'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$gcd</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 3 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_fact" value="<div id='function.gmp-fact' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-fact.php'>gmp_fact</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_fact</span> &amp;mdash; <span class='dc-title'>Factorial</span></p> </div> <a name='function.gmp-fact.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_fact</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$a</tt></span> )</div> <p class='para rdfs-comment'> Calculates factorial (<i>a!</i>) of <i><tt class='parameter'>a</tt></i> . </p> </div> <a name='function.gmp-fact.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The factorial number. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-fact.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-fact.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_fact()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$fact1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_fact</span><span style='color: #007700'>(</span><span style='color: #0000BB'>5</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;5&amp;nbsp;*&amp;nbsp;4&amp;nbsp;*&amp;nbsp;3&amp;nbsp;*&amp;nbsp;2&amp;nbsp;*&amp;nbsp;1<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fact1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$fact2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_fact</span><span style='color: #007700'>(</span><span style='color: #0000BB'>50</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;50&amp;nbsp;*&amp;nbsp;49&amp;nbsp;*&amp;nbsp;48,&amp;nbsp;...&amp;nbsp;etc<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fact2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 120 30414093201713378043612608166064768844377641568960512000000000000 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_divexact" value="<div id='function.gmp-divexact' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-divexact.php'>gmp_divexact</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_divexact</span> &amp;mdash; <span class='dc-title'>Exact division of numbers</span></p> </div> <a name='function.gmp-divexact.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_divexact</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$n</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$d</tt></span> )</div> <p class='para rdfs-comment'> Divides <i><tt class='parameter'>n</tt></i> by <i><tt class='parameter'>d</tt></i> , using fast &amp;quot;exact division&amp;quot; algorithm. This function produces correct results only when it is known in advance that <i><tt class='parameter'>d</tt></i> divides <i><tt class='parameter'>n</tt></i> . </p> </div> <a name='function.gmp-divexact.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>n</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number being divided. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>d</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number that <i><tt class='parameter'>a</tt></i> is being divided by. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-divexact.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-divexact.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_divexact()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$div1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_divexact</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'10'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$div1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$div2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_divexact</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'10'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;bogus&amp;nbsp;result<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$div2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 5 2863311534 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_div_r" value="<div id='function.gmp-div-r' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-div-r.php'>gmp_div_r</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_div_r</span> &amp;mdash; <span class='dc-title'>Remainder of the division of numbers</span></p> </div> <a name='function.gmp-div-r.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_div_r</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$n</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$d</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$round</tt><span class='initializer'> = GMP_ROUND_ZERO</span></span> ] )</div> <p class='para rdfs-comment'> Calculates remainder of the integer division of <i><tt class='parameter'>n</tt></i> by <i><tt class='parameter'>d</tt></i> . The remainder has the sign of the <i><tt class='parameter'>n</tt></i> argument, if not zero. </p> </div> <a name='function.gmp-div-r.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>n</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number being divided. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>d</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number that <i><tt class='parameter'>n</tt></i> is being divided by. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>round</tt></i> </span> </dt><dd class='listitem'> <p class='para'> See the <a href='http://www.php.net/manual/en/function.gmp-div-q.php' class='function'>gmp_div_q()</a> function for description of the <i><tt class='parameter'>round</tt></i> argument. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-div-r.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The remainder, as a GMP number. </p> </div> <a name='function.gmp-div-r.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_div_r()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$div&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_div_r</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'105'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'20'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$div</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 5 </pre></div> </div> </div><p> </p> </div> <a name='function.gmp-div-r.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-div-q.php' class='function' rel='rdfs-seeAlso'>gmp_div_q()</a> - Divide numbers</li> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-div-qr.php' class='function' rel='rdfs-seeAlso'>gmp_div_qr()</a> - Divide numbers and get quotient and remainder</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_div_qr" value="<div id='function.gmp-div-qr' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-div-qr.php'>gmp_div_qr</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_div_qr</span> &amp;mdash; <span class='dc-title'>Divide numbers and get quotient and remainder</span></p> </div> <a name='function.gmp-div-qr.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>gmp_div_qr</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$n</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$d</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$round</tt><span class='initializer'> = GMP_ROUND_ZERO</span></span> ] )</div> <p class='para rdfs-comment'> The function divides <i><tt class='parameter'>n</tt></i> by <i><tt class='parameter'>d</tt></i> . </p> </div> <a name='function.gmp-div-qr.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>n</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number being divided. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>d</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number that <i><tt class='parameter'>n</tt></i> is being divided by. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>round</tt></i> </span> </dt><dd class='listitem'> <p class='para'> See the <a href='http://www.php.net/manual/en/function.gmp-div-q.php' class='function'>gmp_div_q()</a> function for description of the <i><tt class='parameter'>round</tt></i> argument. </p> </dd> </dl> <p> </p> </div> <a name='function.gmp-div-qr.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>, with the first element being <i>[n/d]</i> (the integer result of the division) and the second being <i>(n - [n/d] * d)</i> (the remainder of the division). </p> </div> <a name='function.gmp-div-qr.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Division of GMP numbers</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0x41682179fbf5'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_div_qr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'0xDEFE75'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Result&amp;nbsp;is:&amp;nbsp;q&amp;nbsp;-&amp;nbsp;%s,&amp;nbsp;r&amp;nbsp;-&amp;nbsp;%s'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]),&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]));<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.gmp-div-qr.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-div-q.php' class='function' rel='rdfs-seeAlso'>gmp_div_q()</a> - Divide numbers</li> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-div-r.php' class='function' rel='rdfs-seeAlso'>gmp_div_r()</a> - Remainder of the division of numbers</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_div_q" value="<div id='function.gmp-div-q' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-div-q.php'>gmp_div_q</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_div_q</span> &amp;mdash; <span class='dc-title'>Divide numbers</span></p> </div> <a name='function.gmp-div-q.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_div_q</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$round</tt><span class='initializer'> = GMP_ROUND_ZERO</span></span> ] )</div> <p class='para rdfs-comment'> Divides <i><tt class='parameter'>a</tt></i> by <i><tt class='parameter'>b</tt></i> and returns the integer result. </p> </div> <a name='function.gmp-div-q.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number being divided. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number that <i><tt class='parameter'>a</tt></i> is being divided by. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>round</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result rounding is defined by the <i><tt class='parameter'>round</tt></i> , which can have the following values: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>GMP_ROUND_ZERO</tt></b>: The result is truncated towards 0. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>GMP_ROUND_PLUSINF</tt></b>: The result is rounded towards <i>+infinity</i>. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>GMP_ROUND_MINUSINF</tt></b>: The result is rounded towards <i>-infinity</i>. </span> </li> </ul><p> </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-div-q.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-div-q.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_div_q()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$div1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_div_q</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'100'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'5'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$div1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$div2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_div_q</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$div2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$div3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_div_q</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>GMP_ROUND_PLUSINF</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$div3</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$div4&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_div_q</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'-1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'4'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>GMP_ROUND_PLUSINF</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$div4</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$div5&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_div_q</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'-1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'4'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>GMP_ROUND_MINUSINF</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$div5</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 20 0 1 0 -1 </pre></div> </div> </div><p> </p> </div> <a name='function.gmp-div-q.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function can also be called as <a href='http://www.php.net/manual/en/function.gmp-div.php' class='function'>gmp_div()</a>. <br /> </p></blockquote> </div> <a name='function.gmp-div-q.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-div-r.php' class='function' rel='rdfs-seeAlso'>gmp_div_r()</a> - Remainder of the division of numbers</li> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-div-qr.php' class='function' rel='rdfs-seeAlso'>gmp_div_qr()</a> - Divide numbers and get quotient and remainder</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_div" value="<div id='function.gmp-div' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-div.php'>gmp_div</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_div</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.gmp-div-q.php' class='function'>gmp_div_q()</a></span></p> </div> <a name='function.gmp-div.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.gmp-div-q.php' class='function'>gmp_div_q()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_com" value="<div id='function.gmp-com' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-com.php'>gmp_com</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_com</span> &amp;mdash; <span class='dc-title'>Calculates one&amp;#039;s complement</span></p> </div> <a name='function.gmp-com.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_com</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> )</div> <p class='para rdfs-comment'> Returns the one&amp;#039;s complement of <i><tt class='parameter'>a</tt></i> . </p> </div> <a name='function.gmp-com.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-com.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the one&amp;#039;s complement of <i><tt class='parameter'>a</tt></i> , as a GMP number. </p> </div> <a name='function.gmp-com.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>gmp_com()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$com&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_com</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1234'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$com</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> -1235 </pre></div> </div> </div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_cmp" value="<div id='function.gmp-cmp' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-cmp.php'>gmp_cmp</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_cmp</span> &amp;mdash; <span class='dc-title'>Compare numbers</span></p> </div> <a name='function.gmp-cmp.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>gmp_cmp</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Compares two numbers. </p> </div> <a name='function.gmp-cmp.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-cmp.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a positive value if <i>a &amp;gt; b</i>, zero if <i>a = b</i> and a negative value if <i>a &amp;lt; b</i>. </p> </div> <a name='function.gmp-cmp.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>gmp_cmp()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$cmp1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_cmp</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1234'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'1000'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;greater&amp;nbsp;than<br /></span><span style='color: #0000BB'>$cmp2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_cmp</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1000'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'1234'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;less&amp;nbsp;than<br /></span><span style='color: #0000BB'>$cmp3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_cmp</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1234'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'1234'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;equal&amp;nbsp;to<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$cmp1</span><span style='color: #DD0000'>&amp;nbsp;</span><span style='color: #0000BB'>$cmp2</span><span style='color: #DD0000'>&amp;nbsp;</span><span style='color: #0000BB'>$cmp3</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1 -1 0 </pre></div> </div> </div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_clrbit" value="<div id='function.gmp-clrbit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-clrbit.php'>gmp_clrbit</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_clrbit</span> &amp;mdash; <span class='dc-title'>Clear bit</span></p> </div> <a name='function.gmp-clrbit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>gmp_clrbit</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$index</tt></span> )</div> <p class='para rdfs-comment'> Clears (sets to 0) bit <i><tt class='parameter'>index</tt></i> in <i><tt class='parameter'>a</tt></i> . The index starts at 0. </p> </div> <a name='function.gmp-clrbit.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>index</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-clrbit.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </div> <a name='function.gmp-clrbit.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>gmp_clrbit()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0xff'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>gmp_clrbit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;index&amp;nbsp;starts&amp;nbsp;at&amp;nbsp;0,&amp;nbsp;least&amp;nbsp;significant&amp;nbsp;bit<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 254 </pre></div> </div> </div> </div> <a name='function.gmp-clrbit.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Unlike most of the other GMP functions, <b>gmp_clrbit()</b> must be called with a GMP resource that already exists (using <a href='http://www.php.net/manual/en/function.gmp-init.php' class='function'>gmp_init()</a> for example). One will not be automatically created. <br /> </p></blockquote> </div> <a name='function.gmp-clrbit.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-setbit.php' class='function' rel='rdfs-seeAlso'>gmp_setbit()</a> - Set bit</li> <li class='member'><a href='http://www.php.net/manual/en/function.gmp-testbit.php' class='function' rel='rdfs-seeAlso'>gmp_testbit()</a> - Tests if a bit is set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_and" value="<div id='function.gmp-and' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-and.php'>gmp_and</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_and</span> &amp;mdash; <span class='dc-title'>Bitwise AND</span></p> </div> <a name='function.gmp-and.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_and</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Calculates bitwise AND of two GMP numbers. </p> </div> <a name='function.gmp-and.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-and.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number representing the bitwise <i>AND</i> comparison. </p> </div> <a name='function.gmp-and.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>gmp_and()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$and1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_and</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0xfffffffff4'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'0x4'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$and2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_and</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'0xfffffffff4'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'0x8'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$and1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$and2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 4 0 </pre></div> </div> </div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_add" value="<div id='function.gmp-add' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-add.php'>gmp_add</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_add</span> &amp;mdash; <span class='dc-title'>Add numbers</span></p> </div> <a name='function.gmp-add.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_add</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$b</tt></span> )</div> <p class='para rdfs-comment'> Add two numbers. </p> </div> <a name='function.gmp-add.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A number that will be added. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>b</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A number that will be added. </p> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-add.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A GMP number representing the sum of the arguments. </p> </div> <a name='function.gmp-add.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_add()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$sum&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_add</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'123456789012345'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'76543210987655'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sum</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 200000000000000 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gmp_abs" value="<div id='function.gmp-abs' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gmp-abs.php'>gmp_abs</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>gmp_abs</span> &amp;mdash; <span class='dc-title'>Absolute value</span></p> </div> <a name='function.gmp-abs.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>gmp_abs</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$a</tt></span> )</div> <p class='para rdfs-comment'> Get the absolute value of a number. </p> </div> <a name='function.gmp-abs.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>a</tt></i> </span> </dt><dd class='listitem'> <p class='para'>It can be either a GMP number <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or a numeric string given that it is possible to convert the latter to a number.</p> </dd> </dl> <p> </p> </div> <a name='function.gmp-abs.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the absolute value of <i><tt class='parameter'>a</tt></i> , as a GMP number. </p> </div> <a name='function.gmp-abs.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gmp_abs()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$abs1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_abs</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'274982683358'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$abs2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gmp_abs</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'-274982683358'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$abs1</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>gmp_strval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$abs2</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 274982683358 274982683358 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="gettext" value="<div id='function.gettext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.gettext.php'>gettext</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>gettext</span> &amp;mdash; <span class='dc-title'>Lookup a message in the current domain</span></p> </div> <a name='function.gettext.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>gettext</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$message</tt></span> )</div> <p class='para rdfs-comment'> Looks up a message in the current domain. </p> </div> <a name='function.gettext.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>message</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.gettext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a translated <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> if one is found in the translation table, or the submitted message if not found. </p> </div> <a name='function.gettext.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>gettext()</b>-check</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;language&amp;nbsp;to&amp;nbsp;German<br /></span><span style='color: #0000BB'>setlocale</span><span style='color: #007700'>(</span><span style='color: #0000BB'>LC_ALL</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'de_DE'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Specify&amp;nbsp;location&amp;nbsp;of&amp;nbsp;translation&amp;nbsp;tables<br /></span><span style='color: #0000BB'>bindtextdomain</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'myPHPApp'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./locale'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Choose&amp;nbsp;domain<br /></span><span style='color: #0000BB'>textdomain</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'myPHPApp'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Translation&amp;nbsp;is&amp;nbsp;looking&amp;nbsp;for&amp;nbsp;in&amp;nbsp;./locale/de_DE/LC_MESSAGES/myPHPApp.mo&amp;nbsp;now<br /><br />//&amp;nbsp;Print&amp;nbsp;a&amp;nbsp;test&amp;nbsp;message<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>gettext</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Welcome&amp;nbsp;to&amp;nbsp;My&amp;nbsp;PHP&amp;nbsp;Application'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Or&amp;nbsp;use&amp;nbsp;the&amp;nbsp;alias&amp;nbsp;_()&amp;nbsp;for&amp;nbsp;gettext()<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>_</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Have&amp;nbsp;a&amp;nbsp;nice&amp;nbsp;day'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.gettext.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: You may use the underscore character &amp;#039;_&amp;#039; as an alias to this function. <br /> </p></blockquote> </div> <a name='function.gettext.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.setlocale.php' class='function' rel='rdfs-seeAlso'>setlocale()</a> - Set locale information</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_systype" value="<div id='function.ftp-systype' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-systype.php'>ftp_systype</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_systype</span> &amp;mdash; <span class='dc-title'>Returns the system type identifier of the remote FTP server</span></p> </div> <a name='function.ftp-systype.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ftp_systype</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> )</div> <p class='para rdfs-comment'> Returns the system type identifier of the remote FTP server. </p> </div> <a name='function.ftp-systype.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-systype.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the remote system type, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ftp-systype.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_systype()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;ftp&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$ftp&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ftp.example.com'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;get&amp;nbsp;the&amp;nbsp;system&amp;nbsp;type<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$type&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_systype</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Example.com&amp;nbsp;is&amp;nbsp;powered&amp;nbsp;by&amp;nbsp;</span><span style='color: #0000BB'>$type</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Couldn't&amp;nbsp;get&amp;nbsp;the&amp;nbsp;systype'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Example.com is powered by UNIX </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_size" value="<div id='function.ftp-size' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-size.php'>ftp_size</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_size</span> &amp;mdash; <span class='dc-title'>Returns the size of the given file</span></p> </div> <a name='function.ftp-size.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>ftp_size</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$remote_file</tt></span> )</div> <p class='para rdfs-comment'> <b>ftp_size()</b> returns the size of the given file in bytes. </p> <blockquote><p><b class='note'>Note</b>: Not all servers support this feature. <br /> </p></blockquote> </div> <a name='function.ftp-size.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>remote_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The remote file. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-size.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the file size on success, or -1 on error. </p> </div> <a name='function.ftp-size.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_size()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'somefile.txt'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;get&amp;nbsp;the&amp;nbsp;size&amp;nbsp;of&amp;nbsp;$file<br /></span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_size</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'size&amp;nbsp;of&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>&amp;nbsp;is&amp;nbsp;</span><span style='color: #0000BB'>$res</span><span style='color: #DD0000'>&amp;nbsp;bytes'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'couldn't&amp;nbsp;get&amp;nbsp;the&amp;nbsp;size'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-size.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-rawlist.php' class='function' rel='rdfs-seeAlso'>ftp_rawlist()</a> - Returns a detailed list of files in the given directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_site" value="<div id='function.ftp-site' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-site.php'>ftp_site</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_site</span> &amp;mdash; <span class='dc-title'>Sends a SITE command to the server</span></p> </div> <a name='function.ftp-site.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_site</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$command</tt></span> )</div> <p class='para rdfs-comment'> <b>ftp_site()</b> sends the given <i>SITE</i> command to the FTP server. </p> <p class='para'> <i>SITE</i> commands are not standardized, and vary from server to server. They are useful for handling such things as file permissions and group membership. </p> </div> <a name='function.ftp-site.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>command</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The SITE command. Note that this parameter isn&amp;#039;t escaped so there may be some issues with filenames containing spaces and other characters. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-site.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-site.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Sending a SITE command to an ftp server</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;FTP&amp;nbsp;server<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ftp.example.com'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;die(</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;ftp.example.com'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Login&amp;nbsp;as&amp;nbsp;'user'&amp;nbsp;with&amp;nbsp;password&amp;nbsp;'pass'<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'pass'</span><span style='color: #007700'>))&amp;nbsp;die(</span><span style='color: #DD0000'>'Error&amp;nbsp;logging&amp;nbsp;into&amp;nbsp;ftp.example.com'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Issue:&amp;nbsp;'SITE&amp;nbsp;CHMOD&amp;nbsp;0600&amp;nbsp;/home/user/privatefile'&amp;nbsp;command&amp;nbsp;to&amp;nbsp;ftp&amp;nbsp;server<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_site</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CHMOD&amp;nbsp;0600&amp;nbsp;/home/user/privatefile'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Command&amp;nbsp;executed&amp;nbsp;successfully.\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Command&amp;nbsp;failed.'</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-site.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-raw.php' class='function' rel='rdfs-seeAlso'>ftp_raw()</a> - Sends an arbitrary command to an FTP server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_set_option" value="<div id='function.ftp-set-option' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-set-option.php'>ftp_set_option</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_set_option</span> &amp;mdash; <span class='dc-title'>Set miscellaneous runtime FTP options</span></p> </div> <a name='function.ftp-set-option.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_set_option</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$option</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$value</tt></span> )</div> <p class='para rdfs-comment'> This function controls various runtime options for the specified FTP stream. </p> </div> <a name='function.ftp-set-option.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Currently, the following options are supported: </p><table class='doctable table'> <caption><b>Supported runtime FTP options</b></caption> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>FTP_TIMEOUT_SEC</tt></b></td> <td align='left'> Changes the timeout in seconds used for all network related functions. <i><tt class='parameter'>value</tt></i> must be an integer that is greater than 0. The default timeout is 90 seconds. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>FTP_AUTOSEEK</tt></b></td> <td align='left'> When enabled, GET or PUT requests with a <i><tt class='parameter'>resumepos</tt></i> or <i><tt class='parameter'>startpos</tt></i> parameter will first seek to the requested position within the file. This is enabled by default. </td> </tr> </tbody> </table> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>value</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This parameter depends on which <i><tt class='parameter'>option</tt></i> is chosen to be altered. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-set-option.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the option could be set; <b><tt class='constant'>FALSE</tt></b> if not. A warning message will be thrown if the <i><tt class='parameter'>option</tt></i> is not supported or the passed <i><tt class='parameter'>value</tt></i> doesn&amp;#039;t match the expected value for the given <i><tt class='parameter'>option</tt></i> . </p> </div> <a name='function.ftp-set-option.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_set_option()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;network&amp;nbsp;timeout&amp;nbsp;to&amp;nbsp;10&amp;nbsp;seconds<br /></span><span style='color: #0000BB'>ftp_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_TIMEOUT_SEC</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-set-option.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-get-option.php' class='function' rel='rdfs-seeAlso'>ftp_get_option()</a> - Retrieves various runtime behaviours of the current FTP stream</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_rmdir" value="<div id='function.ftp-rmdir' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-rmdir.php'>ftp_rmdir</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_rmdir</span> &amp;mdash; <span class='dc-title'>Removes a directory</span></p> </div> <a name='function.ftp-rmdir.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_rmdir</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$directory</tt></span> )</div> <p class='para rdfs-comment'> Removes the specified <i><tt class='parameter'>directory</tt></i> on the FTP server. </p> </div> <a name='function.ftp-rmdir.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>directory</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The directory to delete. This must be either an absolute or relative path to an empty directory. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-rmdir.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-rmdir.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_rmdir()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$dir&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'www/'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;delete&amp;nbsp;the&amp;nbsp;directory&amp;nbsp;$dir<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_rmdir</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$dir</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Successfully&amp;nbsp;deleted&amp;nbsp;</span><span style='color: #0000BB'>$dir</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;a&amp;nbsp;problem&amp;nbsp;while&amp;nbsp;deleting&amp;nbsp;</span><span style='color: #0000BB'>$dir</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-rmdir.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-mkdir.php' class='function' rel='rdfs-seeAlso'>ftp_mkdir()</a> - Creates a directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_rename" value="<div id='function.ftp-rename' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-rename.php'>ftp_rename</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_rename</span> &amp;mdash; <span class='dc-title'>Renames a file or a directory on the FTP server</span></p> </div> <a name='function.ftp-rename.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_rename</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$oldname</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$newname</tt></span> )</div> <p class='para rdfs-comment'> <b>ftp_rename()</b> renames a file or a directory on the FTP server. </p> </div> <a name='function.ftp-rename.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>oldname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The old file/directory name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>newname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new name. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-rename.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-rename.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_rename()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$old_file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'somefile.txt.bak'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$new_file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'somefile.txt'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;rename&amp;nbsp;$old_file&amp;nbsp;to&amp;nbsp;$new_file<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_rename</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$old_file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$new_file</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'successfully&amp;nbsp;renamed&amp;nbsp;</span><span style='color: #0000BB'>$old_file</span><span style='color: #DD0000'>&amp;nbsp;to&amp;nbsp;</span><span style='color: #0000BB'>$new_file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;a&amp;nbsp;problem&amp;nbsp;while&amp;nbsp;renaming&amp;nbsp;</span><span style='color: #0000BB'>$old_file</span><span style='color: #DD0000'>&amp;nbsp;to&amp;nbsp;</span><span style='color: #0000BB'>$new_file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_rawlist" value="<div id='function.ftp-rawlist' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-rawlist.php'>ftp_rawlist</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_rawlist</span> &amp;mdash; <span class='dc-title'>Returns a detailed list of files in the given directory</span></p> </div> <a name='function.ftp-rawlist.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>ftp_rawlist</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$directory</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$recursive</tt><span class='initializer'> = false</span></span> ] )</div> <p class='para rdfs-comment'> <b>ftp_rawlist()</b> executes the FTP <strong class='command'>LIST</strong> command, and returns the result as an array. </p> </div> <a name='function.ftp-rawlist.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>directory</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The directory path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>recursive</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If set to <b><tt class='constant'>TRUE</tt></b>, the issued command will be <strong class='command'>LIST -R</strong>. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-rawlist.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array where each element corresponds to one line of text. </p> <p class='para'> The output is not parsed in any way. The system type identifier returned by <a href='http://www.php.net/manual/en/function.ftp-systype.php' class='function'>ftp_systype()</a> can be used to determine how the results should be interpreted. </p> </div> <a name='function.ftp-rawlist.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_rawlist()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;get&amp;nbsp;the&amp;nbsp;file&amp;nbsp;list&amp;nbsp;for&amp;nbsp;/<br /></span><span style='color: #0000BB'>$buff&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_rawlist</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'/'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;output&amp;nbsp;the&amp;nbsp;buffer<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$buff</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> array(3) { [0]=&amp;gt; string(65) &amp;quot;drwxr-x--- 3 vincent vincent 4096 Jul 12 12:16 public_ftp&amp;quot; [1]=&amp;gt; string(66) &amp;quot;drwxr-x--- 15 vincent vincent 4096 Nov 3 21:31 public_html&amp;quot; [2]=&amp;gt; string(73) &amp;quot;lrwxrwxrwx 1 vincent vincent 11 Jul 12 12:16 www -&amp;gt; public_html&amp;quot; } </pre></div> </div> </div><p> </p> </div> <a name='function.ftp-rawlist.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> <i><tt class='parameter'>recursive</tt></i> was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ftp-rawlist.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nlist.php' class='function' rel='rdfs-seeAlso'>ftp_nlist()</a> - Returns a list of files in the given directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_raw" value="<div id='function.ftp-raw' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-raw.php'>ftp_raw</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_raw</span> &amp;mdash; <span class='dc-title'>Sends an arbitrary command to an FTP server</span></p> </div> <a name='function.ftp-raw.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>ftp_raw</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$command</tt></span> )</div> <p class='para rdfs-comment'> Sends an arbitrary <i><tt class='parameter'>command</tt></i> to the FTP server. </p> </div> <a name='function.ftp-raw.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>command</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The command to execute. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-raw.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the server&amp;#039;s response as an array of strings. No parsing is performed on the response string, nor does <b>ftp_raw()</b> determine if the command succeeded. </p> </div> <a name='function.ftp-raw.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>ftp_raw()</b> to login to an FTP server manually.</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$fp&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ftp.example.com'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;This&amp;nbsp;is&amp;nbsp;the&amp;nbsp;same&amp;nbsp;as:&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;ftp_login($fp,&amp;nbsp;'joeblow',&amp;nbsp;'secret');&amp;nbsp;*/<br /></span><span style='color: #0000BB'>ftp_raw</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'USER&amp;nbsp;joeblow'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>ftp_raw</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'PASS&amp;nbsp;secret'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-raw.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-exec.php' class='function' rel='rdfs-seeAlso'>ftp_exec()</a> - Requests execution of a command on the FTP server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_quit" value="<div id='function.ftp-quit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-quit.php'>ftp_quit</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_quit</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.ftp-close.php' class='function'>ftp_close()</a></span></p> </div> <a name='function.ftp-quit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.ftp-close.php' class='function'>ftp_close()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_pwd" value="<div id='function.ftp-pwd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-pwd.php'>ftp_pwd</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_pwd</span> &amp;mdash; <span class='dc-title'>Returns the current directory name</span></p> </div> <a name='function.ftp-pwd.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ftp_pwd</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> )</div> <p class='para rdfs-comment'> </p> </div> <a name='function.ftp-pwd.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-pwd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the current directory name or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ftp-pwd.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_pwd()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;change&amp;nbsp;directory&amp;nbsp;to&amp;nbsp;public_html<br /></span><span style='color: #0000BB'>ftp_chdir</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'public_html'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;print&amp;nbsp;current&amp;nbsp;directory<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>ftp_pwd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;/public_html<br /><br />//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-pwd.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-chdir.php' class='function' rel='rdfs-seeAlso'>ftp_chdir()</a> - Changes the current directory on a FTP server</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-cdup.php' class='function' rel='rdfs-seeAlso'>ftp_cdup()</a> - Changes to the parent directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_put" value="<div id='function.ftp-put' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-put.php'>ftp_put</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_put</span> &amp;mdash; <span class='dc-title'>Uploads a file to the FTP server</span></p> </div> <a name='function.ftp-put.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_put</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$remote_file</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$local_file</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$startpos</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>ftp_put()</b> stores a local file on the FTP server. </p> </div> <a name='function.ftp-put.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>remote_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The remote file path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>local_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The local file path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The transfer mode. Must be either <b><tt class='constant'>FTP_ASCII</tt></b> or <b><tt class='constant'>FTP_BINARY</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>startpos</tt></i> </span> </dt><dd class='listitem'> </dd> </dl> <p> </p> </div> <a name='function.ftp-put.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-put.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_put()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'somefile.txt'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$remote_file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'readme.txt'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;upload&amp;nbsp;a&amp;nbsp;file<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_put</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$remote_file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_ASCII</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'successfully&amp;nbsp;uploaded&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;a&amp;nbsp;problem&amp;nbsp;while&amp;nbsp;uploading&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-put.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> <i><tt class='parameter'>startpos</tt></i> was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ftp-put.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-pasv.php' class='function' rel='rdfs-seeAlso'>ftp_pasv()</a> - Turns passive mode on or off</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-fput.php' class='function' rel='rdfs-seeAlso'>ftp_fput()</a> - Uploads from an open file to the FTP server</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-fput.php' class='function' rel='rdfs-seeAlso'>ftp_nb_fput()</a> - Stores a file from an open file to the FTP server (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-put.php' class='function' rel='rdfs-seeAlso'>ftp_nb_put()</a> - Stores a file on the FTP server (non-blocking)</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_pasv" value="<div id='function.ftp-pasv' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-pasv.php'>ftp_pasv</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_pasv</span> &amp;mdash; <span class='dc-title'>Turns passive mode on or off</span></p> </div> <a name='function.ftp-pasv.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_pasv</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$pasv</tt></span> )</div> <p class='para rdfs-comment'> <b>ftp_pasv()</b> turns on or off passive mode. In passive mode, data connections are initiated by the client, rather than by the server. It may be needed if the client is behind firewall. </p> <p class='para'> Please note that <b>ftp_pasv()</b> can only be called after a successfull login or otherwise it will fail. </p> </div> <a name='function.ftp-pasv.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pasv</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <b><tt class='constant'>TRUE</tt></b>, the passive mode is turned on, else it&amp;#039;s turned off. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-pasv.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-pasv.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_pasv()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'somefile.txt'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$remote_file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'readme.txt'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;turn&amp;nbsp;passive&amp;nbsp;mode&amp;nbsp;on<br /></span><span style='color: #0000BB'>ftp_pasv</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;upload&amp;nbsp;a&amp;nbsp;file<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_put</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$remote_file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_ASCII</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'successfully&amp;nbsp;uploaded&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;a&amp;nbsp;problem&amp;nbsp;while&amp;nbsp;uploading&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_nlist" value="<div id='function.ftp-nlist' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-nlist.php'>ftp_nlist</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_nlist</span> &amp;mdash; <span class='dc-title'>Returns a list of files in the given directory</span></p> </div> <a name='function.ftp-nlist.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>ftp_nlist</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$directory</tt></span> )</div> </div> <a name='function.ftp-nlist.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>directory</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The directory to be listed. This parameter can also include arguments, eg. ftp_nlist($conn_id, &amp;quot;-la /your/dir&amp;quot;); Note that this parameter isn&amp;#039;t escaped so there may be some issues with filenames containing spaces and other characters. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-nlist.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of filenames from the specified directory on success or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ftp-nlist.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_nlist()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;get&amp;nbsp;contents&amp;nbsp;of&amp;nbsp;the&amp;nbsp;current&amp;nbsp;directory<br /></span><span style='color: #0000BB'>$contents&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nlist</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;output&amp;nbsp;$contents<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$contents</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> array(3) { [0]=&amp;gt; string(11) &amp;quot;public_html&amp;quot; [1]=&amp;gt; string(10) &amp;quot;public_ftp&amp;quot; [2]=&amp;gt; string(3) &amp;quot;www&amp;quot; </pre></div> </div> </div><p> </p> </div> <a name='function.ftp-nlist.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-rawlist.php' class='function' rel='rdfs-seeAlso'>ftp_rawlist()</a> - Returns a detailed list of files in the given directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_nb_put" value="<div id='function.ftp-nb-put' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-nb-put.php'>ftp_nb_put</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_nb_put</span> &amp;mdash; <span class='dc-title'>Stores a file on the FTP server (non-blocking)</span></p> </div> <a name='function.ftp-nb-put.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>ftp_nb_put</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$remote_file</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$local_file</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$startpos</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>ftp_nb_put()</b> stores a local file on the FTP server. </p> <p class='para'> The difference between this function and the <a href='http://www.php.net/manual/en/function.ftp-put.php' class='function'>ftp_put()</a> is that this function uploads the file asynchronously, so your program can perform other operations while the file is being uploaded. </p> </div> <a name='function.ftp-nb-put.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>remote_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The remote file path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>local_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The local file path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The transfer mode. Must be either <b><tt class='constant'>FTP_ASCII</tt></b> or <b><tt class='constant'>FTP_BINARY</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>startpos</tt></i> </span> </dt><dd class='listitem'> </dd> </dl> <p> </p> </div> <a name='function.ftp-nb-put.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>FTP_FAILED</tt></b> or <b><tt class='constant'>FTP_FINISHED</tt></b> or <b><tt class='constant'>FTP_MOREDATA</tt></b>. </p> </div> <a name='function.ftp-nb-put.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_nb_put()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Initiate&amp;nbsp;the&amp;nbsp;Upload<br /></span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_put</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test.remote'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test.local'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_BINARY</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>FTP_MOREDATA</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;whatever&amp;nbsp;you&amp;nbsp;want<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Continue&amp;nbsp;uploading...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_continue</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>);<br />}<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;</span><span style='color: #0000BB'>FTP_FINISHED</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;an&amp;nbsp;error&amp;nbsp;uploading&amp;nbsp;the&amp;nbsp;file...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Resuming an upload with <b>ftp_nb_put()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Initiate<br /></span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_put</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test.remote'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test.local'</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>FTP_BINARY</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>ftp_size</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'test.remote'</span><span style='color: #007700'>));<br /></span><span style='color: #FF8000'>//&amp;nbsp;OR:&amp;nbsp;$ret&amp;nbsp;=&amp;nbsp;ftp_nb_put($my_connection,&amp;nbsp;'test.remote',&amp;nbsp;'test.local',&amp;nbsp;<br />//&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;FTP_BINARY,&amp;nbsp;FTP_AUTORESUME);<br /><br /></span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>FTP_MOREDATA</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;whatever&amp;nbsp;you&amp;nbsp;want<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Continue&amp;nbsp;uploading...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_continue</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>);<br />}<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;</span><span style='color: #0000BB'>FTP_FINISHED</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;an&amp;nbsp;error&amp;nbsp;uploading&amp;nbsp;the&amp;nbsp;file...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-nb-put.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-fput.php' class='function' rel='rdfs-seeAlso'>ftp_nb_fput()</a> - Stores a file from an open file to the FTP server (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-continue.php' class='function' rel='rdfs-seeAlso'>ftp_nb_continue()</a> - Continues retrieving/sending a file (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-put.php' class='function' rel='rdfs-seeAlso'>ftp_put()</a> - Uploads a file to the FTP server</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-fput.php' class='function' rel='rdfs-seeAlso'>ftp_fput()</a> - Uploads from an open file to the FTP server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_nb_get" value="<div id='function.ftp-nb-get' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-nb-get.php'>ftp_nb_get</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_nb_get</span> &amp;mdash; <span class='dc-title'>Retrieves a file from the FTP server and writes it to a local file (non-blocking)</span></p> </div> <a name='function.ftp-nb-get.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>ftp_nb_get</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$local_file</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$remote_file</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resumepos</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>ftp_nb_get()</b> retrieves a remote file from the FTP server, and saves it into a local file. </p> <p class='para'> The difference between this function and <a href='http://www.php.net/manual/en/function.ftp-get.php' class='function'>ftp_get()</a> is that this function retrieves the file asynchronously, so your program can perform other operations while the file is being downloaded. </p> </div> <a name='function.ftp-nb-get.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>local_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The local file path (will be overwritten if the file already exists). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>remote_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The remote file path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The transfer mode. Must be either <b><tt class='constant'>FTP_ASCII</tt></b> or <b><tt class='constant'>FTP_BINARY</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>resumepos</tt></i> </span> </dt><dd class='listitem'> </dd> </dl> <p> </p> </div> <a name='function.ftp-nb-get.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>FTP_FAILED</tt></b> or <b><tt class='constant'>FTP_FINISHED</tt></b> or <b><tt class='constant'>FTP_MOREDATA</tt></b>. </p> </div> <a name='function.ftp-nb-get.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_nb_get()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Initate&amp;nbsp;the&amp;nbsp;download<br /></span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'README'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_BINARY</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>FTP_MOREDATA</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;whatever&amp;nbsp;you&amp;nbsp;want<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Continue&amp;nbsp;downloading...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_continue</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>);<br />}<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;</span><span style='color: #0000BB'>FTP_FINISHED</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;an&amp;nbsp;error&amp;nbsp;downloading&amp;nbsp;the&amp;nbsp;file...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Resuming a download with <b>ftp_nb_get()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Initate&amp;nbsp;<br /></span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'README'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_BINARY</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>filesize</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>));<br /></span><span style='color: #FF8000'>//&amp;nbsp;OR:&amp;nbsp;$ret&amp;nbsp;=&amp;nbsp;ftp_nb_get($my_connection,&amp;nbsp;'test',&amp;nbsp;'README',&amp;nbsp;<br />//&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;FTP_BINARY,&amp;nbsp;FTP_AUTORESUME);<br /></span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>FTP_MOREDATA</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;whatever&amp;nbsp;you&amp;nbsp;want<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Continue&amp;nbsp;downloading...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_continue</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>);<br />}<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;</span><span style='color: #0000BB'>FTP_FINISHED</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;an&amp;nbsp;error&amp;nbsp;downloading&amp;nbsp;the&amp;nbsp;file...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #3 Resuming a download at position 100 to a new file with <b>ftp_nb_get()</b> </b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Disable&amp;nbsp;Autoseek<br /></span><span style='color: #0000BB'>ftp_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_AUTOSEEK</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Initiate<br /></span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'newfile'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'README'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_BINARY</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>FTP_MOREDATA</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;...&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;Continue&amp;nbsp;downloading...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_continue</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> In the example above, <var class='filename'>newfile</var> is 100 bytes smaller than <var class='filename'>README</var> on the FTP server because we started reading at offset 100. If we didn&amp;#039;t disable <b><tt class='constant'>FTP_AUTOSEEK</tt></b>, the first 100 bytes of <var class='filename'>newfile</var> would be <i>&amp;#039;\0&amp;#039;</i>. </p> </div> <a name='function.ftp-nb-get.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-fget.php' class='function' rel='rdfs-seeAlso'>ftp_nb_fget()</a> - Retrieves a file from the FTP server and writes it to an open file (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-continue.php' class='function' rel='rdfs-seeAlso'>ftp_nb_continue()</a> - Continues retrieving/sending a file (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-fget.php' class='function' rel='rdfs-seeAlso'>ftp_fget()</a> - Downloads a file from the FTP server and saves to an open file</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-get.php' class='function' rel='rdfs-seeAlso'>ftp_get()</a> - Downloads a file from the FTP server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_nb_fput" value="<div id='function.ftp-nb-fput' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-nb-fput.php'>ftp_nb_fput</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_nb_fput</span> &amp;mdash; <span class='dc-title'>Stores a file from an open file to the FTP server (non-blocking)</span></p> </div> <a name='function.ftp-nb-fput.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>ftp_nb_fput</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$remote_file</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$handle</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$startpos</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>ftp_nb_fput()</b> uploads the data from a file pointer to a remote file on the FTP server. </p> <p class='para'> The difference between this function and the <a href='http://www.php.net/manual/en/function.ftp-fput.php' class='function'>ftp_fput()</a> is that this function uploads the file asynchronously, so your program can perform other operations while the file is being uploaded. </p> </div> <a name='function.ftp-nb-fput.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>remote_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The remote file path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>handle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An open file pointer on the local file. Reading stops at end of file. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The transfer mode. Must be either <b><tt class='constant'>FTP_ASCII</tt></b> or <b><tt class='constant'>FTP_BINARY</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>startpos</tt></i> </span> </dt><dd class='listitem'> </dd> </dl> <p> </p> </div> <a name='function.ftp-nb-fput.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>FTP_FAILED</tt></b> or <b><tt class='constant'>FTP_FINISHED</tt></b> or <b><tt class='constant'>FTP_MOREDATA</tt></b>. </p> </div> <a name='function.ftp-nb-fput.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_nb_fput()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'index.php'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$fp&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>fopen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'r'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Initate&amp;nbsp;the&amp;nbsp;upload<br /></span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_fput</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_BINARY</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>FTP_MOREDATA</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;whatever&amp;nbsp;you&amp;nbsp;want<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Continue&amp;nbsp;upload...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_continue</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br />}<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;</span><span style='color: #0000BB'>FTP_FINISHED</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;an&amp;nbsp;error&amp;nbsp;uploading&amp;nbsp;the&amp;nbsp;file...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>fclose</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-nb-fput.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-put.php' class='function' rel='rdfs-seeAlso'>ftp_nb_put()</a> - Stores a file on the FTP server (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-continue.php' class='function' rel='rdfs-seeAlso'>ftp_nb_continue()</a> - Continues retrieving/sending a file (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-put.php' class='function' rel='rdfs-seeAlso'>ftp_put()</a> - Uploads a file to the FTP server</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-fput.php' class='function' rel='rdfs-seeAlso'>ftp_fput()</a> - Uploads from an open file to the FTP server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_nb_fget" value="<div id='function.ftp-nb-fget' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-nb-fget.php'>ftp_nb_fget</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_nb_fget</span> &amp;mdash; <span class='dc-title'>Retrieves a file from the FTP server and writes it to an open file (non-blocking)</span></p> </div> <a name='function.ftp-nb-fget.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>ftp_nb_fget</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$handle</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$remote_file</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resumepos</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>ftp_nb_fget()</b> retrieves a remote file from the FTP server. </p> <p class='para'> The difference between this function and <a href='http://www.php.net/manual/en/function.ftp-fget.php' class='function'>ftp_fget()</a> is that this function retrieves the file asynchronously, so your program can perform other operations while the file is being downloaded. </p> </div> <a name='function.ftp-nb-fget.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>handle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An open file pointer in which we store the data. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>remote_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The remote file path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The transfer mode. Must be either <b><tt class='constant'>FTP_ASCII</tt></b> or <b><tt class='constant'>FTP_BINARY</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>resumepos</tt></i> </span> </dt><dd class='listitem'> </dd> </dl> <p> </p> </div> <a name='function.ftp-nb-fget.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>FTP_FAILED</tt></b> or <b><tt class='constant'>FTP_FINISHED</tt></b> or <b><tt class='constant'>FTP_MOREDATA</tt></b>. </p> </div> <a name='function.ftp-nb-fget.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_nb_fget()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;open&amp;nbsp;some&amp;nbsp;file&amp;nbsp;for&amp;nbsp;reading<br /></span><span style='color: #0000BB'>$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'index.php'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$fp&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>fopen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'w'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Initate&amp;nbsp;the&amp;nbsp;download<br /></span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_fget</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_BINARY</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>FTP_MOREDATA</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;whatever&amp;nbsp;you&amp;nbsp;want<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Continue&amp;nbsp;downloading...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_continue</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br />}<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;</span><span style='color: #0000BB'>FTP_FINISHED</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;an&amp;nbsp;error&amp;nbsp;downloading&amp;nbsp;the&amp;nbsp;file...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;filepointer<br /></span><span style='color: #0000BB'>fclose</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-nb-fget.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-get.php' class='function' rel='rdfs-seeAlso'>ftp_nb_get()</a> - Retrieves a file from the FTP server and writes it to a local file (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-continue.php' class='function' rel='rdfs-seeAlso'>ftp_nb_continue()</a> - Continues retrieving/sending a file (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-fget.php' class='function' rel='rdfs-seeAlso'>ftp_fget()</a> - Downloads a file from the FTP server and saves to an open file</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-get.php' class='function' rel='rdfs-seeAlso'>ftp_get()</a> - Downloads a file from the FTP server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_nb_continue" value="<div id='function.ftp-nb-continue' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-nb-continue.php'>ftp_nb_continue</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_nb_continue</span> &amp;mdash; <span class='dc-title'>Continues retrieving/sending a file (non-blocking)</span></p> </div> <a name='function.ftp-nb-continue.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>ftp_nb_continue</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> )</div> <p class='para rdfs-comment'> Continues retrieving/sending a file non-blocking. </p> </div> <a name='function.ftp-nb-continue.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-nb-continue.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>FTP_FAILED</tt></b> or <b><tt class='constant'>FTP_FINISHED</tt></b> or <b><tt class='constant'>FTP_MOREDATA</tt></b>. </p> </div> <a name='function.ftp-nb-continue.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_nb_continue()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Initate&amp;nbsp;the&amp;nbsp;download<br /></span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'README'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_BINARY</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>FTP_MOREDATA</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Continue&amp;nbsp;downloading...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_nb_continue</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$my_connection</span><span style='color: #007700'>);<br />}<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;</span><span style='color: #0000BB'>FTP_FINISHED</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;an&amp;nbsp;error&amp;nbsp;downloading&amp;nbsp;the&amp;nbsp;file...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_mkdir" value="<div id='function.ftp-mkdir' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-mkdir.php'>ftp_mkdir</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_mkdir</span> &amp;mdash; <span class='dc-title'>Creates a directory</span></p> </div> <a name='function.ftp-mkdir.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ftp_mkdir</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$directory</tt></span> )</div> <p class='para rdfs-comment'> Creates the specified <i><tt class='parameter'>directory</tt></i> on the FTP server. </p> </div> <a name='function.ftp-mkdir.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>directory</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the directory that will be created. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-mkdir.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the newly created directory name on success or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ftp-mkdir.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_mkdir()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$dir&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'www'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;create&amp;nbsp;the&amp;nbsp;directory&amp;nbsp;$dir<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_mkdir</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$dir</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'successfully&amp;nbsp;created&amp;nbsp;</span><span style='color: #0000BB'>$dir</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;a&amp;nbsp;problem&amp;nbsp;while&amp;nbsp;creating&amp;nbsp;</span><span style='color: #0000BB'>$dir</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-mkdir.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-rmdir.php' class='function' rel='rdfs-seeAlso'>ftp_rmdir()</a> - Removes a directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_mdtm" value="<div id='function.ftp-mdtm' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-mdtm.php'>ftp_mdtm</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_mdtm</span> &amp;mdash; <span class='dc-title'>Returns the last modified time of the given file</span></p> </div> <a name='function.ftp-mdtm.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>ftp_mdtm</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$remote_file</tt></span> )</div> <p class='para rdfs-comment'> <b>ftp_mdtm()</b> gets the last modified time for a remote file. </p> <blockquote><p><b class='note'>Note</b>: Not all servers support this feature! <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <b>ftp_mdtm()</b> does not work with directories. <br /> </p></blockquote> </div> <a name='function.ftp-mdtm.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>remote_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The file from which to extract the last modification time. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-mdtm.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the last modified time as a Unix timestamp on success, or -1 on error. </p> </div> <a name='function.ftp-mdtm.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_mdtm()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'somefile.txt'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;&amp;nbsp;get&amp;nbsp;the&amp;nbsp;last&amp;nbsp;modified&amp;nbsp;time<br /></span><span style='color: #0000BB'>$buff&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_mdtm</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$buff&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;somefile.txt&amp;nbsp;was&amp;nbsp;last&amp;nbsp;modified&amp;nbsp;on:&amp;nbsp;March&amp;nbsp;26&amp;nbsp;2003&amp;nbsp;14:16:41.<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>&amp;nbsp;was&amp;nbsp;last&amp;nbsp;modified&amp;nbsp;on&amp;nbsp;:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>date</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'F&amp;nbsp;d&amp;nbsp;Y&amp;nbsp;H:i:s.'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$buff</span><span style='color: #007700'>);<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Couldn't&amp;nbsp;get&amp;nbsp;mdtime'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_login" value="<div id='function.ftp-login' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-login.php'>ftp_login</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_login</span> &amp;mdash; <span class='dc-title'>Logs in to an FTP connection</span></p> </div> <a name='function.ftp-login.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_login</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> )</div> <p class='para rdfs-comment'> Logs in to the given FTP stream. </p> </div> <a name='function.ftp-login.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The username (<i>USER</i>). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password (<i>PASS</i>). </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-login.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. If login fails, PHP will also throw a warning. </p> </div> <a name='function.ftp-login.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_login()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />$ftp_server&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ftp.example.com'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$ftp_user&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'foo'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$ftp_pass&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'bar'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;or&amp;nbsp;die<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Couldn't&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);&amp;nbsp;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;login<br /></span><span style='color: #007700'>if&amp;nbsp;(@</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_pass</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connected&amp;nbsp;as&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user</span><span style='color: #DD0000'>@</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Couldn't&amp;nbsp;connect&amp;nbsp;as&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_get_option" value="<div id='function.ftp-get-option' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-get-option.php'>ftp_get_option</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_get_option</span> &amp;mdash; <span class='dc-title'>Retrieves various runtime behaviours of the current FTP stream</span></p> </div> <a name='function.ftp-get-option.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>ftp_get_option</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$option</tt></span> )</div> <p class='para rdfs-comment'> This function returns the value for the requested <i><tt class='parameter'>option</tt></i> from the specified FTP connection. </p> </div> <a name='function.ftp-get-option.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Currently, the following options are supported: </p><table class='doctable table'> <caption><b>Supported runtime FTP options</b></caption> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>FTP_TIMEOUT_SEC</tt></b></td> <td align='left'> Returns the current timeout used for network related operations. </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>FTP_AUTOSEEK</tt></b></td> <td align='left'> Returns <b><tt class='constant'>TRUE</tt></b> if this option is on, <b><tt class='constant'>FALSE</tt></b> otherwise. </td> </tr> </tbody> </table> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-get-option.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the value on success or <b><tt class='constant'>FALSE</tt></b> if the given <i><tt class='parameter'>option</tt></i> is not supported. In the latter case, a warning message is also thrown. </p> </div> <a name='function.ftp-get-option.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_get_option()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;the&amp;nbsp;timeout&amp;nbsp;of&amp;nbsp;the&amp;nbsp;given&amp;nbsp;FTP&amp;nbsp;stream<br /></span><span style='color: #0000BB'>$timeout&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_TIMEOUT_SEC</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-get-option.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-set-option.php' class='function' rel='rdfs-seeAlso'>ftp_set_option()</a> - Set miscellaneous runtime FTP options</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_get" value="<div id='function.ftp-get' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-get.php'>ftp_get</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_get</span> &amp;mdash; <span class='dc-title'>Downloads a file from the FTP server</span></p> </div> <a name='function.ftp-get.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_get</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$local_file</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$remote_file</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resumepos</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>ftp_get()</b> retrieves a remote file from the FTP server, and saves it into a local file. </p> </div> <a name='function.ftp-get.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>local_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The local file path (will be overwritten if the file already exists). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>remote_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The remote file path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The transfer mode. Must be either <b><tt class='constant'>FTP_ASCII</tt></b> or <b><tt class='constant'>FTP_BINARY</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>resumepos</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The position in the remote file to start downloading from. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-get.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-get.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_get()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;define&amp;nbsp;some&amp;nbsp;variables<br /></span><span style='color: #0000BB'>$local_file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'local.zip'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$server_file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'server.zip'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;download&amp;nbsp;$server_file&amp;nbsp;and&amp;nbsp;save&amp;nbsp;to&amp;nbsp;$local_file<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$local_file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$server_file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_BINARY</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Successfully&amp;nbsp;written&amp;nbsp;to&amp;nbsp;</span><span style='color: #0000BB'>$local_file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;a&amp;nbsp;problem\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-get.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> <i><tt class='parameter'>resumepos</tt></i> was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ftp-get.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-pasv.php' class='function' rel='rdfs-seeAlso'>ftp_pasv()</a> - Turns passive mode on or off</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-fget.php' class='function' rel='rdfs-seeAlso'>ftp_fget()</a> - Downloads a file from the FTP server and saves to an open file</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-get.php' class='function' rel='rdfs-seeAlso'>ftp_nb_get()</a> - Retrieves a file from the FTP server and writes it to a local file (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-fget.php' class='function' rel='rdfs-seeAlso'>ftp_nb_fget()</a> - Retrieves a file from the FTP server and writes it to an open file (non-blocking)</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_fput" value="<div id='function.ftp-fput' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-fput.php'>ftp_fput</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_fput</span> &amp;mdash; <span class='dc-title'>Uploads from an open file to the FTP server</span></p> </div> <a name='function.ftp-fput.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_fput</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$remote_file</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$handle</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$startpos</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>ftp_fput()</b> uploads the data from a file pointer to a remote file on the FTP server. </p> </div> <a name='function.ftp-fput.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>remote_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The remote file path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>handle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An open file pointer on the local file. Reading stops at end of file. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The transfer mode. Must be either <b><tt class='constant'>FTP_ASCII</tt></b> or <b><tt class='constant'>FTP_BINARY</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>startpos</tt></i> </span> </dt><dd class='listitem'> </dd> </dl> <p> </p> </div> <a name='function.ftp-fput.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-fput.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_fput()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;open&amp;nbsp;some&amp;nbsp;file&amp;nbsp;for&amp;nbsp;reading<br /></span><span style='color: #0000BB'>$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'somefile.txt'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$fp&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>fopen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'r'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;upload&amp;nbsp;$file<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_fput</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_ASCII</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Successfully&amp;nbsp;uploaded&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;a&amp;nbsp;problem&amp;nbsp;while&amp;nbsp;uploading&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection&amp;nbsp;and&amp;nbsp;the&amp;nbsp;file&amp;nbsp;handler<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>fclose</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-fput.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> <i><tt class='parameter'>startpos</tt></i> was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ftp-fput.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-put.php' class='function' rel='rdfs-seeAlso'>ftp_put()</a> - Uploads a file to the FTP server</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-fput.php' class='function' rel='rdfs-seeAlso'>ftp_nb_fput()</a> - Stores a file from an open file to the FTP server (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-put.php' class='function' rel='rdfs-seeAlso'>ftp_nb_put()</a> - Stores a file on the FTP server (non-blocking)</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_fget" value="<div id='function.ftp-fget' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-fget.php'>ftp_fget</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_fget</span> &amp;mdash; <span class='dc-title'>Downloads a file from the FTP server and saves to an open file</span></p> </div> <a name='function.ftp-fget.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_fget</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$handle</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$remote_file</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resumepos</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>ftp_fget()</b> retrieves <i><tt class='parameter'>remote_file</tt></i> from the FTP server, and writes it to the given file pointer. </p> </div> <a name='function.ftp-fget.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>handle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An open file pointer in which we store the data. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>remote_file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The remote file path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The transfer mode. Must be either <b><tt class='constant'>FTP_ASCII</tt></b> or <b><tt class='constant'>FTP_BINARY</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>resumepos</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The position in the remote file to start downloading from. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-fget.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-fget.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_fget()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;path&amp;nbsp;to&amp;nbsp;remote&amp;nbsp;file<br /></span><span style='color: #0000BB'>$remote_file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'somefile.txt'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$local_file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localfile.txt'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;open&amp;nbsp;some&amp;nbsp;file&amp;nbsp;to&amp;nbsp;write&amp;nbsp;to<br /></span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>fopen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$local_file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'w'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;download&amp;nbsp;$remote_file&amp;nbsp;and&amp;nbsp;save&amp;nbsp;it&amp;nbsp;to&amp;nbsp;$handle<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_fget</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$remote_file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_ASCII</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'successfully&amp;nbsp;written&amp;nbsp;to&amp;nbsp;</span><span style='color: #0000BB'>$local_file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;a&amp;nbsp;problem&amp;nbsp;while&amp;nbsp;downloading&amp;nbsp;</span><span style='color: #0000BB'>$remote_file</span><span style='color: #DD0000'>&amp;nbsp;to&amp;nbsp;</span><span style='color: #0000BB'>$local_file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection&amp;nbsp;and&amp;nbsp;the&amp;nbsp;file&amp;nbsp;handler<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>fclose</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-fget.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> <i><tt class='parameter'>resumepos</tt></i> was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ftp-fget.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-get.php' class='function' rel='rdfs-seeAlso'>ftp_get()</a> - Downloads a file from the FTP server</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-get.php' class='function' rel='rdfs-seeAlso'>ftp_nb_get()</a> - Retrieves a file from the FTP server and writes it to a local file (non-blocking)</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-nb-fget.php' class='function' rel='rdfs-seeAlso'>ftp_nb_fget()</a> - Retrieves a file from the FTP server and writes it to an open file (non-blocking)</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_exec" value="<div id='function.ftp-exec' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-exec.php'>ftp_exec</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.3, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_exec</span> &amp;mdash; <span class='dc-title'>Requests execution of a command on the FTP server</span></p> </div> <a name='function.ftp-exec.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_exec</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$command</tt></span> )</div> <p class='para rdfs-comment'> Sends a SITE EXEC <i><tt class='parameter'>command</tt></i> request to the FTP server. </p> </div> <a name='function.ftp-exec.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>command</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The command to execute. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-exec.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the command was successful (server sent response code: <i>200</i>); otherwise returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.ftp-exec.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_exec()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;variable&amp;nbsp;initialization<br /></span><span style='color: #0000BB'>$command&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ls&amp;nbsp;-al&amp;nbsp;&amp;gt;files.txt'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;execute&amp;nbsp;command<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$command</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$command</span><span style='color: #DD0000'>&amp;nbsp;executed&amp;nbsp;successfully\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'could&amp;nbsp;not&amp;nbsp;execute&amp;nbsp;</span><span style='color: #0000BB'>$command</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-exec.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-raw.php' class='function' rel='rdfs-seeAlso'>ftp_raw()</a> - Sends an arbitrary command to an FTP server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_delete" value="<div id='function.ftp-delete' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-delete.php'>ftp_delete</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_delete</span> &amp;mdash; <span class='dc-title'>Deletes a file on the FTP server</span></p> </div> <a name='function.ftp-delete.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_delete</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$path</tt></span> )</div> <p class='para rdfs-comment'> <b>ftp_delete()</b> deletes the file specified by <i><tt class='parameter'>path</tt></i> from the FTP server. </p> </div> <a name='function.ftp-delete.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>path</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The file to delete. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-delete.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-delete.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_delete()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'public_html/old.txt'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;delete&amp;nbsp;$file<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_delete</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>&amp;nbsp;deleted&amp;nbsp;successful\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'could&amp;nbsp;not&amp;nbsp;delete&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_connect" value="<div id='function.ftp-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-connect.php'>ftp_connect</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_connect</span> &amp;mdash; <span class='dc-title'>Opens an FTP connection</span></p> </div> <a name='function.ftp-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>ftp_connect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$host</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt><span class='initializer'> = 21</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timeout</tt><span class='initializer'> = 90</span></span> ]] )</div> <p class='para rdfs-comment'> <b>ftp_connect()</b> opens an FTP connection to the specified <i><tt class='parameter'>host</tt></i> . </p> </div> <a name='function.ftp-connect.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>host</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The FTP server address. This parameter shouldn&amp;#039;t have any trailing slashes and shouldn&amp;#039;t be prefixed with <i>ftp://</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This parameter specifies an alternate port to connect to. If it is omitted or set to zero, then the default FTP port, 21, will be used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timeout</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This parameter specifies the timeout for all subsequent network operations. If omitted, the default value is 90 seconds. The timeout can be changed and queried at any time with <a href='http://www.php.net/manual/en/function.ftp-set-option.php' class='function'>ftp_set_option()</a> and <a href='http://www.php.net/manual/en/function.ftp-get-option.php' class='function'>ftp_get_option()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a FTP stream on success or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ftp-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_connect()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$ftp_server&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ftp.example.com'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;or&amp;nbsp;die<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Couldn't&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);&amp;nbsp;<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-connect.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.2.0</td> <td align='left'> <i><tt class='parameter'>timeout</tt></i> was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ftp-connect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-close.php' class='function' rel='rdfs-seeAlso'>ftp_close()</a> - Closes an FTP connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-ssl-connect.php' class='function' rel='rdfs-seeAlso'>ftp_ssl_connect()</a> - Opens an Secure SSL-FTP connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_close" value="<div id='function.ftp-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-close.php'>ftp_close</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_close</span> &amp;mdash; <span class='dc-title'>Closes an FTP connection</span></p> </div> <a name='function.ftp-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_close</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> )</div> <p class='para rdfs-comment'> <b>ftp_close()</b> closes the given link identifier and releases the <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> <blockquote><p><b class='note'>Note</b>: After calling this function, you can no longer use the FTP connection and must create a new one with <a href='http://www.php.net/manual/en/function.ftp-connect.php' class='function'>ftp_connect()</a>. <br /> </p></blockquote> </div> <a name='function.ftp-close.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-close.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_close()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;print&amp;nbsp;the&amp;nbsp;current&amp;nbsp;directory<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>ftp_pwd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;/<br /><br />//&amp;nbsp;close&amp;nbsp;this&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-close.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-connect.php' class='function' rel='rdfs-seeAlso'>ftp_connect()</a> - Opens an FTP connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_chmod" value="<div id='function.ftp-chmod' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-chmod.php'>ftp_chmod</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_chmod</span> &amp;mdash; <span class='dc-title'>Set permissions on a file via FTP</span></p> </div> <a name='function.ftp-chmod.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>ftp_chmod</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Sets the permissions on the specified remote file to <i><tt class='parameter'>mode</tt></i> . </p> </div> <a name='function.ftp-chmod.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new permissions, given as an <em class='emphasis'>octal</em> value. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The remote file. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-chmod.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the new file permissions on success or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ftp-chmod.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_chmod()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'public_html/index.php'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;chmod&amp;nbsp;$file&amp;nbsp;to&amp;nbsp;644<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_chmod</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0644</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>)&amp;nbsp;!==&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>&amp;nbsp;chmoded&amp;nbsp;successfully&amp;nbsp;to&amp;nbsp;644\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'could&amp;nbsp;not&amp;nbsp;chmod&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-chmod.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.chmod.php' class='function' rel='rdfs-seeAlso'>chmod()</a> - Changes file mode</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_chdir" value="<div id='function.ftp-chdir' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-chdir.php'>ftp_chdir</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_chdir</span> &amp;mdash; <span class='dc-title'>Changes the current directory on a FTP server</span></p> </div> <a name='function.ftp-chdir.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_chdir</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$directory</tt></span> )</div> <p class='para rdfs-comment'> Changes the current directory to the specified one. </p> </div> <a name='function.ftp-chdir.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>directory</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The target directory. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-chdir.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. If changing directory fails, PHP will also throw a warning. </p> </div> <a name='function.ftp-chdir.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_chdir()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);&amp;nbsp;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);&amp;nbsp;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;connection<br /></span><span style='color: #007700'>if&amp;nbsp;((!</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>)&amp;nbsp;||&amp;nbsp;(!</span><span style='color: #0000BB'>$login_result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'FTP&amp;nbsp;connection&amp;nbsp;has&amp;nbsp;failed&amp;nbsp;!'</span><span style='color: #007700'>);<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Current&amp;nbsp;directory:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ftp_pwd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;change&amp;nbsp;the&amp;nbsp;directory&amp;nbsp;to&amp;nbsp;somedir<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_chdir</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'somedir'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Current&amp;nbsp;directory&amp;nbsp;is&amp;nbsp;now:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ftp_pwd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Couldn't&amp;nbsp;change&amp;nbsp;directory\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;close&amp;nbsp;the&amp;nbsp;connection<br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-chdir.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-cdup.php' class='function' rel='rdfs-seeAlso'>ftp_cdup()</a> - Changes to the parent directory</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-pwd.php' class='function' rel='rdfs-seeAlso'>ftp_pwd()</a> - Returns the current directory name</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_cdup" value="<div id='function.ftp-cdup' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-cdup.php'>ftp_cdup</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_cdup</span> &amp;mdash; <span class='dc-title'>Changes to the parent directory</span></p> </div> <a name='function.ftp-cdup.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_cdup</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> )</div> <p class='para rdfs-comment'> Changes to the parent directory. </p> </div> <a name='function.ftp-cdup.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-cdup.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-cdup.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_cdup()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;up&amp;nbsp;basic&amp;nbsp;connection<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ftp_server</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;login&amp;nbsp;with&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ftp_user_pass</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;change&amp;nbsp;the&amp;nbsp;current&amp;nbsp;directory&amp;nbsp;to&amp;nbsp;html<br /></span><span style='color: #0000BB'>ftp_chdir</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'html'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>ftp_pwd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;/html&amp;nbsp;<br /><br />//&amp;nbsp;return&amp;nbsp;to&amp;nbsp;the&amp;nbsp;parent&amp;nbsp;directory<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_cdup</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>))&amp;nbsp;{&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'cdup&amp;nbsp;successful\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'cdup&amp;nbsp;not&amp;nbsp;successful\n'</span><span style='color: #007700'>;<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>ftp_pwd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;/<br /><br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-cdup.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-chdir.php' class='function' rel='rdfs-seeAlso'>ftp_chdir()</a> - Changes the current directory on a FTP server</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-pwd.php' class='function' rel='rdfs-seeAlso'>ftp_pwd()</a> - Returns the current directory name</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ftp_alloc" value="<div id='function.ftp-alloc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ftp-alloc.php'>ftp_alloc</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>ftp_alloc</span> &amp;mdash; <span class='dc-title'>Allocates space for a file to be uploaded</span></p> </div> <a name='function.ftp-alloc.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ftp_alloc</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$ftp_stream</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$filesize</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter reference'>&amp;amp;$result</tt></span> ] )</div> <p class='para rdfs-comment'> Sends an <i>ALLO</i> command to the remote FTP server to allocate space for a file to be uploaded. </p> <blockquote><p><b class='note'>Note</b>: Many FTP servers do not support this command. These servers may return a failure code (<b><tt class='constant'>FALSE</tt></b>) indicating the command is not supported or a success code (<b><tt class='constant'>TRUE</tt></b>) to indicate that pre-allocation is not necessary and the client should continue as though the operation were successful. Because of this, it may be best to reserve this function for servers which explicitly require preallocation. <br /> </p></blockquote> <p class='para'> </p> </div> <a name='function.ftp-alloc.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ftp_stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The link identifier of the FTP connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filesize</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of bytes to allocate. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>return</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A textual representation of the servers response will be returned by reference in <i><tt class='parameter'>result</tt></i> if a variable is provided. </p> </dd> </dl> <p> </p> </div> <a name='function.ftp-alloc.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ftp-alloc.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ftp_alloc()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'/home/user/myfile'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;the&amp;nbsp;server<br /></span><span style='color: #0000BB'>$conn_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ftp.example.com'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$login_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ftp_login</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'anonymous'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'user@example.com'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>ftp_alloc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>filesize</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Space&amp;nbsp;successfully&amp;nbsp;allocated&amp;nbsp;on&amp;nbsp;server.&amp;nbsp;&amp;nbsp;Sending&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #DD0000'>.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>ftp_put</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'/incomming/myfile'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FTP_BINARY</span><span style='color: #007700'>);<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;allocate&amp;nbsp;space&amp;nbsp;on&amp;nbsp;server.&amp;nbsp;&amp;nbsp;Server&amp;nbsp;said:&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>ftp_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ftp-alloc.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-put.php' class='function' rel='rdfs-seeAlso'>ftp_put()</a> - Uploads a file to the FTP server</li> <li class='member'><a href='http://www.php.net/manual/en/function.ftp-fput.php' class='function' rel='rdfs-seeAlso'>ftp_fput()</a> - Uploads from an open file to the FTP server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="frenchtojd" value="<div id='function.frenchtojd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.frenchtojd.php'>FrenchToJD</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>FrenchToJD</span> &amp;mdash; <span class='dc-title'>Converts a date from the French Republican Calendar to a Julian Day Count</span></p> </div> <a name='function.frenchtojd.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>frenchtojd</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$month</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$day</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$year</tt></span> )</div> <p class='para rdfs-comment'> Converts a date from the French Republican Calendar to a Julian Day Count. </p> <p class='para'> These routines only convert dates in years 1 through 14 (Gregorian dates 22 September 1792 through 22 September 1806). This more than covers the period when the calendar was in use. </p> </div> <a name='function.frenchtojd.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>month</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The month as a number from 1 (for Vend&amp;Atilde;&amp;copy;miaire) to 13 (for the period of 5-6 days at the end of each year) </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>day</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The day as a number from 1 to 30 </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>year</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The year as a number between 1 and 14 </p> </dd> </dl> <p> </p> </div> <a name='function.frenchtojd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The julian day for the given french revolution date as an integer. </p> </div> <a name='function.frenchtojd.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.jdtofrench.php' class='function' rel='rdfs-seeAlso'>jdtofrench()</a> - Converts a Julian Day Count to the French Republican Calendar</li> <li class='member'><a href='http://www.php.net/manual/en/function.cal-to-jd.php' class='function' rel='rdfs-seeAlso'>cal_to_jd()</a> - Converts from a supported calendar to Julian Day Count</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="exif_thumbnail" value="<div id='function.exif-thumbnail' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.exif-thumbnail.php'>exif_thumbnail</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>exif_thumbnail</span> &amp;mdash; <span class='dc-title'>Retrieve the embedded thumbnail of a TIFF or JPEG image</span></p> </div> <a name='function.exif-thumbnail.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>exif_thumbnail</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter reference'>&amp;amp;$width</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter reference'>&amp;amp;$height</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter reference'>&amp;amp;$imagetype</tt></span> ]]] )</div> <p class='para rdfs-comment'> <b>exif_thumbnail()</b> reads the embedded thumbnail of a <acronym title='Tagged Image File Format'>TIFF</acronym> or <acronym title='Joint Photographic Experts Group'>JPEG</acronym> image. </p> <p class='para'> If you want to deliver thumbnails through this function, you should send the mimetype information using the <a href='http://www.php.net/manual/en/function.header.php' class='function'>header()</a> function. </p> <p class='para'> It is possible that <b>exif_thumbnail()</b> cannot create an image but can determine its size. In this case, the return value is <b><tt class='constant'>FALSE</tt></b> but <i><tt class='parameter'>width</tt></i> and <i><tt class='parameter'>height</tt></i> are set. </p> </div> <a name='function.exif-thumbnail.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the image file being read. This image contains an embedded thumbnail. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>width</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The return width of the returned thumbnail. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>height</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The returned height of the returned thumbnail. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>imagetype</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The returned image type of the returned thumbnail. This is either <acronym title='Tagged Image File Format'>TIFF</acronym> or <acronym title='Joint Photographic Experts Group'>JPEG</acronym>. </p> </dd> </dl> <p> </p> </div> <a name='function.exif-thumbnail.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the embedded thumbnail, or <b><tt class='constant'>FALSE</tt></b> if the image contains no thumbnail. </p> </div> <a name='function.exif-thumbnail.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> The optional parameters <i><tt class='parameter'>width</tt></i> , <i><tt class='parameter'>height</tt></i> , and <i><tt class='parameter'>imagetype</tt></i> all became available. </td> </tr> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> May return thumbnails in the <acronym title='Tagged Image File Format'>TIFF</acronym> format. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.exif-thumbnail.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>exif_thumbnail()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>array_key_exists</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'file'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$_REQUEST</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>exif_thumbnail</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$_REQUEST</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'file'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$width</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$height</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$type</span><span style='color: #007700'>);<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>;<br />}<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>!==</span><span style='color: #0000BB'>false</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.</span><span style='color: #0000BB'>image_type_to_mime_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$type</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;no&amp;nbsp;thumbnail&amp;nbsp;available,&amp;nbsp;handle&amp;nbsp;the&amp;nbsp;error&amp;nbsp;here<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;thumbnail&amp;nbsp;available'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.exif-thumbnail.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.exif-read-data.php' class='function' rel='rdfs-seeAlso'>exif_read_data()</a> - Reads the EXIF headers from JPEG or TIFF</li> <li class='member'><a href='http://www.php.net/manual/en/function.image-type-to-mime-type.php' class='function' rel='rdfs-seeAlso'>image_type_to_mime_type()</a> - Get Mime-Type for image-type returned by getimagesize, exif_read_data, exif_thumbnail, exif_imagetype</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="exif_tagname" value="<div id='function.exif-tagname' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.exif-tagname.php'>exif_tagname</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>exif_tagname</span> &amp;mdash; <span class='dc-title'>Get the header name for an index</span></p> </div> <a name='function.exif-tagname.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>exif_tagname</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$index</tt></span> )</div> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is currently not documented; only its argument list is available. </p></div> </div> <a name='function.exif-tagname.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The image index </p> </dd> </dl> <p> </p> </div> <a name='function.exif-tagname.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the header name, or <b><tt class='constant'>FALSE</tt></b> if <i><tt class='parameter'>index</tt></i> is undefined. </p> </div> <a name='function.exif-tagname.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.exif-imagetype.php' class='function' rel='rdfs-seeAlso'>exif_imagetype()</a> - Determine the type of an image</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="exif_read_data" value="<div id='function.exif-read-data' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.exif-read-data.php'>exif_read_data</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>exif_read_data</span> &amp;mdash; <span class='dc-title'>Reads the <acronym title='Exchangeable Image File '>EXIF</acronym> headers from <acronym title='Joint Photographic Experts Group'>JPEG</acronym> or <acronym title='Tagged Image File Format'>TIFF</acronym></span></p> </div> <a name='function.exif-read-data.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>exif_read_data</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$sections</tt><span class='initializer'> = NULL</span></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$arrays</tt><span class='initializer'> = false</span></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$thumbnail</tt><span class='initializer'> = false</span></span> ]]] )</div> <p class='para rdfs-comment'> <b>exif_read_data()</b> reads the <acronym title='Exchangeable Image File '>EXIF</acronym> headers from a <acronym title='Joint Photographic Experts Group'>JPEG</acronym> or <acronym title='Tagged Image File Format'>TIFF</acronym> image file. This way you can read meta data generated by digital cameras. </p> <p class='para'> <acronym title='Exchangeable Image File '>EXIF</acronym> headers tend to be present in JPEG/TIFF images generated by digital cameras, but unfortunately each digital camera maker has a different idea of how to actually tag their images, so you can&amp;#039;t always rely on a specific Exif header being present. </p> <p class='para'> <i>Height</i> and <i>Width</i> are computed the same way <a href='http://www.php.net/manual/en/function.getimagesize.php' class='function'>getimagesize()</a> does so their values must not be part of any header returned. Also, <i>html</i> is a height/width text string to be used inside normal <acronym title='Hyper Text Markup Language'>HTML</acronym>. </p> <p class='para'> When an Exif header contains a Copyright note, this itself can contain two values. As the solution is inconsistent in the Exif 2.10 standard, the <i>COMPUTED</i> section will return both entries <i>Copyright.Photographer</i> and <i>Copyright.Editor</i> while the <i>IFD0</i> sections contains the byte array with the NULL character that splits both entries. Or just the first entry if the datatype was wrong (normal behaviour of Exif). The <i>COMPUTED</i> will also contain the entry <i>Copyright</i> which is either the original copyright string, or a comma separated list of the photo and editor copyright. </p> <p class='para'> The tag <i>UserComment</i> has the same problem as the Copyright tag. It can store two values. First the encoding used, and second the value itself. If so the <i>IFD</i> section only contains the encoding or a byte array. The <i>COMPUTED</i> section will store both in the entries <i>UserCommentEncoding</i> and <i>UserComment</i>. The entry <i>UserComment</i> is available in both cases so it should be used in preference to the value in <i>IFD0</i> section. </p> <p class='para'> <b>exif_read_data()</b> also validates EXIF data tags according to the EXIF specification (<a href='http://exif.org/Exif2-2.PDF' class='link external'>&amp;raquo; http://exif.org/Exif2-2.PDF</a>, page 20). </p> <blockquote><p><b class='note'>Note</b>: Windows ME/XP can both wipe the Exif headers when connecting to a camera. More information available at <a href='http://www.canon.co.jp/Imaging/NOTICE/011214-e.html' class='link external'>&amp;raquo; http://www.canon.co.jp/Imaging/NOTICE/011214-e.html</a>. <br /> </p></blockquote> </div> <a name='function.exif-read-data.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the image file being read. This cannot be an <acronym title='Uniform Resource Locator'>URL</acronym>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>sections</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Is a comma separated list of sections that need to be present in file to produce a result <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>. If none of the requested sections could be found the return value is <b><tt class='constant'>FALSE</tt></b>. </p><table class='doctable informaltable'> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>FILE</td> <td align='left'>FileName, FileSize, FileDateTime, SectionsFound</td> </tr> <tr valign='middle'> <td align='left'>COMPUTED</td> <td align='left'> html, Width, Height, IsColor, and more if available. Height and Width are computed the same way <a href='http://www.php.net/manual/en/function.getimagesize.php' class='function'>getimagesize()</a> does so their values must not be part of any header returned. Also, <i>html</i> is a height/width text string to be used inside normal <acronym title='Hyper Text Markup Language'>HTML</acronym>. </td> </tr> <tr valign='middle'> <td align='left'>ANY_TAG</td> <td align='left'>Any information that has a Tag e.g. <i>IFD0</i>, <i>EXIF</i>, ...</td> </tr> <tr valign='middle'> <td align='left'>IFD0</td> <td align='left'> All tagged data of IFD0. In normal imagefiles this contains image size and so forth. </td> </tr> <tr valign='middle'> <td align='left'>THUMBNAIL</td> <td align='left'> A file is supposed to contain a thumbnail if it has a second <i>IFD</i>. All tagged information about the embedded thumbnail is stored in this section. </td> </tr> <tr valign='middle'> <td align='left'>COMMENT</td> <td align='left'>Comment headers of JPEG images.</td> </tr> <tr valign='middle'> <td align='left'>EXIF</td> <td align='left'> The EXIF section is a sub section of <i>IFD0</i>. It contains more detailed information about an image. Most of these entries are digital camera related. </td> </tr> </tbody> </table> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>arrays</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies whether or not each section becomes an array. The <i><tt class='parameter'>sections</tt></i> <i>COMPUTED</i>, <i>THUMBNAIL</i>, and <i>COMMENT</i> always become arrays as they may contain values whose names conflict with other sections. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>thumbnail</tt></i> </span> </dt><dd class='listitem'> <p class='para'> When set to <b><tt class='constant'>TRUE</tt></b> the thumbnail itself is read. Otherwise, only the tagged data is read. </p> </dd> </dl> <p> </p> </div> <a name='function.exif-read-data.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> It returns an associative <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> where the array indexes are the header names and the array values are the values associated with those headers. If no data can be returned, <b>exif_read_data()</b> will return <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.exif-read-data.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> Can read all embedded <acronym title='Image File Directory'>IFD</acronym> data including arrays (returned as such). Also the size of an embedded thumbnail is returned in a <i>THUMBNAIL</i> subarray, and can return thumbnails in <acronym title='Tagged Image File Format'>TIFF</acronym> format. Also, there is no longer a maximum length for returned values (not until the memory limit has been reached) </td> </tr> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> If PHP has <a href='http://www.php.net/manual/en/ref.mbstring.php' class='link'>mbstring</a> support, the user comment can automatically change encoding. Also, if the user comment uses <i>Unicode</i> or <i>JIS</i> encoding this encoding will automatically be changed according to the exif ini settings in <var class='filename'>php.ini</var> </td> </tr> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> If the image contains any <i>IFD0</i> data then <i>COMPUTED</i> contains the entry <i>ByteOrderMotorola</i> which is 0 for <i>little-endian</i> (intel) and 1 for <i>big-endian</i> (motorola) byte order. Also, <i>COMPUTED</i> and <i>UserComment</i> no longer only contain the first copyright entry if the datatype was wrong. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.exif-read-data.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>exif_read_data()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'test1.jpg:&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$exif&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>exif_read_data</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'tests/test1.jpg'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'IFD0'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$exif</span><span style='color: #007700'>===</span><span style='color: #0000BB'>false&amp;nbsp;</span><span style='color: #007700'>?&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;header&amp;nbsp;data&amp;nbsp;found.&amp;lt;br&amp;nbsp;/&amp;gt;\n'&amp;nbsp;</span><span style='color: #007700'>:&amp;nbsp;</span><span style='color: #DD0000'>'Image&amp;nbsp;contains&amp;nbsp;headers&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$exif&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>exif_read_data</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'tests/test2.jpg'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'test2.jpg:&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />foreach&amp;nbsp;(</span><span style='color: #0000BB'>$exif&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$key&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$section</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach&amp;nbsp;(</span><span style='color: #0000BB'>$section&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$name&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$key</span><span style='color: #DD0000'>.</span><span style='color: #0000BB'>$name</span><span style='color: #DD0000'>:&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #DD0000'>&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p> The first call fails because the image has no header information. </p></div> <div class='example-contents para'><p>The above example will output something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> test1.jpg: No header data found. test2.jpg: FILE.FileName: test2.jpg FILE.FileDateTime: 1017666176 FILE.FileSize: 1240 FILE.FileType: 2 FILE.SectionsFound: ANY_TAG, IFD0, THUMBNAIL, COMMENT COMPUTED.html: width=&amp;quot;1&amp;quot; height=&amp;quot;1&amp;quot; COMPUTED.Height: 1 COMPUTED.Width: 1 COMPUTED.IsColor: 1 COMPUTED.ByteOrderMotorola: 1 COMPUTED.UserComment: Exif test image. COMPUTED.UserCommentEncoding: ASCII COMPUTED.Copyright: Photo (c) M.Boerger, Edited by M.Boerger. COMPUTED.Copyright.Photographer: Photo (c) M.Boerger COMPUTED.Copyright.Editor: Edited by M.Boerger. IFD0.Copyright: Photo (c) M.Boerger IFD0.UserComment: ASCII THUMBNAIL.JPEGInterchangeFormat: 134 THUMBNAIL.JPEGInterchangeFormatLength: 523 COMMENT.0: Comment #1. COMMENT.1: Comment #2. COMMENT.2: Comment #3end THUMBNAIL.JPEGInterchangeFormat: 134 THUMBNAIL.Thumbnail.Height: 1 THUMBNAIL.Thumbnail.Height: 1 </pre></div> </div> </div><p> </p> </div> <a name='function.exif-read-data.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.exif-thumbnail.php' class='function' rel='rdfs-seeAlso'>exif_thumbnail()</a> - Retrieve the embedded thumbnail of a TIFF or JPEG image</li> <li class='member'><a href='http://www.php.net/manual/en/function.getimagesize.php' class='function' rel='rdfs-seeAlso'>getimagesize()</a> - Get the size of an image</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="exif_imagetype" value="<div id='function.exif-imagetype' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.exif-imagetype.php'>exif_imagetype</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>exif_imagetype</span> &amp;mdash; <span class='dc-title'>Determine the type of an image</span></p> </div> <a name='function.exif-imagetype.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>exif_imagetype</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> <b>exif_imagetype()</b> reads the first bytes of an image and checks its signature. </p> <p class='para'> <b>exif_imagetype()</b> can be used to avoid calls to other <a href='http://www.php.net/manual/en/ref.exif.php' class='link'>exif</a> functions with unsupported file types or in conjunction with <var class='varname'><a href='http://www.php.net/manual/en/reserved.variables.server.php' class='classname'>$_SERVER['HTTP_ACCEPT']</a></var> to check whether or not the viewer is able to see a specific image in the browser. </p> </div> <a name='function.exif-imagetype.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <span class='simpara'> The image being checked. </span> </dd> </dl> <p> </p> </div> <a name='function.exif-imagetype.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> When a correct signature is found, the appropriate constant value will be returned otherwise the return value is <b><tt class='constant'>FALSE</tt></b>. The return value is the same value that <a href='http://www.php.net/manual/en/function.getimagesize.php' class='function'>getimagesize()</a> returns in index 2 but <b>exif_imagetype()</b> is much faster. </p> </div> <a name='function.exif-imagetype.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.2</td> <td align='left'> Support for <acronym title='Japan Picture'>JPC</acronym>, <acronym title='JPEG-2000'>JP2</acronym>, <acronym>JPX</acronym>, <acronym title='Joint Bilevel Image Experts Group'>JB2</acronym>, <acronym title='X Bitmap'>XBM</acronym>, and <acronym title='Wireless Bitmap'>WBMP</acronym> </td> </tr> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'>Support for <acronym>SWC</acronym></td> </tr> </tbody> </table> <p> </p> </div> <a name='function.exif-imagetype.constants'></a><div class='refsect1 constants'> <h3 class='title'>Predefined Constants</h3> <p class='para'> The following constants are defined, and represent possible <b>exif_imagetype()</b> return values: </p><table class='doctable table'> <caption><b>Imagetype Constants</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Value</th> <th>Constant</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>1</td> <td align='left'><b><tt class='constant'>IMAGETYPE_GIF</tt></b></td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'><b><tt class='constant'>IMAGETYPE_JPEG</tt></b></td> </tr> <tr valign='middle'> <td align='left'>3</td> <td align='left'><b><tt class='constant'>IMAGETYPE_PNG</tt></b></td> </tr> <tr valign='middle'> <td align='left'>4</td> <td align='left'><b><tt class='constant'>IMAGETYPE_SWF</tt></b></td> </tr> <tr valign='middle'> <td align='left'>5</td> <td align='left'><b><tt class='constant'>IMAGETYPE_PSD</tt></b></td> </tr> <tr valign='middle'> <td align='left'>6</td> <td align='left'><b><tt class='constant'>IMAGETYPE_BMP</tt></b></td> </tr> <tr valign='middle'> <td align='left'>7</td> <td align='left'><b><tt class='constant'>IMAGETYPE_TIFF_II</tt></b> (intel byte order)</td> </tr> <tr valign='middle'> <td align='left'>8</td> <td align='left'> <b><tt class='constant'>IMAGETYPE_TIFF_MM</tt></b> (motorola byte order) </td> </tr> <tr valign='middle'> <td align='left'>9</td> <td align='left'><b><tt class='constant'>IMAGETYPE_JPC</tt></b></td> </tr> <tr valign='middle'> <td align='left'>10</td> <td align='left'><b><tt class='constant'>IMAGETYPE_JP2</tt></b></td> </tr> <tr valign='middle'> <td align='left'>11</td> <td align='left'><b><tt class='constant'>IMAGETYPE_JPX</tt></b></td> </tr> <tr valign='middle'> <td align='left'>12</td> <td align='left'><b><tt class='constant'>IMAGETYPE_JB2</tt></b></td> </tr> <tr valign='middle'> <td align='left'>13</td> <td align='left'><b><tt class='constant'>IMAGETYPE_SWC</tt></b></td> </tr> <tr valign='middle'> <td align='left'>14</td> <td align='left'><b><tt class='constant'>IMAGETYPE_IFF</tt></b></td> </tr> <tr valign='middle'> <td align='left'>15</td> <td align='left'><b><tt class='constant'>IMAGETYPE_WBMP</tt></b></td> </tr> <tr valign='middle'> <td align='left'>16</td> <td align='left'><b><tt class='constant'>IMAGETYPE_XBM</tt></b></td> </tr> </tbody> </table> <p> </p> </div> <a name='function.exif-imagetype.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>exif_imagetype()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>exif_imagetype</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'image.gif'</span><span style='color: #007700'>)&amp;nbsp;!=&amp;nbsp;</span><span style='color: #0000BB'>IMAGETYPE_GIF</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;picture&amp;nbsp;is&amp;nbsp;not&amp;nbsp;a&amp;nbsp;gif'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.exif-imagetype.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.getimagesize.php' class='function' rel='rdfs-seeAlso'>getimagesize()</a> - Get the size of an image</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="easter_days" value="<div id='function.easter-days' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.easter-days.php'>easter_days</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>easter_days</span> &amp;mdash; <span class='dc-title'>Get number of days after March 21 on which Easter falls for a given year</span></p> </div> <a name='function.easter-days.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>easter_days</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$year</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$method</tt><span class='initializer'> = CAL_EASTER_DEFAULT</span></span> ]] )</div> <p class='para rdfs-comment'> Returns the number of days after March 21 on which Easter falls for a given year. If no year is specified, the current year is assumed. </p> <p class='para'> This function can be used instead of <a href='http://www.php.net/manual/en/function.easter-date.php' class='function'>easter_date()</a> to calculate Easter for years which fall outside the range of Unix timestamps (i.e. before 1970 or after 2037). </p> <p class='para'> The date of Easter Day was defined by the Council of Nicaea in AD325 as the Sunday after the first full moon which falls on or after the Spring Equinox. The Equinox is assumed to always fall on 21st March, so the calculation reduces to determining the date of the full moon and the date of the following Sunday. The algorithm used here was introduced around the year 532 by Dionysius Exiguus. Under the Julian Calendar (for years before 1753) a simple 19-year cycle is used to track the phases of the Moon. Under the Gregorian Calendar (for years after 1753 - devised by Clavius and Lilius, and introduced by Pope Gregory XIII in October 1582, and into Britain and its then colonies in September 1752) two correction factors are added to make the cycle more accurate. </p> <p class='para'> (The code is based on a C program by Simon Kershaw, &amp;lt;webmaster at ely.anglican dot org&amp;gt;) </p> </div> <a name='function.easter-days.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>year</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The year as a positive number </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>method</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Allows to calculate easter dates based on the Gregorian calendar during the years 1582 - 1752 when set to <b><tt class='constant'>CAL_EASTER_ROMAN</tt></b>. See the <a href='http://www.php.net/manual/en/calendar.constants.php' class='link'>calendar constants</a> for more valid constants. </p> </dd> </dl> <p> </p> </div> <a name='function.easter-days.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The number of days after March 21st that the Easter Sunday is in the given <i><tt class='parameter'>year</tt></i> . </p> </div> <a name='function.easter-days.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>Since 4.3.0</td> <td align='left'> The <i><tt class='parameter'>year</tt></i> parameter is optional and defaults to the current year according to the local time if omitted. </td> </tr> <tr valign='middle'> <td align='left'>Since 4.3.0</td> <td align='left'> The <i><tt class='parameter'>method</tt></i> parameter was introduced. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.easter-days.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>easter_days()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>easter_days</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1999</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;14,&amp;nbsp;i.e.&amp;nbsp;April&amp;nbsp;4<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>easter_days</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1492</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;32,&amp;nbsp;i.e.&amp;nbsp;April&amp;nbsp;22<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>easter_days</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1913</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;&amp;nbsp;2,&amp;nbsp;i.e.&amp;nbsp;March&amp;nbsp;23<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.easter-days.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.easter-date.php' class='function' rel='rdfs-seeAlso'>easter_date()</a> - Get Unix timestamp for midnight on Easter of a given year</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="easter_date" value="<div id='function.easter-date' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.easter-date.php'>easter_date</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>easter_date</span> &amp;mdash; <span class='dc-title'>Get Unix timestamp for midnight on Easter of a given year</span></p> </div> <a name='function.easter-date.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>easter_date</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$year</tt></span> ] )</div> <p class='para rdfs-comment'> Returns the Unix timestamp corresponding to midnight on Easter of the given year. </p> <div class='warning'><b class='warning'>Warning</b> <p class='para'> This function will generate a warning if the year is outside of the range for Unix timestamps (i.e. before 1970 or after 2037). </p> </div> <p class='para'> The date of Easter Day was defined by the Council of Nicaea in AD325 as the Sunday after the first full moon which falls on or after the Spring Equinox. The Equinox is assumed to always fall on 21st March, so the calculation reduces to determining the date of the full moon and the date of the following Sunday. The algorithm used here was introduced around the year 532 by Dionysius Exiguus. Under the Julian Calendar (for years before 1753) a simple 19-year cycle is used to track the phases of the Moon. Under the Gregorian Calendar (for years after 1753 - devised by Clavius and Lilius, and introduced by Pope Gregory XIII in October 1582, and into Britain and its then colonies in September 1752) two correction factors are added to make the cycle more accurate. </p> <p class='para'> (The code is based on a C program by Simon Kershaw, &amp;lt;webmaster at ely.anglican dot org&amp;gt;) </p> </div> <a name='function.easter-date.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>year</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The year as a number between 1970 an 2037 </p> </dd> </dl> <p> </p> </div> <a name='function.easter-date.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The easter date as a unix timestamp. </p> </div> <a name='function.easter-date.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>Since 4.3.0</td> <td align='left'> The <i><tt class='parameter'>year</tt></i> parameter is optional and defaults to the current year according to the local time if omitted. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.easter-date.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>easter_date()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>date</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'M-d-Y'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>easter_date</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1999</span><span style='color: #007700'>));&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Apr-04-1999<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>date</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'M-d-Y'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>easter_date</span><span style='color: #007700'>(</span><span style='color: #0000BB'>2000</span><span style='color: #007700'>));&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Apr-23-2000<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>date</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'M-d-Y'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>easter_date</span><span style='color: #007700'>(</span><span style='color: #0000BB'>2001</span><span style='color: #007700'>));&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Apr-15-2001<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.easter-date.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'> <a href='http://www.php.net/manual/en/function.easter-days.php' class='function' rel='rdfs-seeAlso'>easter_days()</a> - Get number of days after March 21 on which Easter falls for a given year for calculating Easter before 1970 or after 2037 </li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="dngettext" value="<div id='function.dngettext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.dngettext.php'>dngettext</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>dngettext</span> &amp;mdash; <span class='dc-title'>Plural version of dgettext</span></p> </div> <a name='function.dngettext.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>dngettext</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$domain</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$msgid1</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$msgid2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$n</tt></span> )</div> <p class='para rdfs-comment'> The <b>dngettext()</b> function allows you to override the current <i><tt class='parameter'>domain</tt></i> for a single plural message lookup. </p> </div> <a name='function.dngettext.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>domain</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The domain </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msgid1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msgid2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>n</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.dngettext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> on success. </p> </div> <a name='function.dngettext.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ngettext.php' class='function' rel='rdfs-seeAlso'>ngettext()</a> - Plural version of gettext</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="dgettext" value="<div id='function.dgettext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.dgettext.php'>dgettext</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>dgettext</span> &amp;mdash; <span class='dc-title'>Override the current domain</span></p> </div> <a name='function.dgettext.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>dgettext</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$domain</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$message</tt></span> )</div> <p class='para rdfs-comment'> The <b>dgettext()</b> function allows you to override the current <i><tt class='parameter'>domain</tt></i> for a single message lookup. </p> </div> <a name='function.dgettext.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>domain</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The domain </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>message</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message </p> </dd> </dl> <p> </p> </div> <a name='function.dgettext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> on success. </p> </div> <a name='function.dgettext.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.gettext.php' class='function' rel='rdfs-seeAlso'>gettext()</a> - Lookup a message in the current domain</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="dcngettext" value="<div id='function.dcngettext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.dcngettext.php'>dcngettext</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>dcngettext</span> &amp;mdash; <span class='dc-title'>Plural version of dcgettext</span></p> </div> <a name='function.dcngettext.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>dcngettext</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$domain</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$msgid1</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$msgid2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$n</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$category</tt></span> )</div> <p class='para rdfs-comment'> This function allows you to override the current domain for a single plural message lookup. </p> </div> <a name='function.dcngettext.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>domain</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The domain </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msgid1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>msgid2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>n</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>category</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.dcngettext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> on success. </p> </div> <a name='function.dcngettext.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ngettext.php' class='function' rel='rdfs-seeAlso'>ngettext()</a> - Plural version of gettext</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="dcgettext" value="<div id='function.dcgettext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.dcgettext.php'>dcgettext</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>dcgettext</span> &amp;mdash; <span class='dc-title'>Overrides the domain for a single lookup</span></p> </div> <a name='function.dcgettext.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>dcgettext</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$domain</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$message</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$category</tt></span> )</div> <p class='para rdfs-comment'> This function allows you to override the current domain for a single message lookup. </p> </div> <a name='function.dcgettext.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>domain</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The domain </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>message</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The message </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>category</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The category </p> </dd> </dl> <p> </p> </div> <a name='function.dcgettext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> on success. </p> </div> <a name='function.dcgettext.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.gettext.php' class='function' rel='rdfs-seeAlso'>gettext()</a> - Lookup a message in the current domain</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="cal_to_jd" value="<div id='function.cal-to-jd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.cal-to-jd.php'>cal_to_jd</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>cal_to_jd</span> &amp;mdash; <span class='dc-title'>Converts from a supported calendar to Julian Day Count</span></p> </div> <a name='function.cal-to-jd.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>cal_to_jd</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$calendar</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$month</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$day</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$year</tt></span> )</div> <p class='para rdfs-comment'> <b>cal_to_jd()</b> calculates the Julian day count for a date in the specified <i><tt class='parameter'>calendar</tt></i> . Supported <i><tt class='parameter'>calendar</tt></i> s are <b><tt class='constant'>CAL_GREGORIAN</tt></b>, <b><tt class='constant'>CAL_JULIAN</tt></b>, <b><tt class='constant'>CAL_JEWISH</tt></b> and <b><tt class='constant'>CAL_FRENCH</tt></b>. </p> </div> <a name='function.cal-to-jd.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>calendar</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Calendar to convert from, one of <b><tt class='constant'>CAL_GREGORIAN</tt></b>, <b><tt class='constant'>CAL_JULIAN</tt></b>, <b><tt class='constant'>CAL_JEWISH</tt></b> or <b><tt class='constant'>CAL_FRENCH</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>month</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The month as a number, the valid range depends on the <i><tt class='parameter'>calendar</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>day</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The day as a number, the valid range depends on the <i><tt class='parameter'>calendar</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>year</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The year as a number, the valid range depends on the <i><tt class='parameter'>calendar</tt></i> </p> </dd> </dl> <p> </p> </div> <a name='function.cal-to-jd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A Julian Day number. </p> </div> <a name='function.cal-to-jd.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.cal-from-jd.php' class='function' rel='rdfs-seeAlso'>cal_from_jd()</a> - Converts from Julian Day Count to a supported calendar</li> <li class='member'><a href='http://www.php.net/manual/en/function.frenchtojd.php' class='function' rel='rdfs-seeAlso'>frenchtojd()</a> - Converts a date from the French Republican Calendar to a Julian Day Count</li> <li class='member'><a href='http://www.php.net/manual/en/function.gregoriantojd.php' class='function' rel='rdfs-seeAlso'>gregoriantojd()</a> - Converts a Gregorian date to Julian Day Count</li> <li class='member'><a href='http://www.php.net/manual/en/function.jewishtojd.php' class='function' rel='rdfs-seeAlso'>jewishtojd()</a> - Converts a date in the Jewish Calendar to Julian Day Count</li> <li class='member'><a href='http://www.php.net/manual/en/function.juliantojd.php' class='function' rel='rdfs-seeAlso'>juliantojd()</a> - Converts a Julian Calendar date to Julian Day Count</li> <li class='member'><a href='http://www.php.net/manual/en/function.unixtojd.php' class='function' rel='rdfs-seeAlso'>unixtojd()</a> - Convert Unix timestamp to Julian Day</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="cal_info" value="<div id='function.cal-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.cal-info.php'>cal_info</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>cal_info</span> &amp;mdash; <span class='dc-title'>Returns information about a particular calendar</span></p> </div> <a name='function.cal-info.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>cal_info</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$calendar</tt><span class='initializer'> = -1</span></span> ] )</div> <p class='para rdfs-comment'> <b>cal_info()</b> returns information on the specified <i><tt class='parameter'>calendar</tt></i> . </p> <p class='para'> Calendar information is returned as an array containing the elements <i>calname</i>, <i>calsymbol</i>, <i>month</i>, <i>abbrevmonth</i> and <i>maxdaysinmonth</i>. The names of the different calendars which can be used as <i><tt class='parameter'>calendar</tt></i> are as follows: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> 0 or <b><tt class='constant'>CAL_GREGORIAN</tt></b> - Gregorian Calendar </span> </li> <li class='listitem'> <span class='simpara'> 1 or <b><tt class='constant'>CAL_JULIAN</tt></b> - Julian Calendar </span> </li> <li class='listitem'> <span class='simpara'> 2 or <b><tt class='constant'>CAL_JEWISH</tt></b> - Jewish Calendar </span> </li> <li class='listitem'> <span class='simpara'> 3 or <b><tt class='constant'>CAL_FRENCH</tt></b> - French Revolutionary Calendar </span> </li> </ul><p> </p> <p class='para'> If no <i><tt class='parameter'>calendar</tt></i> is specified information on all supported calendars is returned as an array. </p> </div> <a name='function.cal-info.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>calendar</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Calendar to return information for. If no calendar is specified information about all calendars is returned. </p> </dd> </dl> <p> </p> </div> <a name='function.cal-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> </p> </div> <a name='function.cal-info.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>Since 5.0</td> <td align='left'> The <i><tt class='parameter'>calendar</tt></i> parameter becomes optional and defaults to &amp;quot;all calendars&amp;quot; if omitted. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.cal-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>cal_info()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$info&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>cal_info</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Array ( [months] =&amp;gt; Array ( [1] =&amp;gt; January [2] =&amp;gt; February [3] =&amp;gt; March [4] =&amp;gt; April [5] =&amp;gt; May [6] =&amp;gt; June [7] =&amp;gt; July [8] =&amp;gt; August [9] =&amp;gt; September [10] =&amp;gt; October [11] =&amp;gt; November [12] =&amp;gt; December ) [abbrevmonths] =&amp;gt; Array ( [1] =&amp;gt; Jan [2] =&amp;gt; Feb [3] =&amp;gt; Mar [4] =&amp;gt; Apr [5] =&amp;gt; May [6] =&amp;gt; Jun [7] =&amp;gt; Jul [8] =&amp;gt; Aug [9] =&amp;gt; Sep [10] =&amp;gt; Oct [11] =&amp;gt; Nov [12] =&amp;gt; Dec ) [maxdaysinmonth] =&amp;gt; 31 [calname] =&amp;gt; Gregorian [calsymbol] =&amp;gt; CAL_GREGORIAN ) </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="cal_from_jd" value="<div id='function.cal-from-jd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.cal-from-jd.php'>cal_from_jd</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>cal_from_jd</span> &amp;mdash; <span class='dc-title'>Converts from Julian Day Count to a supported calendar</span></p> </div> <a name='function.cal-from-jd.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>cal_from_jd</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$jd</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$calendar</tt></span> )</div> <p class='para rdfs-comment'> <b>cal_from_jd()</b> converts the Julian day given in <i><tt class='parameter'>jd</tt></i> into a date of the specified <i><tt class='parameter'>calendar</tt></i> . Supported <i><tt class='parameter'>calendar</tt></i> values are <b><tt class='constant'>CAL_GREGORIAN</tt></b>, <b><tt class='constant'>CAL_JULIAN</tt></b>, <b><tt class='constant'>CAL_JEWISH</tt></b> and <b><tt class='constant'>CAL_FRENCH</tt></b>. </p> </div> <a name='function.cal-from-jd.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>jd</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Julian day as integer </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>calendar</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Calendar to convert to </p> </dd> </dl> <p> </p> </div> <a name='function.cal-from-jd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array containing calendar information like month, day, year, day of week, abbreviated and full names of weekday and month and the date in string form &amp;quot;month/day/year&amp;quot;. </p> </div> <a name='function.cal-from-jd.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>cal_from_jd()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$today&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>unixtojd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>mktime</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>8</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>16</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2003</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>cal_from_jd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$today</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>CAL_GREGORIAN</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Array ( [date] =&amp;gt; 8/16/2003 [month] =&amp;gt; 8 [day] =&amp;gt; 16 [year] =&amp;gt; 2003 [dow] =&amp;gt; 6 [abbrevdayname] =&amp;gt; Sat [dayname] =&amp;gt; Saturday [abbrevmonth] =&amp;gt; Aug [monthname] =&amp;gt; August ) </pre></div> </div> </div><p> </p> </div> <a name='function.cal-from-jd.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.cal-to-jd.php' class='function' rel='rdfs-seeAlso'>cal_to_jd()</a> - Converts from a supported calendar to Julian Day Count</li> <li class='member'><a href='http://www.php.net/manual/en/function.jdtofrench.php' class='function' rel='rdfs-seeAlso'>jdtofrench()</a> - Converts a Julian Day Count to the French Republican Calendar</li> <li class='member'><a href='http://www.php.net/manual/en/function.jdtogregorian.php' class='function' rel='rdfs-seeAlso'>jdtogregorian()</a> - Converts Julian Day Count to Gregorian date</li> <li class='member'><a href='http://www.php.net/manual/en/function.jdtojewish.php' class='function' rel='rdfs-seeAlso'>jdtojewish()</a> - Converts a Julian day count to a Jewish calendar date</li> <li class='member'><a href='http://www.php.net/manual/en/function.jdtojulian.php' class='function' rel='rdfs-seeAlso'>jdtojulian()</a> - Converts a Julian Day Count to a Julian Calendar Date</li> <li class='member'><a href='http://www.php.net/manual/en/function.jdtounix.php' class='function' rel='rdfs-seeAlso'>jdtounix()</a> - Convert Julian Day to Unix timestamp</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="cal_days_in_month" value="<div id='function.cal-days-in-month' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.cal-days-in-month.php'>cal_days_in_month</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>cal_days_in_month</span> &amp;mdash; <span class='dc-title'>Return the number of days in a month for a given year and calendar</span></p> </div> <a name='function.cal-days-in-month.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>cal_days_in_month</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$calendar</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$month</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$year</tt></span> )</div> <p class='para rdfs-comment'> This function will return the number of days in the <i><tt class='parameter'>month</tt></i> of <i><tt class='parameter'>year</tt></i> for the specified <i><tt class='parameter'>calendar</tt></i> . </p> </div> <a name='function.cal-days-in-month.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>calendar</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Calendar to use for calculation </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>month</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Month in the selected calendar </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>year</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Year in the selected calendar </p> </dd> </dl> <p> </p> </div> <a name='function.cal-days-in-month.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The length in days of the selected month in the given calendar </p> </div> <a name='function.cal-days-in-month.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>cal_days_in_month()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>cal_days_in_month</span><span style='color: #007700'>(</span><span style='color: #0000BB'>CAL_GREGORIAN</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>8</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2003</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;31<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;was&amp;nbsp;</span><span style='color: #0000BB'>$num</span><span style='color: #DD0000'>&amp;nbsp;days&amp;nbsp;in&amp;nbsp;August&amp;nbsp;2003'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bindtextdomain" value="<div id='function.bindtextdomain' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bindtextdomain.php'>bindtextdomain</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>bindtextdomain</span> &amp;mdash; <span class='dc-title'>Sets the path for a domain</span></p> </div> <a name='function.bindtextdomain.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>bindtextdomain</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$domain</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$directory</tt></span> )</div> <p class='para rdfs-comment'> The <b>bindtextdomain()</b> function sets the path for a domain. </p> </div> <a name='function.bindtextdomain.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>domain</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The domain </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>directory</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The directory path </p> </dd> </dl> <p> </p> </div> <a name='function.bindtextdomain.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The full pathname for the <i><tt class='parameter'>domain</tt></i> currently being set. </p> </div> <a name='function.bindtextdomain.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>bindtextdomain()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$domain&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'myapp'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>bindtextdomain</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$domain</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'/usr/share/myapp/locale'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> /usr/share/myapp/locale </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bind_textdomain_codeset" value="<div id='function.bind-textdomain-codeset' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bind-textdomain-codeset.php'>bind_textdomain_codeset</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>bind_textdomain_codeset</span> &amp;mdash; <span class='dc-title'>Specify the character encoding in which the messages from the DOMAIN message catalog will be returned</span></p> </div> <a name='function.bind-textdomain-codeset.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>bind_textdomain_codeset</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$domain</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$codeset</tt></span> )</div> <p class='para rdfs-comment'> With <b>bind_textdomain_codeset()</b>, you can set in which encoding will be messages from <i><tt class='parameter'>domain</tt></i> returned by <a href='http://www.php.net/manual/en/function.gettext.php' class='function'>gettext()</a> and similar functions. </p> </div> <a name='function.bind-textdomain-codeset.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>domain</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The domain </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>codeset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The code set </p> </dd> </dl> <p> </p> </div> <a name='function.bind-textdomain-codeset.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> on success. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bcsub" value="<div id='function.bcsub' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bcsub.php'>bcsub</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>bcsub</span> &amp;mdash; <span class='dc-title'>Subtract one arbitrary precision number from another</span></p> </div> <a name='function.bcsub.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>bcsub</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$left_operand</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$right_operand</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scale</tt></span> ] )</div> <p class='para rdfs-comment'> Subtracts the <i><tt class='parameter'>right_operand</tt></i> from the <i><tt class='parameter'>left_operand</tt></i> . </p> </div> <a name='function.bcsub.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>left_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The left operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>right_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The right operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> scale</tt></i> </span> </dt><dd class='listitem'> <p class='para'>This optional parameter is used to set the number of digits after the decimal place in the result. You can also set the global default scale for all functions by using <a href='http://www.php.net/manual/en/function.bcscale.php' class='function'>bcscale()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.bcsub.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The result of the subtraction, as a string. </p> </div> <a name='function.bcsub.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>bcsub()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'1.234'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$b&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'5'</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>bcsub</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;-3<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bcsub</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;-3.7660<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.bcsub.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.bcadd.php' class='function' rel='rdfs-seeAlso'>bcadd()</a> - Add two arbitrary precision numbers</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bcsqrt" value="<div id='function.bcsqrt' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bcsqrt.php'>bcsqrt</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>bcsqrt</span> &amp;mdash; <span class='dc-title'>Get the square root of an arbitrary precision number</span></p> </div> <a name='function.bcsqrt.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>bcsqrt</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$operand</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scale</tt></span> ] )</div> <p class='para rdfs-comment'> Return the square root of the <i><tt class='parameter'>operand</tt></i> . </p> </div> <a name='function.bcsqrt.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> scale</tt></i> </span> </dt><dd class='listitem'> <p class='para'>This optional parameter is used to set the number of digits after the decimal place in the result. You can also set the global default scale for all functions by using <a href='http://www.php.net/manual/en/function.bcscale.php' class='function'>bcscale()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.bcsqrt.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the square root as a string, or <b><tt class='constant'>NULL</tt></b> if <i><tt class='parameter'>operand</tt></i> is negative. </p> </div> <a name='function.bcsqrt.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>bcsqrt()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bcsqrt</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;1.414<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.bcsqrt.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.bcpow.php' class='function' rel='rdfs-seeAlso'>bcpow()</a> - Raise an arbitrary precision number to another</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bcscale" value="<div id='function.bcscale' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bcscale.php'>bcscale</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>bcscale</span> &amp;mdash; <span class='dc-title'>Set default scale parameter for all bc math functions</span></p> </div> <a name='function.bcscale.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>bcscale</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scale</tt></span> )</div> <p class='para rdfs-comment'> Sets the default scale parameter for all subsequent bc math functions that do not explicitly specify a scale parameter. </p> </div> <a name='function.bcscale.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>scale</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The scale factor. </p> </dd> </dl> <p> </p> </div> <a name='function.bcscale.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.bcscale.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>bcscale()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;default&amp;nbsp;scale&amp;nbsp;:&amp;nbsp;3<br /></span><span style='color: #0000BB'>bcscale</span><span style='color: #007700'>(</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>bcdiv</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'105'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'6.55957'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;16.007<br /><br />//&amp;nbsp;this&amp;nbsp;is&amp;nbsp;the&amp;nbsp;same&amp;nbsp;without&amp;nbsp;bcscale()<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bcdiv</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'105'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'6.55957'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;16.007<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bcpowmod" value="<div id='function.bcpowmod' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bcpowmod.php'>bcpowmod</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>bcpowmod</span> &amp;mdash; <span class='dc-title'>Raise an arbitrary precision number to another, reduced by a specified modulus</span></p> </div> <a name='function.bcpowmod.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>bcpowmod</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$left_operand</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$right_operand</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$modulus</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scale</tt></span> ] )</div> <p class='para rdfs-comment'> Use the fast-exponentiation method to raise <i><tt class='parameter'>left_operand</tt></i> to the power <i><tt class='parameter'>right_operand</tt></i> with respect to the modulus <i><tt class='parameter'>modulus</tt></i> . </p> </div> <a name='function.bcpowmod.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>left_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The left operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>right_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The right operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>modulus</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The modulus, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> scale</tt></i> </span> </dt><dd class='listitem'> <p class='para'>This optional parameter is used to set the number of digits after the decimal place in the result. You can also set the global default scale for all functions by using <a href='http://www.php.net/manual/en/function.bcscale.php' class='function'>bcscale()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.bcpowmod.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the result as a string, or <b><tt class='constant'>NULL</tt></b> if <i><tt class='parameter'>modulus</tt></i> is 0. </p> </div> <a name='function.bcpowmod.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Because this method uses the modulus operation, non-natural numbers may give unexpected results. A natural number is any positive non-zero integer. <br /> </p></blockquote> </div> <a name='function.bcpowmod.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> The following two statements are functionally identical. The <b>bcpowmod()</b> version however, executes in less time and can accept larger parameters. </p><div class='informalexample'> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>bcpowmod</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$x</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$y</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mod</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$b&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>bcmod</span><span style='color: #007700'>(</span><span style='color: #0000BB'>bcpow</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$x</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$y</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>$mod</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;$a&amp;nbsp;and&amp;nbsp;$b&amp;nbsp;are&amp;nbsp;equal&amp;nbsp;to&amp;nbsp;each&amp;nbsp;other.<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.bcpowmod.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.bcpow.php' class='function' rel='rdfs-seeAlso'>bcpow()</a> - Raise an arbitrary precision number to another</li> <li class='member'><a href='http://www.php.net/manual/en/function.bcmod.php' class='function' rel='rdfs-seeAlso'>bcmod()</a> - Get modulus of an arbitrary precision number</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bcpow" value="<div id='function.bcpow' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bcpow.php'>bcpow</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>bcpow</span> &amp;mdash; <span class='dc-title'>Raise an arbitrary precision number to another</span></p> </div> <a name='function.bcpow.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>bcpow</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$left_operand</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$right_operand</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scale</tt></span> ] )</div> <p class='para rdfs-comment'> Raise <i><tt class='parameter'>left_operand</tt></i> to the power <i><tt class='parameter'>right_operand</tt></i> . </p> </div> <a name='function.bcpow.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>left_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The left operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>right_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The right operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> scale</tt></i> </span> </dt><dd class='listitem'> <p class='para'>This optional parameter is used to set the number of digits after the decimal place in the result. You can also set the global default scale for all functions by using <a href='http://www.php.net/manual/en/function.bcscale.php' class='function'>bcscale()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.bcpow.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the result as a string. </p> </div> <a name='function.bcpow.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>bcpow()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bcpow</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'4.2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;74.08<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.bcpow.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.bcpowmod.php' class='function' rel='rdfs-seeAlso'>bcpowmod()</a> - Raise an arbitrary precision number to another, reduced by a specified modulus</li> <li class='member'><a href='http://www.php.net/manual/en/function.bcsqrt.php' class='function' rel='rdfs-seeAlso'>bcsqrt()</a> - Get the square root of an arbitrary precision number</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bcmul" value="<div id='function.bcmul' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bcmul.php'>bcmul</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>bcmul</span> &amp;mdash; <span class='dc-title'>Multiply two arbitrary precision number</span></p> </div> <a name='function.bcmul.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>bcmul</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$left_operand</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$right_operand</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scale</tt></span> ] )</div> <p class='para rdfs-comment'> Multiply the <i><tt class='parameter'>left_operand</tt></i> by the <i><tt class='parameter'>right_operand</tt></i> . </p> </div> <a name='function.bcmul.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>left_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The left operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>right_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The right operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> scale</tt></i> </span> </dt><dd class='listitem'> <p class='para'>This optional parameter is used to set the number of digits after the decimal place in the result. You can also set the global default scale for all functions by using <a href='http://www.php.net/manual/en/function.bcscale.php' class='function'>bcscale()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.bcmul.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the result as a string. </p> </div> <a name='function.bcmul.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>bcmul()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bcmul</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1.34747474747'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'35'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;47.161<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bcmul</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'4'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;8<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.bcmul.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.bcdiv.php' class='function' rel='rdfs-seeAlso'>bcdiv()</a> - Divide two arbitrary precision numbers</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bcmod" value="<div id='function.bcmod' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bcmod.php'>bcmod</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>bcmod</span> &amp;mdash; <span class='dc-title'>Get modulus of an arbitrary precision number</span></p> </div> <a name='function.bcmod.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>bcmod</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$left_operand</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$modulus</tt></span> )</div> <p class='para rdfs-comment'> Get the modulus of the <i><tt class='parameter'>left_operand</tt></i> using <i><tt class='parameter'>modulus</tt></i> . </p> </div> <a name='function.bcmod.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>left_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The left operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>modulus</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The modulus, as a string. </p> </dd> </dl> <p> </p> </div> <a name='function.bcmod.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the modulus as a string, or <b><tt class='constant'>NULL</tt></b> if <i><tt class='parameter'>modulus</tt></i> is 0. </p> </div> <a name='function.bcmod.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>bcmod()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bcmod</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'4'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;0<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bcmod</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'4'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;2<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.bcmod.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.bcdiv.php' class='function' rel='rdfs-seeAlso'>bcdiv()</a> - Divide two arbitrary precision numbers</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bcdiv" value="<div id='function.bcdiv' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bcdiv.php'>bcdiv</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>bcdiv</span> &amp;mdash; <span class='dc-title'>Divide two arbitrary precision numbers</span></p> </div> <a name='function.bcdiv.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>bcdiv</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$left_operand</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$right_operand</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scale</tt></span> ] )</div> <p class='para rdfs-comment'> Divides the <i><tt class='parameter'>left_operand</tt></i> by the <i><tt class='parameter'>right_operand</tt></i> . </p> </div> <a name='function.bcdiv.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>left_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The left operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>right_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The right operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> scale</tt></i> </span> </dt><dd class='listitem'> <p class='para'>This optional parameter is used to set the number of digits after the decimal place in the result. You can also set the global default scale for all functions by using <a href='http://www.php.net/manual/en/function.bcscale.php' class='function'>bcscale()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.bcdiv.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the result of the division as a string, or <b><tt class='constant'>NULL</tt></b> if <i><tt class='parameter'>right_operand</tt></i> is 0. </p> </div> <a name='function.bcdiv.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>bcdiv()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bcdiv</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'105'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'6.55957'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;16.007<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.bcdiv.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.bcmul.php' class='function' rel='rdfs-seeAlso'>bcmul()</a> - Multiply two arbitrary precision number</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bccomp" value="<div id='function.bccomp' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bccomp.php'>bccomp</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>bccomp</span> &amp;mdash; <span class='dc-title'>Compare two arbitrary precision numbers</span></p> </div> <a name='function.bccomp.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>bccomp</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$left_operand</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$right_operand</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scale</tt></span> ] )</div> <p class='para rdfs-comment'> Compares the <i><tt class='parameter'>left_operand</tt></i> to the <i><tt class='parameter'>right_operand</tt></i> and returns the result as an integer. </p> </div> <a name='function.bccomp.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>left_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The left operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>right_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The right operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>scale</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional <i><tt class='parameter'>scale</tt></i> parameter is used to set the number of digits after the decimal place which will be used in the comparison. </p> </dd> </dl> <p> </p> </div> <a name='function.bccomp.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns 0 if the two operands are equal, 1 if the <i><tt class='parameter'>left_operand</tt></i> is larger than the <i><tt class='parameter'>right_operand</tt></i> , -1 otherwise. </p> </div> <a name='function.bccomp.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>bccomp()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bccomp</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'2'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;-1<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bccomp</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1.00001'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;0<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bccomp</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1.00001'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;1<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="bcadd" value="<div id='function.bcadd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.bcadd.php'>bcadd</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>bcadd</span> &amp;mdash; <span class='dc-title'>Add two arbitrary precision numbers</span></p> </div> <a name='function.bcadd.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>bcadd</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$left_operand</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$right_operand</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scale</tt></span> ] )</div> <p class='para rdfs-comment'> Sums <i><tt class='parameter'>left_operand</tt></i> and <i><tt class='parameter'>right_operand</tt></i> . </p> </div> <a name='function.bcadd.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>left_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The left operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>right_operand</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The right operand, as a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> scale</tt></i> </span> </dt><dd class='listitem'> <p class='para'>This optional parameter is used to set the number of digits after the decimal place in the result. You can also set the global default scale for all functions by using <a href='http://www.php.net/manual/en/function.bcscale.php' class='function'>bcscale()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.bcadd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The sum of the two operands, as a string. </p> </div> <a name='function.bcadd.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>bcadd()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'1.234'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$b&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'5'</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>bcadd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;6<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>bcadd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;6.2340<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.bcadd.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.bcsub.php' class='function' rel='rdfs-seeAlso'>bcsub()</a> - Subtract one arbitrary precision number from another</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="TidyNode" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.tidynode.php'>The <a href='http://www.php.net/manual/en/class.tidynode.php' class='classname'>TidyNode</a> class</a></h1> <div class='partintro'> <div id='tidynode.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> An HTML node in an HTML file, as detected by tidy. </p> </div> <div id='tidynode.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>TidyNode</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>TidyNode</b> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Properties */</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='type'>tidyNode</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidynode.getparent.php' class='function'>tidyNode::getParent</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidynode.haschildren.php' class='function'>tidyNode::hasChildren</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidynode.hassiblings.php' class='function'>tidyNode::hasSiblings</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidynode.isasp.php' class='function'>tidyNode::isAsp</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidynode.iscomment.php' class='function'>tidyNode::isComment</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidynode.ishtml.php' class='function'>tidyNode::isHtml</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidynode.isjste.php' class='function'>tidyNode::isJste</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidynode.isphp.php' class='function'>tidyNode::isPhp</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidynode.istext.php' class='function'>tidyNode::isText</a></span> ( <span class='methodparam'>void</span> )</div> }</div> </div> <div id='tidynode.props' class='section'> <h2 class='title'>Properties</h2> <dl> <dt id='tidynode.props.value' class='varlistentry'> <span class='term'><var class='varname'>value</var></span> </dt><dd class='listitem'> <p class='para'>The HTML representation of the node, including the surrounding tags.</p> </dd> <dt id='tidynode.props.name' class='varlistentry'> <span class='term'><var class='varname'>name</var></span> </dt><dd class='listitem'> <p class='para'>The name of the HTML node</p> </dd> <dt id='tidynode.props.type' class='varlistentry'> <span class='term'><var class='varname'>type</var></span> </dt><dd class='listitem'> <p class='para'>The type of the tag (one of the constants above, e.g. <b><tt class='constant'>TIDY_NODETYPE_PHP</tt></b>)</p> </dd> <dt id='tidynode.props.line' class='varlistentry'> <span class='term'><var class='varname'>line</var></span> </dt><dd class='listitem'> <p class='para'>The line number at which the tags is located in the file</p> </dd> <dt id='tidynode.props.column' class='varlistentry'> <span class='term'><var class='varname'>column</var></span> </dt><dd class='listitem'> <p class='para'>The column number at which the tags is located in the file</p> </dd> <dt id='tidynode.props.proprietary' class='varlistentry'> <span class='term'><var class='varname'>proprietary</var></span> </dt><dd class='listitem'> <p class='para'>Indicates if the node is a proprietary tag</p> </dd> <dt id='tidynode.props.id' class='varlistentry'> <span class='term'><var class='varname'>id</var></span> </dt><dd class='listitem'> <p class='para'>The ID of the tag (one of the constants above, e.g. <b><tt class='constant'>TIDY_TAG_FRAME</tt></b>)</p> </dd> <dt id='tidynode.props.attribute' class='varlistentry'> <span class='term'><var class='varname'>attribute</var></span> </dt><dd class='listitem'> <p class='para'> An array of string, representing the attributes names (as keys) of the current node. </p> </dd> <dt id='tidynode.props.child' class='varlistentry'> <span class='term'><var class='varname'>child</var></span> </dt><dd class='listitem'> <p class='para'> An array of <b class='classname'>TidyNode</b>, representing the children of the current node. </p> </dd> </dl> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.1.0</td> <td align='left'><var class='varname'>line</var>, <var class='varname'>column</var> and <var class='varname'>proprietary</var> were added</td> </tr> </tbody> </table> <p> </p> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/tidynode.getparent.php'>tidyNode::getParent</a> &amp;acirc;&amp;#128;&amp;#148; Returns the parent node of the current node</li><li><a href='http://www.php.net/manual/en/tidynode.haschildren.php'>tidyNode::hasChildren</a> &amp;acirc;&amp;#128;&amp;#148; Checks if a node has children</li><li><a href='http://www.php.net/manual/en/tidynode.hassiblings.php'>tidyNode::hasSiblings</a> &amp;acirc;&amp;#128;&amp;#148; Checks if a node has siblings</li><li><a href='http://www.php.net/manual/en/tidynode.isasp.php'>tidyNode::isAsp</a> &amp;acirc;&amp;#128;&amp;#148; Checks if this node is ASP</li><li><a href='http://www.php.net/manual/en/tidynode.iscomment.php'>tidyNode::isComment</a> &amp;acirc;&amp;#128;&amp;#148; Checks if a node represents a comment</li><li><a href='http://www.php.net/manual/en/tidynode.ishtml.php'>tidyNode::isHtml</a> &amp;acirc;&amp;#128;&amp;#148; Checks if a node is part of a HTML document</li><li><a href='http://www.php.net/manual/en/tidynode.isjste.php'>tidyNode::isJste</a> &amp;acirc;&amp;#128;&amp;#148; Checks if this node is JSTE</li><li><a href='http://www.php.net/manual/en/tidynode.isphp.php'>tidyNode::isPhp</a> &amp;acirc;&amp;#128;&amp;#148; Checks if a node is PHP</li><li><a href='http://www.php.net/manual/en/tidynode.istext.php'>tidyNode::isText</a> &amp;acirc;&amp;#128;&amp;#148; Checks if a node represents text (no markup)</li></ul> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="Tidy" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.tidy.php'>The <a href='http://www.php.net/manual/en/class.tidy.php' class='classname'>Tidy</a> class</a></h1> <div class='partintro'> <div id='tidy.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> An HTML node in an HTML file, as detected by tidy. </p> </div> <div id='tidy.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>Tidy</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>Tidy</b> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Properties */</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='type'>tidyNode</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.body.php' class='function'>tidy_get_body</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.cleanrepair.php' class='function'>tidy_clean_repair</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>tidy</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.construct.php' class='function'>tidy::__construct</a></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$use_include_path</tt></span> ]]]] )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/function.tidy-diagnose.php' class='function'>tidy_diagnose</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.getconfig.php' class='function'>tidy_get_config</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.gethtmlver.php' class='function'>tidy_get_html_ver</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mixed</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.getopt.php' class='function'>tidy_getopt</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.getoptdoc.php' class='function'>tidy_get_opt_doc</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$optname</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.getrelease.php' class='function'>tidy_get_release</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.getstatus.php' class='function'>tidy_get_status</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>tidyNode</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.head.php' class='function'>tidy_get_head</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>tidyNode</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.html.php' class='function'>tidy_get_html</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.isxhtml.php' class='function'>tidy_is_xhtml</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.isxml.php' class='function'>tidy_is_xml</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>tidy</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.parsefile.php' class='function'>tidy_parse_file</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$use_include_path</tt><span class='initializer'> = false</span></span> ]]] )</div> <div class='methodsynopsis dc-description'> <span class='type'>tidy</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.parsestring.php' class='function'>tidy_parse_string</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$input</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.repairfile.php' class='function'>tidy_repair_file</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$use_include_path</tt><span class='initializer'> = false</span></span> ]]] )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.repairstring.php' class='function'>tidy_repair_string</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$config</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <div class='methodsynopsis dc-description'> <span class='type'>tidyNode</span> <span class='methodname'><a href='http://www.php.net/manual/en/tidy.root.php' class='function'>tidy_get_root</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.tidy.php' class='type tidy'>tidy</a></span> <tt class='parameter'>$object</tt></span> )</div> }</div> </div> <div id='tidy.props' class='section'> <h2 class='title'>Properties</h2> <dl> <dt id='tidy.props.body' class='varlistentry'> <span class='term'><var class='varname'>errorBuffer</var></span> </dt><dd class='listitem'> <p class='para'> The last warnings and errors from TidyLib </p> </dd> </dl> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/tidy.body.php'>tidy::body</a> &amp;acirc;&amp;#128;&amp;#148; Returns a tidyNode object starting from the <body> tag of the tidy parse tree</li><li><a href='http://www.php.net/manual/en/tidy.cleanrepair.php'>tidy::CleanRepair</a> &amp;acirc;&amp;#128;&amp;#148; Execute configured cleanup and repair operations on parsed markup</li><li><a href='http://www.php.net/manual/en/tidy.construct.php'>tidy::__construct</a> &amp;acirc;&amp;#128;&amp;#148; Constructs a new tidy object</li><li><a href='http://www.php.net/manual/en/function.tidy-diagnose.php'>tidy::diagnose</a> &amp;acirc;&amp;#128;&amp;#148; Run configured diagnostics on parsed and repaired markup</li><li><a href='http://www.php.net/manual/en/tidy.getconfig.php'>tidy::getConfig</a> &amp;acirc;&amp;#128;&amp;#148; Get current Tidy configuration</li><li><a href='http://www.php.net/manual/en/tidy.gethtmlver.php'>tidy::htmlver</a> &amp;acirc;&amp;#128;&amp;#148; Get the Detected HTML version for the specified document</li><li><a href='http://www.php.net/manual/en/tidy.getopt.php'>tidy::getOpt</a> &amp;acirc;&amp;#128;&amp;#148; Returns the value of the specified configuration option for the tidy document</li><li><a href='http://www.php.net/manual/en/tidy.getoptdoc.php'>tidy::getoptdoc</a> &amp;acirc;&amp;#128;&amp;#148; Returns the documentation for the given option name</li><li><a href='http://www.php.net/manual/en/tidy.getrelease.php'>tidy::getRelease</a> &amp;acirc;&amp;#128;&amp;#148; Get release date (version) for Tidy library</li><li><a href='http://www.php.net/manual/en/tidy.getstatus.php'>tidy::getStatus</a> &amp;acirc;&amp;#128;&amp;#148; Get status of specified document</li><li><a href='http://www.php.net/manual/en/tidy.head.php'>tidy::head</a> &amp;acirc;&amp;#128;&amp;#148; Returns a tidyNode object starting from the <head> tag of the tidy parse tree</li><li><a href='http://www.php.net/manual/en/tidy.html.php'>tidy::html</a> &amp;acirc;&amp;#128;&amp;#148; Returns a tidyNode object starting from the <html> tag of the tidy parse tree</li><li><a href='http://www.php.net/manual/en/tidy.isxhtml.php'>tidy::isXhtml</a> &amp;acirc;&amp;#128;&amp;#148; Indicates if the document is a XHTML document</li><li><a href='http://www.php.net/manual/en/tidy.isxml.php'>tidy::isXml</a> &amp;acirc;&amp;#128;&amp;#148; Indicates if the document is a generic (non HTML/XHTML) XML document</li><li><a href='http://www.php.net/manual/en/tidy.parsefile.php'>tidy::parseFile</a> &amp;acirc;&amp;#128;&amp;#148; Parse markup in file or URI</li><li><a href='http://www.php.net/manual/en/tidy.parsestring.php'>tidy::parseString</a> &amp;acirc;&amp;#128;&amp;#148; Parse a document stored in a string</li><li><a href='http://www.php.net/manual/en/tidy.repairfile.php'>tidy::repairFile</a> &amp;acirc;&amp;#128;&amp;#148; Repair a file and return it as a string</li><li><a href='http://www.php.net/manual/en/tidy.repairstring.php'>tidy::repairString</a> &amp;acirc;&amp;#128;&amp;#148; Repair a string using an optionally provided configuration file</li><li><a href='http://www.php.net/manual/en/tidy.root.php'>tidy::root</a> &amp;acirc;&amp;#128;&amp;#148; Returns a tidyNode object representing the root of the tidy parse tree</li></ul> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
</strings>

