<strings>
<string id="mysql_unbuffered_query" value="<div id='function.mysql-unbuffered-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-unbuffered-query.php'>mysql_unbuffered_query</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_unbuffered_query</span> &amp;mdash; <span class='dc-title'>Send an SQL query to MySQL, without fetching and buffering the result rows</span></p> </div> <a name='function.mysql-unbuffered-query.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>mysql_unbuffered_query</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> <b>mysql_unbuffered_query()</b> sends a SQL query <i><tt class='parameter'>query</tt></i> to MySQL, without fetching and buffering the result rows automatically, as <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a> does. On the one hand, this saves a considerable amount of memory with SQL queries that produce large result sets. On the other hand, you can start working on the result set immediately after the first row has been retrieved: you don&amp;#039;t have to wait until the complete SQL query has been performed. When using multiple DB-connects, you have to specify the optional parameter <i><tt class='parameter'>link_identifier</tt></i> . </p> </div> <a name='function.mysql-unbuffered-query.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'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A SQL query </p> <p class='para'> Data inside the query should be <a href='http://www.php.net/manual/en/function.mysql-real-escape-string.php' class='link'>properly escaped</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-unbuffered-query.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> For SELECT, SHOW, DESCRIBE or EXPLAIN statements, <b>mysql_unbuffered_query()</b> returns a <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> on success, or <b><tt class='constant'>FALSE</tt></b> on error. </p> <p class='para'> For other type of SQL statements, UPDATE, DELETE, DROP, etc, <b>mysql_unbuffered_query()</b> returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.mysql-unbuffered-query.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The benefits of <b>mysql_unbuffered_query()</b> come at a cost: You cannot use <a href='http://www.php.net/manual/en/function.mysql-num-rows.php' class='function'>mysql_num_rows()</a> and <a href='http://www.php.net/manual/en/function.mysql-data-seek.php' class='function'>mysql_data_seek()</a> on a result set returned from <b>mysql_unbuffered_query()</b>. You also have to fetch all result rows from an unbuffered SQL query, before you can send a new SQL query to MySQL. <br /> </p></blockquote> </div> <a name='function.mysql-unbuffered-query.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.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</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="mysql_thread_id" value="<div id='function.mysql-thread-id' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-thread-id.php'>mysql_thread_id</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_thread_id</span> &amp;mdash; <span class='dc-title'>Return the current thread ID</span></p> </div> <a name='function.mysql-thread-id.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>mysql_thread_id</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Retrieves the current thread ID. If the connection is lost, and a reconnect with <a href='http://www.php.net/manual/en/function.mysql-ping.php' class='function'>mysql_ping()</a> is executed, the thread ID will change. This means only retrieve the thread ID when needed. </p> </div> <a name='function.mysql-thread-id.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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-thread-id.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The thread ID on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-thread-id.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_thread_id()</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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$thread_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_thread_id</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$thread_id</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: #DD0000'>'current&amp;nbsp;thread&amp;nbsp;id&amp;nbsp;is&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$thread_id</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> current thread id is 73 </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-thread-id.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.mysql-ping.php' class='function' rel='rdfs-seeAlso'>mysql_ping()</a> - Ping a server connection or reconnect if there is no connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-list-processes.php' class='function' rel='rdfs-seeAlso'>mysql_list_processes()</a> - List MySQL processes</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="mysql_tablename" value="<div id='function.mysql-tablename' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-tablename.php'>mysql_tablename</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_tablename</span> &amp;mdash; <span class='dc-title'>Get table name of field</span></p> </div> <a name='function.mysql-tablename.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>mysql_tablename</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$i</tt></span> )</div> <p class='para rdfs-comment'> Retrieves the table name from a <i><tt class='parameter'>result</tt></i> . </p> <p class='para'> This function deprecated. It is preferable to use <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a> to issue a SQL <i>SHOW TABLES [FROM db_name] [LIKE &amp;#039;pattern&amp;#039;]</i> statement instead. </p> </div> <a name='function.mysql-tablename.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'>result</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A result pointer <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that&amp;#039;s returned from <a href='http://www.php.net/manual/en/function.mysql-list-tables.php' class='function'>mysql_list_tables()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The integer index (row/table number) </p> </dd> </dl> <p> </p> </div> <a name='function.mysql-tablename.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The name of the table on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> Use the <b>mysql_tablename()</b> function to traverse this result pointer, or any function for result tables, such as <a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function'>mysql_fetch_array()</a>. </p> </div> <a name='function.mysql-tablename.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_tablename()</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 />mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_list_tables</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num_rows&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />for&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</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'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>$num_rows</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'>'Table:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysql_tablename</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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.mysql-tablename.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The <a href='http://www.php.net/manual/en/function.mysql-num-rows.php' class='function'>mysql_num_rows()</a> function may be used to determine the number of tables in the result pointer. <br /> </p></blockquote> </div> <a name='function.mysql-tablename.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.mysql-list-tables.php' class='function' rel='rdfs-seeAlso'>mysql_list_tables()</a> - List tables in a MySQL database</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-field-table.php' class='function' rel='rdfs-seeAlso'>mysql_field_table()</a> - Get name of the table the specified field is in</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-db-name.php' class='function' rel='rdfs-seeAlso'>mysql_db_name()</a> - Get result data</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="mysql_stat" value="<div id='function.mysql-stat' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-stat.php'>mysql_stat</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_stat</span> &amp;mdash; <span class='dc-title'>Get current system status</span></p> </div> <a name='function.mysql-stat.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>mysql_stat</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> <b>mysql_stat()</b> returns the current server status. </p> </div> <a name='function.mysql-stat.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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-stat.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string with the status for uptime, threads, queries, open tables, flush tables and queries per second. For a complete list of other status variables, you have to use the <i>SHOW STATUS</i> SQL command. If <i><tt class='parameter'>link_identifier</tt></i> is invalid, <b><tt class='constant'>NULL</tt></b> is returned. </p> </div> <a name='function.mysql-stat.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_stat()</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 />$link&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$status&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'>'&amp;nbsp;&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysql_stat</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$status</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 ( [0] =&amp;gt; Uptime: 5380 [1] =&amp;gt; Threads: 2 [2] =&amp;gt; Questions: 1321299 [3] =&amp;gt; Slow queries: 0 [4] =&amp;gt; Opens: 26 [5] =&amp;gt; Flush tables: 1 [6] =&amp;gt; Open tables: 17 [7] =&amp;gt; Queries per second avg: 245.595 ) </pre></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 Alternative <b>mysql_stat()</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 />$link&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SHOW&amp;nbsp;VARIABLES'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'Variable_name'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;=&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'Value'</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 above example will output something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> back_log = 50 basedir = /usr/local/ bdb_cache_size = 8388600 bdb_log_buffer_size = 32768 bdb_home = /var/db/mysql/ bdb_max_lock = 10000 bdb_logdir = bdb_shared_data = OFF bdb_tmpdir = /var/tmp/ ... </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-stat.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.mysql-get-server-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_server_info()</a> - Get MySQL server info</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-list-processes.php' class='function' rel='rdfs-seeAlso'>mysql_list_processes()</a> - List MySQL processes</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="mysql_set_charset" value="<div id='function.mysql-set-charset' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-set-charset.php'>mysql_set_charset</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.3)</p><p class='refpurpose'><span class='refname'>mysql_set_charset</span> &amp;mdash; <span class='dc-title'>Sets the client character set</span></p> </div> <a name='function.mysql-set-charset.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>mysql_set_charset</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Sets the default character set for the current connection. </p> </div> <a name='function.mysql-set-charset.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'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid character set name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-set-charset.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.mysql-set-charset.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function requires MySQL 5.0.7 or later. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: This is the preferred way to change the charset. Using <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a> to execute <i>SET NAMES ..</i> is not recommended. <br /> </p></blockquote> </div> <a name='function.mysql-set-charset.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.mysql-client-encoding.php' class='function' rel='rdfs-seeAlso'>mysql_client_encoding()</a> - Returns the name of the character set</li> <li class='member'><a href='http://dev.mysql.com/doc/refman/5.1/en/charset-charsets.html' class='link external'>&amp;raquo; List of character sets that MySQL supports</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="mysql_select_db" value="<div id='function.mysql-select-db' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-select-db.php'>mysql_select_db</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_select_db</span> &amp;mdash; <span class='dc-title'>Select a MySQL database</span></p> </div> <a name='function.mysql-select-db.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>mysql_select_db</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$database_name</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Sets the current active database on the server that&amp;#039;s associated with the specified link identifier. Every subsequent call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a> will be made on the active database. </p> </div> <a name='function.mysql-select-db.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'>database_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the database that is to be selected. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-select-db.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.mysql-select-db.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_select_db()</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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Not&amp;nbsp;connected&amp;nbsp;:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;make&amp;nbsp;foo&amp;nbsp;the&amp;nbsp;current&amp;nbsp;db<br /></span><span style='color: #0000BB'>$db_selected&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'foo'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$db_selected</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die&amp;nbsp;(</span><span style='color: #DD0000'>'Can\'t&amp;nbsp;use&amp;nbsp;foo&amp;nbsp;:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</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.mysql-select-db.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_selectdb()</b> <br /> </p></blockquote> </div> <a name='function.mysql-select-db.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.mysql-connect.php' class='function' rel='rdfs-seeAlso'>mysql_connect()</a> - Open a connection to a MySQL Server</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-pconnect.php' class='function' rel='rdfs-seeAlso'>mysql_pconnect()</a> - Open a persistent connection to a MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</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="mysql_result" value="<div id='function.mysql-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-result.php'>mysql_result</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_result</span> &amp;mdash; <span class='dc-title'>Get result data</span></p> </div> <a name='function.mysql-result.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>mysql_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$row</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'>$field</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Retrieves the contents of one cell from a MySQL result set. </p> <p class='para'> When working on large result sets, you should consider using one of the functions that fetch an entire row (specified below). As these functions return the contents of multiple cells in one function call, they&amp;#039;re MUCH quicker than <b>mysql_result()</b>. Also, note that specifying a numeric offset for the field argument is much quicker than specifying a fieldname or tablename.fieldname argument. </p> </div> <a name='function.mysql-result.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The row number from the result that&amp;#039;s being retrieved. Row numbers start at <i>0</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name or offset of the field being retrieved. </p> <p class='para'> It can be the field&amp;#039;s offset, the field&amp;#039;s name, or the field&amp;#039;s table dot field name (tablename.fieldname). If the column name has been aliased (&amp;#039;select foo as bar from...&amp;#039;), use the alias instead of the column name. If undefined, the first field is retrieved. </p> </dd> </dl> <p> </p> </div> <a name='function.mysql-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The contents of one cell from a MySQL result set on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_result()</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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;name&amp;nbsp;FROM&amp;nbsp;work.employee'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;query:'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br />echo&amp;nbsp;</span><span style='color: #0000BB'>mysql_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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;outputs&amp;nbsp;third&amp;nbsp;employee's&amp;nbsp;name<br /><br /></span><span style='color: #0000BB'>mysql_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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.mysql-result.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Calls to <b>mysql_result()</b> should not be mixed with calls to other functions that deal with the result set. <br /> </p></blockquote> </div> <a name='function.mysql-result.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.mysql-fetch-row.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_row()</a> - Get a result row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_array()</a> - Fetch a result row as an associative array, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_assoc()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-object.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_object()</a> - Fetch a result row as an object</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="mysql_real_escape_string" value="<div id='function.mysql-real-escape-string' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-real-escape-string.php'>mysql_real_escape_string</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_real_escape_string</span> &amp;mdash; <span class='dc-title'>Escapes special characters in a string for use in a SQL statement</span></p> </div> <a name='function.mysql-real-escape-string.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>mysql_real_escape_string</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$unescaped_string</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Escapes special characters in the <i><tt class='parameter'>unescaped_string</tt></i> , taking into account the current character set of the connection so that it is safe to place it in a <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>. If binary data is to be inserted, this function must be used. </p> <p class='para'> <b>mysql_real_escape_string()</b> calls MySQL&amp;#039;s library function mysql_real_escape_string, which prepends backslashes to the following characters: <i>\x00</i>, <i>\n</i>, <i>\r</i>, <i>\</i>, <i>&amp;#039;</i>, <i>&amp;quot;</i> and <i>\x1a</i>. </p> <p class='para'> This function must always (with few exceptions) be used to make data safe before sending a query to MySQL. </p> </div> <a name='function.mysql-real-escape-string.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'>unescaped_string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string that is to be escaped. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-real-escape-string.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the escaped string, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.mysql-real-escape-string.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Simple <b>mysql_real_escape_string()</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;Connect<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mysql_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;OR&amp;nbsp;die(</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Query<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>sprintf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;users&amp;nbsp;WHERE&amp;nbsp;user='%s'&amp;nbsp;AND&amp;nbsp;password='%s''</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'>mysql_real_escape_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$user</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'>mysql_real_escape_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$password</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 An example SQL Injection Attack</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;Query&amp;nbsp;database&amp;nbsp;to&amp;nbsp;check&amp;nbsp;if&amp;nbsp;there&amp;nbsp;are&amp;nbsp;any&amp;nbsp;matching&amp;nbsp;users<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;users&amp;nbsp;WHERE&amp;nbsp;user='</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$_POST</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>'&amp;nbsp;AND&amp;nbsp;password='</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$_POST</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>''</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;We&amp;nbsp;didn't&amp;nbsp;check&amp;nbsp;$_POST['password'],&amp;nbsp;it&amp;nbsp;could&amp;nbsp;be&amp;nbsp;anything&amp;nbsp;the&amp;nbsp;user&amp;nbsp;wanted!&amp;nbsp;For&amp;nbsp;example:<br /></span><span style='color: #0000BB'>$_POST</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'aidan'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$_POST</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>''&amp;nbsp;OR&amp;nbsp;''=''</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;means&amp;nbsp;the&amp;nbsp;query&amp;nbsp;sent&amp;nbsp;to&amp;nbsp;MySQL&amp;nbsp;would&amp;nbsp;be:<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>$query</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 query sent to MySQL: </p></div> <div class='example-contents screen'> <div class='cdata'><pre> SELECT * FROM users WHERE user=&amp;#039;aidan&amp;#039; AND password=&amp;#039;&amp;#039; OR &amp;#039;&amp;#039;=&amp;#039;&amp;#039; </pre></div> </div> <div class='example-contents para'><p> This would allow anyone to log in without a valid password. </p></div> </div><p> </p> </div> <a name='function.mysql-real-escape-string.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: A MySQL connection is required before using <b>mysql_real_escape_string()</b> otherwise an error of level <b><tt class='constant'>E_WARNING</tt></b> is generated, and <b><tt class='constant'>FALSE</tt></b> is returned. If <i><tt class='parameter'>link_identifier</tt></i> isn&amp;#039;t defined, the last MySQL connection is used. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: If <a href='http://www.php.net/manual/en/info.configuration.php#ini.magic-quotes-gpc' class='link'>magic_quotes_gpc</a> is enabled, first apply <a href='http://www.php.net/manual/en/function.stripslashes.php' class='function'>stripslashes()</a> to the data. Using this function on data which has already been escaped will escape the data twice. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: If this function is not used to escape data, the query is vulnerable to <a href='http://www.php.net/manual/en/security.database.sql-injection.php' class='link'>SQL Injection Attacks</a>. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> <b>mysql_real_escape_string()</b> does not escape <i>%</i> and <i>_</i>. These are wildcards in MySQL if combined with <i>LIKE</i>, <i>GRANT</i>, or <i>REVOKE</i>. </span> </p></blockquote> </div> <a name='function.mysql-real-escape-string.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.mysql-client-encoding.php' class='function' rel='rdfs-seeAlso'>mysql_client_encoding()</a> - Returns the name of the character set</li> <li class='member'><a href='http://www.php.net/manual/en/function.addslashes.php' class='function' rel='rdfs-seeAlso'>addslashes()</a> - Quote string with slashes</li> <li class='member'><a href='http://www.php.net/manual/en/function.stripslashes.php' class='function' rel='rdfs-seeAlso'>stripslashes()</a> - Un-quotes a quoted string</li> <li class='member'>The <a href='http://www.php.net/manual/en/info.configuration.php#ini.magic-quotes-gpc' class='link'>magic_quotes_gpc</a> directive</li> <li class='member'>The <a href='http://www.php.net/manual/en/info.configuration.php#ini.magic-quotes-runtime' class='link'>magic_quotes_runtime</a> directive</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="mysql_query" value="<div id='function.mysql-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-query.php'>mysql_query</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_query</span> &amp;mdash; <span class='dc-title'>Send a MySQL query</span></p> </div> <a name='function.mysql-query.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>mysql_query</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> <b>mysql_query()</b> sends a unique query (multiple queries are not supported) to the currently active database on the server that&amp;#039;s associated with the specified <i><tt class='parameter'>link_identifier</tt></i> . </p> </div> <a name='function.mysql-query.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'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A SQL query </p> <p class='para'> The query string should not end with a semicolon. Data inside the query should be <a href='http://www.php.net/manual/en/function.mysql-real-escape-string.php' class='link'>properly escaped</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-query.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements returning resultset, <b>mysql_query()</b> returns a <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> on success, or <b><tt class='constant'>FALSE</tt></b> on error. </p> <p class='para'> For other type of SQL statements, INSERT, UPDATE, DELETE, DROP, etc, <b>mysql_query()</b> returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on error. </p> <p class='para'> The returned result resource should be passed to <a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function'>mysql_fetch_array()</a>, and other functions for dealing with result tables, to access the returned data. </p> <p class='para'> Use <a href='http://www.php.net/manual/en/function.mysql-num-rows.php' class='function'>mysql_num_rows()</a> to find out how many rows were returned for a SELECT statement or <a href='http://www.php.net/manual/en/function.mysql-affected-rows.php' class='function'>mysql_affected_rows()</a> to find out how many rows were affected by a DELETE, INSERT, REPLACE, or UPDATE statement. </p> <p class='para'> <b>mysql_query()</b> will also fail and return <b><tt class='constant'>FALSE</tt></b> if the user does not have permission to access the table(s) referenced by the query. </p> </div> <a name='function.mysql-query.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Invalid Query</b></p> <div class='example-contents para'><p> The following query is syntactically invalid, so <b>mysql_query()</b> fails and returns <b><tt class='constant'>FALSE</tt></b>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;WHERE&amp;nbsp;1=1'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Invalid&amp;nbsp;query:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /><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 Valid Query</b></p> <div class='example-contents para'><p> The following query is valid, so <b>mysql_query()</b> returns a <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p></div> <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;could&amp;nbsp;be&amp;nbsp;supplied&amp;nbsp;by&amp;nbsp;a&amp;nbsp;user,&amp;nbsp;for&amp;nbsp;example<br /></span><span style='color: #0000BB'>$firstname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'fred'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$lastname&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'fox'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Formulate&amp;nbsp;Query<br />//&amp;nbsp;This&amp;nbsp;is&amp;nbsp;the&amp;nbsp;best&amp;nbsp;way&amp;nbsp;to&amp;nbsp;perform&amp;nbsp;a&amp;nbsp;SQL&amp;nbsp;query<br />//&amp;nbsp;For&amp;nbsp;more&amp;nbsp;examples,&amp;nbsp;see&amp;nbsp;mysql_real_escape_string()<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>sprintf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;firstname,&amp;nbsp;lastname,&amp;nbsp;address,&amp;nbsp;age&amp;nbsp;FROM&amp;nbsp;friends&amp;nbsp;WHERE&amp;nbsp;firstname='%s'&amp;nbsp;AND&amp;nbsp;lastname='%s''</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysql_real_escape_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$firstname</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysql_real_escape_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$lastname</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Perform&amp;nbsp;Query<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Check&amp;nbsp;result<br />//&amp;nbsp;This&amp;nbsp;shows&amp;nbsp;the&amp;nbsp;actual&amp;nbsp;query&amp;nbsp;sent&amp;nbsp;to&amp;nbsp;MySQL,&amp;nbsp;and&amp;nbsp;the&amp;nbsp;error.&amp;nbsp;Useful&amp;nbsp;for&amp;nbsp;debugging.<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$message&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Invalid&amp;nbsp;query:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</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;</span><span style='color: #0000BB'>$message&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'Whole&amp;nbsp;query:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #0000BB'>$message</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Use&amp;nbsp;result<br />//&amp;nbsp;Attempting&amp;nbsp;to&amp;nbsp;print&amp;nbsp;$result&amp;nbsp;won't&amp;nbsp;allow&amp;nbsp;access&amp;nbsp;to&amp;nbsp;information&amp;nbsp;in&amp;nbsp;the&amp;nbsp;resource<br />//&amp;nbsp;One&amp;nbsp;of&amp;nbsp;the&amp;nbsp;mysql&amp;nbsp;result&amp;nbsp;functions&amp;nbsp;must&amp;nbsp;be&amp;nbsp;used<br />//&amp;nbsp;See&amp;nbsp;also&amp;nbsp;mysql_result(),&amp;nbsp;mysql_fetch_array(),&amp;nbsp;mysql_fetch_row(),&amp;nbsp;etc.<br /></span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'firstname'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'lastname'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'address'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'age'</span><span style='color: #007700'>];<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;resources&amp;nbsp;associated&amp;nbsp;with&amp;nbsp;the&amp;nbsp;result&amp;nbsp;set<br />//&amp;nbsp;This&amp;nbsp;is&amp;nbsp;done&amp;nbsp;automatically&amp;nbsp;at&amp;nbsp;the&amp;nbsp;end&amp;nbsp;of&amp;nbsp;the&amp;nbsp;script<br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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.mysql-query.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.mysql-connect.php' class='function' rel='rdfs-seeAlso'>mysql_connect()</a> - Open a connection to a MySQL Server</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-error.php' class='function' rel='rdfs-seeAlso'>mysql_error()</a> - Returns the text of the error message from previous MySQL operation</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-real-escape-string.php' class='function' rel='rdfs-seeAlso'>mysql_real_escape_string()</a> - Escapes special characters in a string for use in a SQL statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-result.php' class='function' rel='rdfs-seeAlso'>mysql_result()</a> - Get result data</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_assoc()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-unbuffered-query.php' class='function' rel='rdfs-seeAlso'>mysql_unbuffered_query()</a> - Send an SQL query to MySQL, without fetching and buffering the result rows</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="mysql_ping" value="<div id='function.mysql-ping' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-ping.php'>mysql_ping</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_ping</span> &amp;mdash; <span class='dc-title'>Ping a server connection or reconnect if there is no connection</span></p> </div> <a name='function.mysql-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>mysql_ping</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Checks whether or not the connection to the server is working. If it has gone down, an automatic reconnection is attempted. This function can be used by scripts that remain idle for a long while, to check whether or not the server has closed the connection and reconnect if necessary. </p> <blockquote><p><b class='note'>Note</b>: Since MySQL 5.0.13, automatic reconnection feature is disabled. <br /> </p></blockquote> </div> <a name='function.mysql-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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-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 connection to the server MySQL server is working, otherwise <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mysql-ping.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>mysql_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 />set_time_limit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysqluser'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mypass'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$db&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Assuming&amp;nbsp;this&amp;nbsp;query&amp;nbsp;will&amp;nbsp;take&amp;nbsp;a&amp;nbsp;long&amp;nbsp;time&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Query&amp;nbsp;#1&amp;nbsp;failed,&amp;nbsp;exiting.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Make&amp;nbsp;sure&amp;nbsp;the&amp;nbsp;connection&amp;nbsp;is&amp;nbsp;still&amp;nbsp;alive,&amp;nbsp;if&amp;nbsp;not,&amp;nbsp;try&amp;nbsp;to&amp;nbsp;reconnect&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>mysql_ping</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Lost&amp;nbsp;connection,&amp;nbsp;exiting&amp;nbsp;after&amp;nbsp;query&amp;nbsp;#1'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;So&amp;nbsp;the&amp;nbsp;connection&amp;nbsp;is&amp;nbsp;still&amp;nbsp;alive,&amp;nbsp;let's&amp;nbsp;run&amp;nbsp;another&amp;nbsp;query&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sql2</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.mysql-ping.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.mysql-thread-id.php' class='function' rel='rdfs-seeAlso'>mysql_thread_id()</a> - Return the current thread ID</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-list-processes.php' class='function' rel='rdfs-seeAlso'>mysql_list_processes()</a> - List MySQL processes</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="mysql_pconnect" value="<div id='function.mysql-pconnect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-pconnect.php'>mysql_pconnect</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_pconnect</span> &amp;mdash; <span class='dc-title'>Open a persistent connection to a MySQL server</span></p> </div> <a name='function.mysql-pconnect.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>mysql_pconnect</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$server</tt><span class='initializer'> = ini_get(&amp;quot;mysql.default_host&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt><span class='initializer'> = ini_get(&amp;quot;mysql.default_user&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt><span class='initializer'> = ini_get(&amp;quot;mysql.default_password&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$client_flags</tt></span> ]]]] )</div> <p class='para rdfs-comment'> Establishes a persistent connection to a MySQL server. </p> <p class='para'> <b>mysql_pconnect()</b> acts very much like <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> with two major differences. </p> <p class='para'> First, when connecting, the function would first try to find a (persistent) link that&amp;#039;s already open with the same host, username and password. If one is found, an identifier for it will be returned instead of opening a new connection. </p> <p class='para'> Second, the connection to the SQL server will not be closed when the execution of the script ends. Instead, the link will remain open for future use (<a href='http://www.php.net/manual/en/function.mysql-close.php' class='function'>mysql_close()</a> will not close links established by <b>mysql_pconnect()</b>). </p> <p class='para'> This type of link is therefore called &amp;#039;persistent&amp;#039;. </p> </div> <a name='function.mysql-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'>server</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The MySQL server. It can also include a port number. e.g. &amp;quot;hostname:port&amp;quot; or a path to a local socket e.g. &amp;quot;:/path/to/socket&amp;quot; for the localhost. </p> <p class='para'> If the PHP directive <a href='http://www.php.net/manual/en/mysql.configuration.php#ini.mysql.default-host' class='link'> mysql.default_host</a> is undefined (default), then the default value is &amp;#039;localhost:3306&amp;#039; </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. Default value is the name of the user that owns the server process. </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. Default value is an empty password. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>client_flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>client_flags</tt></i> parameter can be a combination of the following constants: 128 (enable <i>LOAD DATA LOCAL</i> handling), <b><tt class='constant'>MYSQL_CLIENT_SSL</tt></b>, <b><tt class='constant'>MYSQL_CLIENT_COMPRESS</tt></b>, <b><tt class='constant'>MYSQL_CLIENT_IGNORE_SPACE</tt></b> or <b><tt class='constant'>MYSQL_CLIENT_INTERACTIVE</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.mysql-pconnect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a MySQL persistent link identifier on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-pconnect.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'> Added the <i><tt class='parameter'>client_flags</tt></i> parameter. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mysql-pconnect.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Note, that these kind of links only work if you are using a module version of PHP. See the <a href='http://www.php.net/manual/en/features.persistent-connections.php' class='link'>Persistent Database Connections</a> section for more information. <br /> </p></blockquote> <div class='warning'><b class='warning'>Warning</b> <p class='para'> Using persistent connections can require a bit of tuning of your Apache and MySQL configurations to ensure that you do not exceed the number of connections allowed by MySQL. </p> </div> <blockquote><p><b class='note'>Note</b>: You can suppress the error message on failure by prepending a <a href='http://www.php.net/manual/en/language.operators.errorcontrol.php' class='link'>@</a> to the function name. <br /> </p></blockquote> </div> <a name='function.mysql-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.mysql-connect.php' class='function' rel='rdfs-seeAlso'>mysql_connect()</a> - Open a connection to a MySQL Server</li> <li class='member'><a href='http://www.php.net/manual/en/features.persistent-connections.php' class='link'>Persistent Database Connections</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="mysql_num_rows" value="<div id='function.mysql-num-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-num-rows.php'>mysql_num_rows</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_num_rows</span> &amp;mdash; <span class='dc-title'>Get number of rows in result</span></p> </div> <a name='function.mysql-num-rows.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>mysql_num_rows</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Retrieves the number of rows from a result set. This command is only valid for statements like SELECT or SHOW that return an actual result set. To retrieve the number of rows affected by a INSERT, UPDATE, REPLACE or DELETE query, use <a href='http://www.php.net/manual/en/function.mysql-affected-rows.php' class='function'>mysql_affected_rows()</a>. </p> </div> <a name='function.mysql-num-rows.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-num-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The number of rows in a result set on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-num-rows.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_num_rows()</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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'database'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;table1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$num_rows&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$num_rows</span><span style='color: #DD0000'>&amp;nbsp;Rows\n'</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.mysql-num-rows.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: If you use <a href='http://www.php.net/manual/en/function.mysql-unbuffered-query.php' class='function'>mysql_unbuffered_query()</a>, <b>mysql_num_rows()</b> will not return the correct value until all the rows in the result set have been retrieved. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_numrows()</b> <br /> </p></blockquote> </div> <a name='function.mysql-num-rows.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.mysql-affected-rows.php' class='function' rel='rdfs-seeAlso'>mysql_affected_rows()</a> - Get number of affected rows in previous MySQL operation</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function' rel='rdfs-seeAlso'>mysql_connect()</a> - Open a connection to a MySQL Server</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-data-seek.php' class='function' rel='rdfs-seeAlso'>mysql_data_seek()</a> - Move internal result pointer</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-select-db.php' class='function' rel='rdfs-seeAlso'>mysql_select_db()</a> - Select a MySQL database</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</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="mysql_num_fields" value="<div id='function.mysql-num-fields' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-num-fields.php'>mysql_num_fields</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_num_fields</span> &amp;mdash; <span class='dc-title'>Get number of fields in result</span></p> </div> <a name='function.mysql-num-fields.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>mysql_num_fields</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Retrieves the number of fields from a query. </p> </div> <a name='function.mysql-num-fields.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-num-fields.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of fields in the result set <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-num-fields.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>mysql_num_fields()</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 />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,email&amp;nbsp;FROM&amp;nbsp;people&amp;nbsp;WHERE&amp;nbsp;id&amp;nbsp;=&amp;nbsp;'42''</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&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;run&amp;nbsp;query:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;returns&amp;nbsp;2&amp;nbsp;because&amp;nbsp;id,email&amp;nbsp;===&amp;nbsp;two&amp;nbsp;fields&amp;nbsp;*/<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>mysql_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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.mysql-num-fields.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_numfields()</b> <br /> </p></blockquote> </div> <a name='function.mysql-num-fields.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.mysql-select-db.php' class='function' rel='rdfs-seeAlso'>mysql_select_db()</a> - Select a MySQL database</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-field.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_field()</a> - Get column information from a result and return as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-num-rows.php' class='function' rel='rdfs-seeAlso'>mysql_num_rows()</a> - Get number of rows in result</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="mysql_list_tables" value="<div id='function.mysql-list-tables' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-list-tables.php'>mysql_list_tables</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_list_tables</span> &amp;mdash; <span class='dc-title'>List tables in a MySQL database</span></p> </div> <a name='function.mysql-list-tables.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>mysql_list_tables</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$database</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Retrieves a list of table names from a MySQL database. </p> <p class='para'> This function is deprecated. It is preferable to use <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a> to issue a SQL <i>SHOW TABLES [FROM db_name] [LIKE &amp;#039;pattern&amp;#039;]</i> statement instead. </p> </div> <a name='function.mysql-list-tables.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'>database</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the database </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-list-tables.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A result pointer <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> Use the <a href='http://www.php.net/manual/en/function.mysql-tablename.php' class='function'>mysql_tablename()</a> function to traverse this result pointer, or any function for result tables, such as <a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function'>mysql_fetch_array()</a>. </p> </div> <a name='function.mysql-list-tables.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.7</td> <td align='left'> This function became deprecated. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mysql-list-tables.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_list_tables()</b> alternative example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$dbname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'mysql_dbname'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mysql_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>))&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;connect&amp;nbsp;to&amp;nbsp;mysql'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SHOW&amp;nbsp;TABLES&amp;nbsp;FROM&amp;nbsp;</span><span style='color: #0000BB'>$dbname</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DB&amp;nbsp;Error,&amp;nbsp;could&amp;nbsp;not&amp;nbsp;list&amp;nbsp;tables\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MySQL&amp;nbsp;Error:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Table:&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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.mysql-list-tables.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_listtables()</b> <br /> </p></blockquote> </div> <a name='function.mysql-list-tables.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.mysql-list-dbs.php' class='function' rel='rdfs-seeAlso'>mysql_list_dbs()</a> - List databases available on a MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-tablename.php' class='function' rel='rdfs-seeAlso'>mysql_tablename()</a> - Get table name of field</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="mysql_list_processes" value="<div id='function.mysql-list-processes' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-list-processes.php'>mysql_list_processes</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_list_processes</span> &amp;mdash; <span class='dc-title'>List MySQL processes</span></p> </div> <a name='function.mysql-list-processes.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>mysql_list_processes</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Retrieves the current MySQL server threads. </p> </div> <a name='function.mysql-list-processes.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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-list-processes.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A result pointer <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-list-processes.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_list_processes()</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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_list_processes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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: #DD0000'>'%s&amp;nbsp;%s&amp;nbsp;%s&amp;nbsp;%s&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'Id'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'Host'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'db'</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'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'Command'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'Time'</span><span style='color: #007700'>]);<br />}<br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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> 1 localhost test Processlist 0 4 localhost mysql sleep 5 </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-list-processes.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.mysql-thread-id.php' class='function' rel='rdfs-seeAlso'>mysql_thread_id()</a> - Return the current thread ID</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-stat.php' class='function' rel='rdfs-seeAlso'>mysql_stat()</a> - Get current system 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="mysql_list_fields" value="<div id='function.mysql-list-fields' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-list-fields.php'>mysql_list_fields</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_list_fields</span> &amp;mdash; <span class='dc-title'>List MySQL table fields</span></p> </div> <a name='function.mysql-list-fields.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>mysql_list_fields</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$database_name</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Retrieves information about the given table name. </p> <p class='para'> This function is deprecated. It is preferable to use <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a> to issue a SQL <i>SHOW COLUMNS FROM table [LIKE &amp;#039;name&amp;#039;]</i> statement instead. </p> </div> <a name='function.mysql-list-fields.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'>database_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the database that&amp;#039;s being queried. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the table that&amp;#039;s being queried. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-list-fields.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A result pointer <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The returned result can be used with <a href='http://www.php.net/manual/en/function.mysql-field-flags.php' class='function'>mysql_field_flags()</a>, <a href='http://www.php.net/manual/en/function.mysql-field-len.php' class='function'>mysql_field_len()</a>, <a href='http://www.php.net/manual/en/function.mysql-field-name.php' class='function'>mysql_field_name()</a> and <a href='http://www.php.net/manual/en/function.mysql-field-type.php' class='function'>mysql_field_type()</a>. </p> </div> <a name='function.mysql-list-fields.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Alternate to deprecated <b>mysql_list_fields()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SHOW&amp;nbsp;COLUMNS&amp;nbsp;FROM&amp;nbsp;sometable'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&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;run&amp;nbsp;query:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br />if&amp;nbsp;(</span><span style='color: #0000BB'>mysql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;&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;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&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'>$row</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 above example will output something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Array ( [Field] =&amp;gt; id [Type] =&amp;gt; int(7) [Null] =&amp;gt; [Key] =&amp;gt; PRI [Default] =&amp;gt; [Extra] =&amp;gt; auto_increment ) Array ( [Field] =&amp;gt; email [Type] =&amp;gt; varchar(100) [Null] =&amp;gt; [Key] =&amp;gt; [Default] =&amp;gt; [Extra] =&amp;gt; ) </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-list-fields.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_listfields()</b> <br /> </p></blockquote> </div> <a name='function.mysql-list-fields.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.mysql-field-flags.php' class='function' rel='rdfs-seeAlso'>mysql_field_flags()</a> - Get the flags associated with the specified field in a result</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-info.php' class='function' rel='rdfs-seeAlso'>mysql_info()</a> - Get information about the most recent query</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="mysql_list_dbs" value="<div id='function.mysql-list-dbs' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-list-dbs.php'>mysql_list_dbs</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_list_dbs</span> &amp;mdash; <span class='dc-title'>List databases available on a MySQL server</span></p> </div> <a name='function.mysql-list-dbs.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>mysql_list_dbs</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Returns a result pointer containing the databases available from the current mysql daemon. </p> </div> <a name='function.mysql-list-dbs.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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-list-dbs.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a result pointer <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> on success, or <b><tt class='constant'>FALSE</tt></b> on failure. Use the <a href='http://www.php.net/manual/en/function.mysql-tablename.php' class='function'>mysql_tablename()</a> function to traverse this result pointer, or any function for result tables, such as <a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function'>mysql_fetch_array()</a>. </p> </div> <a name='function.mysql-list-dbs.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_list_dbs()</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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$db_list&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_list_dbs</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db_list</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Database&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 something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> database1 database2 database3 </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-list-dbs.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_listdbs()</b> <br /> </p></blockquote> </div> <a name='function.mysql-list-dbs.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.mysql-db-name.php' class='function' rel='rdfs-seeAlso'>mysql_db_name()</a> - Get result data</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-select-db.php' class='function' rel='rdfs-seeAlso'>mysql_select_db()</a> - Select a MySQL database</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="mysql_insert_id" value="<div id='function.mysql-insert-id' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-insert-id.php'>mysql_insert_id</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_insert_id</span> &amp;mdash; <span class='dc-title'>Get the ID generated from the previous INSERT operation</span></p> </div> <a name='function.mysql-insert-id.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>mysql_insert_id</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query. </p> </div> <a name='function.mysql-insert-id.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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-insert-id.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The ID generated for an AUTO_INCREMENT column by the previous INSERT query on success, <i>0</i> if the previous query does not generate an AUTO_INCREMENT value, or <b><tt class='constant'>FALSE</tt></b> if no MySQL connection was established. </p> </div> <a name='function.mysql-insert-id.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_insert_id()</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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;mytable&amp;nbsp;(product)&amp;nbsp;values&amp;nbsp;('kossu')'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Last&amp;nbsp;inserted&amp;nbsp;record&amp;nbsp;has&amp;nbsp;id&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysql_insert_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.mysql-insert-id.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='caution'><b class='caution'>Caution</b> <p class='para'> <b>mysql_insert_id()</b> converts the return type of the native MySQL C API function <i>mysql_insert_id()</i> to a type of <i>long</i> (named <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> in PHP). If your AUTO_INCREMENT column has a column type of BIGINT, the value returned by <b>mysql_insert_id()</b> will be incorrect. Instead, use the internal MySQL SQL function <i>LAST_INSERT_ID()</i> in an SQL query. </p> </div> <blockquote><p><b class='note'>Note</b>: Because <b>mysql_insert_id()</b> acts on the last performed query, be sure to call <b>mysql_insert_id()</b> immediately after the query that generates the value. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: The value of the MySQL SQL function <i>LAST_INSERT_ID()</i> always contains the most recently generated AUTO_INCREMENT value, and is not reset between queries. <br /> </p></blockquote> </div> <a name='function.mysql-insert-id.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.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-info.php' class='function' rel='rdfs-seeAlso'>mysql_info()</a> - Get information about the most recent query</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="mysql_info" value="<div id='function.mysql-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-info.php'>mysql_info</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_info</span> &amp;mdash; <span class='dc-title'>Get information about the most recent query</span></p> </div> <a name='function.mysql-info.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>mysql_info</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Returns detailed information about the last query. </p> </div> <a name='function.mysql-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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns information about the statement on success, or <b><tt class='constant'>FALSE</tt></b> on failure. See the example below for which statements provide information, and what the returned value may look like. Statements that are not listed will return <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mysql-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Relevant MySQL Statements</b></p> <div class='example-contents para'><p> Statements that return string values. The numbers are only for illustrating purpose; their values will correspond to the query. </p></div> <div class='example-contents programlisting'> <div class='mysqlcode'><pre class='mysqlcode'>INSERT INTO ... SELECT ... String format: Records: 23 Duplicates: 0 Warnings: 0 INSERT INTO ... VALUES (...),(...),(...)... String format: Records: 37 Duplicates: 0 Warnings: 0 LOAD DATA INFILE ... String format: Records: 42 Deleted: 0 Skipped: 0 Warnings: 0 ALTER TABLE String format: Records: 60 Duplicates: 0 Warnings: 0 UPDATE String format: Rows matched: 65 Changed: 65 Warnings: 0</pre> </div> </div> </div><p> </p> </div> <a name='function.mysql-info.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>mysql_info()</b> returns a non-<b><tt class='constant'>FALSE</tt></b> value for the INSERT ... VALUES statement only if multiple value lists are specified in the statement. <br /> </p></blockquote> </div> <a name='function.mysql-info.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.mysql-affected-rows.php' class='function' rel='rdfs-seeAlso'>mysql_affected_rows()</a> - Get number of affected rows in previous MySQL operation</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-insert-id.php' class='function' rel='rdfs-seeAlso'>mysql_insert_id()</a> - Get the ID generated from the previous INSERT operation</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-stat.php' class='function' rel='rdfs-seeAlso'>mysql_stat()</a> - Get current system 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="mysql_get_server_info" value="<div id='function.mysql-get-server-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-get-server-info.php'>mysql_get_server_info</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_get_server_info</span> &amp;mdash; <span class='dc-title'>Get MySQL server info</span></p> </div> <a name='function.mysql-get-server-info.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>mysql_get_server_info</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Retrieves the MySQL server version. </p> </div> <a name='function.mysql-get-server-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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-get-server-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the MySQL server version on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-get-server-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_get_server_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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MySQL&amp;nbsp;server&amp;nbsp;version:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysql_get_server_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 something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> MySQL server version: 4.0.1-alpha </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-get-server-info.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.mysql-get-client-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_client_info()</a> - Get MySQL client info</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-get-host-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_host_info()</a> - Get MySQL host info</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-get-proto-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_proto_info()</a> - Get MySQL protocol info</li> <li class='member'><a href='http://www.php.net/manual/en/function.phpversion.php' class='function' rel='rdfs-seeAlso'>phpversion()</a> - Gets the current PHP version</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="mysql_get_proto_info" value="<div id='function.mysql-get-proto-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-get-proto-info.php'>mysql_get_proto_info</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_get_proto_info</span> &amp;mdash; <span class='dc-title'>Get MySQL protocol info</span></p> </div> <a name='function.mysql-get-proto-info.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>mysql_get_proto_info</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Retrieves the MySQL protocol. </p> </div> <a name='function.mysql-get-proto-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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-get-proto-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the MySQL protocol on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-get-proto-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_get_proto_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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MySQL&amp;nbsp;protocol&amp;nbsp;version:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysql_get_proto_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 something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> MySQL protocol version: 10 </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-get-proto-info.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.mysql-get-client-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_client_info()</a> - Get MySQL client info</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-get-host-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_host_info()</a> - Get MySQL host info</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-get-server-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_server_info()</a> - Get MySQL server info</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="mysql_get_host_info" value="<div id='function.mysql-get-host-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-get-host-info.php'>mysql_get_host_info</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_get_host_info</span> &amp;mdash; <span class='dc-title'>Get MySQL host info</span></p> </div> <a name='function.mysql-get-host-info.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>mysql_get_host_info</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Describes the type of connection in use for the connection, including the server host name. </p> </div> <a name='function.mysql-get-host-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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-get-host-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string describing the type of MySQL connection in use for the connection or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-get-host-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_get_host_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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MySQL&amp;nbsp;host&amp;nbsp;info:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysql_get_host_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 something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> MySQL host info: Localhost via UNIX socket </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-get-host-info.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.mysql-get-client-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_client_info()</a> - Get MySQL client info</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-get-proto-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_proto_info()</a> - Get MySQL protocol info</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-get-server-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_server_info()</a> - Get MySQL server info</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="mysql_get_client_info" value="<div id='function.mysql-get-client-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-get-client-info.php'>mysql_get_client_info</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_get_client_info</span> &amp;mdash; <span class='dc-title'>Get MySQL client info</span></p> </div> <a name='function.mysql-get-client-info.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>mysql_get_client_info</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> <b>mysql_get_client_info()</b> returns a string that represents the client library version. </p> </div> <a name='function.mysql-get-client-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The MySQL client version. </p> </div> <a name='function.mysql-get-client-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_get_client_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 />printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MySQL&amp;nbsp;client&amp;nbsp;info:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysql_get_client_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 something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> MySQL client info: 3.23.39 </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-get-client-info.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.mysql-get-host-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_host_info()</a> - Get MySQL host info</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-get-proto-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_proto_info()</a> - Get MySQL protocol info</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-get-server-info.php' class='function' rel='rdfs-seeAlso'>mysql_get_server_info()</a> - Get MySQL server info</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="mysql_free_result" value="<div id='function.mysql-free-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-free-result.php'>mysql_free_result</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_free_result</span> &amp;mdash; <span class='dc-title'>Free result memory</span></p> </div> <a name='function.mysql-free-result.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>mysql_free_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>mysql_free_result()</b> will free all memory associated with the result identifier <i><tt class='parameter'>result</tt></i> . </p> <p class='para'> <b>mysql_free_result()</b> only needs to be called if you are concerned about how much memory is being used for queries that return large result sets. All associated result memory is automatically freed at the end of the script&amp;#039;s execution. </p> </div> <a name='function.mysql-free-result.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-free-result.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'> If a non-resource is used for the <i><tt class='parameter'>result</tt></i> , an error of level E_WARNING will be emitted. It&amp;#039;s worth noting that <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a> only returns a <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> for SELECT, SHOW, EXPLAIN, and DESCRIBE queries. </p> </div> <a name='function.mysql-free-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>mysql_free_result()</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 />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,email&amp;nbsp;FROM&amp;nbsp;people&amp;nbsp;WHERE&amp;nbsp;id&amp;nbsp;=&amp;nbsp;'42''</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&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;run&amp;nbsp;query:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Use&amp;nbsp;the&amp;nbsp;result,&amp;nbsp;assuming&amp;nbsp;we're&amp;nbsp;done&amp;nbsp;with&amp;nbsp;it&amp;nbsp;afterwards&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Now&amp;nbsp;we&amp;nbsp;free&amp;nbsp;up&amp;nbsp;the&amp;nbsp;result&amp;nbsp;and&amp;nbsp;continue&amp;nbsp;on&amp;nbsp;with&amp;nbsp;our&amp;nbsp;script&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'id'</span><span style='color: #007700'>];<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'email'</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.mysql-free-result.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_freeresult()</b> <br /> </p></blockquote> </div> <a name='function.mysql-free-result.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.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-resource.php' class='function' rel='rdfs-seeAlso'>is_resource()</a> - Finds whether a variable is a resource</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="mysql_field_type" value="<div id='function.mysql-field-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-field-type.php'>mysql_field_type</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_field_type</span> &amp;mdash; <span class='dc-title'>Get the type of the specified field in a result</span></p> </div> <a name='function.mysql-field-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>mysql_field_type</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_offset</tt></span> )</div> <p class='para rdfs-comment'> <b>mysql_field_type()</b> is similar to the <a href='http://www.php.net/manual/en/function.mysql-field-name.php' class='function'>mysql_field_name()</a> function. The arguments are identical, but the field type is returned instead. </p> </div> <a name='function.mysql-field-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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> field_offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The numerical field offset. The <i><tt class='parameter'>field_offset</tt></i> starts at <i>0</i>. If <i><tt class='parameter'>field_offset</tt></i> does not exist, an error of level <b><tt class='constant'>E_WARNING</tt></b> is also issued.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-field-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The returned field type will be one of <i>&amp;quot;int&amp;quot;</i>, <i>&amp;quot;real&amp;quot;</i>, <i>&amp;quot;string&amp;quot;</i>, <i>&amp;quot;blob&amp;quot;</i>, and others as detailed in the <a href='http://dev.mysql.com/doc/' class='link external'>&amp;raquo; MySQL documentation</a>. </p> </div> <a name='function.mysql-field-type.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_field_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 />mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_username'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mysql'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;func'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$fields&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rows&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$table&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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: #DD0000'>'Your&amp;nbsp;''&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$table&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>''&amp;nbsp;table&amp;nbsp;has&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$fields&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;fields&amp;nbsp;and&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$rows&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;record(s)\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;table&amp;nbsp;has&amp;nbsp;the&amp;nbsp;following&amp;nbsp;fields:\n'</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&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>$fields</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;</span><span style='color: #0000BB'>$type&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$name&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$len&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_len</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$flags&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_flags</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$type&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$name&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$len&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$flags&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'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysql_close</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> Your &amp;#039;func&amp;#039; table has 4 fields and 1 record(s) The table has the following fields: string name 64 not_null primary_key binary int ret 1 not_null string dl 128 not_null string type 9 not_null enum </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-field-type.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_fieldtype()</b> <br /> </p></blockquote> </div> <a name='function.mysql-field-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/function.mysql-field-name.php' class='function' rel='rdfs-seeAlso'>mysql_field_name()</a> - Get the name of the specified field in a result</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-field-len.php' class='function' rel='rdfs-seeAlso'>mysql_field_len()</a> - Returns the length of the specified field</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="mysql_field_table" value="<div id='function.mysql-field-table' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-field-table.php'>mysql_field_table</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_field_table</span> &amp;mdash; <span class='dc-title'>Get name of the table the specified field is in</span></p> </div> <a name='function.mysql-field-table.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>mysql_field_table</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_offset</tt></span> )</div> <p class='para rdfs-comment'> Returns the name of the table that the specified field is in. </p> </div> <a name='function.mysql-field-table.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> field_offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The numerical field offset. The <i><tt class='parameter'>field_offset</tt></i> starts at <i>0</i>. If <i><tt class='parameter'>field_offset</tt></i> does not exist, an error of level <b><tt class='constant'>E_WARNING</tt></b> is also issued.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-field-table.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The name of the table on success. </p> </div> <a name='function.mysql-field-table.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>mysql_field_table()</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 />$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;account.*,&amp;nbsp;country.*&amp;nbsp;FROM&amp;nbsp;account,&amp;nbsp;country&amp;nbsp;WHERE&amp;nbsp;country.name&amp;nbsp;=&amp;nbsp;'Portugal'&amp;nbsp;AND&amp;nbsp;account.country_id&amp;nbsp;=&amp;nbsp;country.id'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;get&amp;nbsp;the&amp;nbsp;result&amp;nbsp;from&amp;nbsp;the&amp;nbsp;DB<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Lists&amp;nbsp;the&amp;nbsp;table&amp;nbsp;name&amp;nbsp;and&amp;nbsp;then&amp;nbsp;the&amp;nbsp;field&amp;nbsp;name<br /></span><span style='color: #007700'>for&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</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'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>mysql_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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;</span><span style='color: #0000BB'>$table&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$field&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$table</span><span style='color: #DD0000'>:&amp;nbsp;</span><span style='color: #0000BB'>$field</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mysql-field-table.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_fieldtable()</b> <br /> </p></blockquote> </div> <a name='function.mysql-field-table.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.mysql-list-tables.php' class='function' rel='rdfs-seeAlso'>mysql_list_tables()</a> - List tables in a MySQL database</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="mysql_field_seek" value="<div id='function.mysql-field-seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-field-seek.php'>mysql_field_seek</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_field_seek</span> &amp;mdash; <span class='dc-title'>Set result pointer to a specified field offset</span></p> </div> <a name='function.mysql-field-seek.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>mysql_field_seek</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_offset</tt></span> )</div> <p class='para rdfs-comment'> Seeks to the specified field offset. If the next call to <a href='http://www.php.net/manual/en/function.mysql-fetch-field.php' class='function'>mysql_fetch_field()</a> doesn&amp;#039;t include a field offset, the field offset specified in <b>mysql_field_seek()</b> will be returned. </p> </div> <a name='function.mysql-field-seek.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> field_offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The numerical field offset. The <i><tt class='parameter'>field_offset</tt></i> starts at <i>0</i>. If <i><tt class='parameter'>field_offset</tt></i> does not exist, an error of level <b><tt class='constant'>E_WARNING</tt></b> is also issued.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-field-seek.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.mysql-field-seek.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.mysql-fetch-field.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_field()</a> - Get column information from a result and return as an object</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="mysql_field_name" value="<div id='function.mysql-field-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-field-name.php'>mysql_field_name</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_field_name</span> &amp;mdash; <span class='dc-title'>Get the name of the specified field in a result</span></p> </div> <a name='function.mysql-field-name.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>mysql_field_name</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_offset</tt></span> )</div> <p class='para rdfs-comment'> <b>mysql_field_name()</b> returns the name of the specified field index. </p> </div> <a name='function.mysql-field-name.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> field_offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The numerical field offset. The <i><tt class='parameter'>field_offset</tt></i> starts at <i>0</i>. If <i><tt class='parameter'>field_offset</tt></i> does not exist, an error of level <b><tt class='constant'>E_WARNING</tt></b> is also issued.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-field-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The name of the specified field index on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-field-name.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_field_name()</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;The&amp;nbsp;users&amp;nbsp;table&amp;nbsp;consists&amp;nbsp;of&amp;nbsp;three&amp;nbsp;fields:<br />*&amp;nbsp;&amp;nbsp;&amp;nbsp;user_id<br />*&amp;nbsp;&amp;nbsp;&amp;nbsp;username<br />*&amp;nbsp;&amp;nbsp;&amp;nbsp;password.<br />*/<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;MySQL&amp;nbsp;server:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>$dbname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$db_selected&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbname</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$db_selected</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;set&amp;nbsp;</span><span style='color: #0000BB'>$dbname</span><span style='color: #DD0000'>:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;users'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</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 />echo&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</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> user_id password </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-field-name.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Field names returned by this function are <em class='emphasis'>case-sensitive</em>.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_fieldname()</b> <br /> </p></blockquote> </div> <a name='function.mysql-field-name.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.mysql-field-type.php' class='function' rel='rdfs-seeAlso'>mysql_field_type()</a> - Get the type of the specified field in a result</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-field-len.php' class='function' rel='rdfs-seeAlso'>mysql_field_len()</a> - Returns the length of the specified field</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="mysql_field_len" value="<div id='function.mysql-field-len' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-field-len.php'>mysql_field_len</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_field_len</span> &amp;mdash; <span class='dc-title'>Returns the length of the specified field</span></p> </div> <a name='function.mysql-field-len.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>mysql_field_len</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_offset</tt></span> )</div> <p class='para rdfs-comment'> <b>mysql_field_len()</b> returns the length of the specified field. </p> </div> <a name='function.mysql-field-len.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> field_offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The numerical field offset. The <i><tt class='parameter'>field_offset</tt></i> starts at <i>0</i>. If <i><tt class='parameter'>field_offset</tt></i> does not exist, an error of level <b><tt class='constant'>E_WARNING</tt></b> is also issued.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-field-len.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The length of the specified field index on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-field-len.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_field_len()</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 />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,email&amp;nbsp;FROM&amp;nbsp;people&amp;nbsp;WHERE&amp;nbsp;id&amp;nbsp;=&amp;nbsp;'42''</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&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;run&amp;nbsp;query:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Will&amp;nbsp;get&amp;nbsp;the&amp;nbsp;length&amp;nbsp;of&amp;nbsp;the&amp;nbsp;id&amp;nbsp;field&amp;nbsp;as&amp;nbsp;specified&amp;nbsp;in&amp;nbsp;the&amp;nbsp;database<br />//&amp;nbsp;schema.&amp;nbsp;<br /></span><span style='color: #0000BB'>$length&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_len</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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'>$length</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.mysql-field-len.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_fieldlen()</b> <br /> </p></blockquote> </div> <a name='function.mysql-field-len.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.mysql-fetch-lengths.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_lengths()</a> - Get the length of each output in a result</li> <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> </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="mysql_field_flags" value="<div id='function.mysql-field-flags' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-field-flags.php'>mysql_field_flags</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_field_flags</span> &amp;mdash; <span class='dc-title'>Get the flags associated with the specified field in a result</span></p> </div> <a name='function.mysql-field-flags.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>mysql_field_flags</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_offset</tt></span> )</div> <p class='para rdfs-comment'> <b>mysql_field_flags()</b> returns the field flags of the specified field. The flags are reported as a single word per flag separated by a single space, so that you can split the returned value using <a href='http://www.php.net/manual/en/function.explode.php' class='function'>explode()</a>. </p> </div> <a name='function.mysql-field-flags.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> field_offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The numerical field offset. The <i><tt class='parameter'>field_offset</tt></i> starts at <i>0</i>. If <i><tt class='parameter'>field_offset</tt></i> does not exist, an error of level <b><tt class='constant'>E_WARNING</tt></b> is also issued.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-field-flags.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string of flags associated with the result, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The following flags are reported, if your version of MySQL is current enough to support them: <i>&amp;quot;not_null&amp;quot;</i>, <i>&amp;quot;primary_key&amp;quot;</i>, <i>&amp;quot;unique_key&amp;quot;</i>, <i>&amp;quot;multiple_key&amp;quot;</i>, <i>&amp;quot;blob&amp;quot;</i>, <i>&amp;quot;unsigned&amp;quot;</i>, <i>&amp;quot;zerofill&amp;quot;</i>, <i>&amp;quot;binary&amp;quot;</i>, <i>&amp;quot;enum&amp;quot;</i>, <i>&amp;quot;auto_increment&amp;quot;</i> and <i>&amp;quot;timestamp&amp;quot;</i>. </p> </div> <a name='function.mysql-field-flags.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>mysql_field_flags()</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 />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,email&amp;nbsp;FROM&amp;nbsp;people&amp;nbsp;WHERE&amp;nbsp;id&amp;nbsp;=&amp;nbsp;'42''</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&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;run&amp;nbsp;query:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #0000BB'>$flags&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_field_flags</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$flags</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>explode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$flags</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> not_null primary_key auto_increment Array ( [0] =&amp;gt; not_null [1] =&amp;gt; primary_key [2] =&amp;gt; auto_increment ) </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-field-flags.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_fieldflags()</b> <br /> </p></blockquote> </div> <a name='function.mysql-field-flags.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.mysql-field-type.php' class='function' rel='rdfs-seeAlso'>mysql_field_type()</a> - Get the type of the specified field in a result</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-field-len.php' class='function' rel='rdfs-seeAlso'>mysql_field_len()</a> - Returns the length of the specified field</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="mysql_fetch_row" value="<div id='function.mysql-fetch-row' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-fetch-row.php'>mysql_fetch_row</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_fetch_row</span> &amp;mdash; <span class='dc-title'>Get a result row as an enumerated array</span></p> </div> <a name='function.mysql-fetch-row.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>mysql_fetch_row</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Returns a numerical array that corresponds to the fetched row and moves the internal data pointer ahead. </p> </div> <a name='function.mysql-fetch-row.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-fetch-row.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an numerical array of strings that corresponds to the fetched row, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> <p class='para'> <b>mysql_fetch_row()</b> fetches one row of data from the result associated with the specified result identifier. The row is returned as an array. Each result column is stored in an array offset, starting at offset 0. </p> </div> <a name='function.mysql-fetch-row.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Fetching one row with <b>mysql_fetch_row()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,email&amp;nbsp;FROM&amp;nbsp;people&amp;nbsp;WHERE&amp;nbsp;id&amp;nbsp;=&amp;nbsp;'42''</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&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;run&amp;nbsp;query:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>];&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;42<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>$row</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;the&amp;nbsp;email&amp;nbsp;value<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mysql-fetch-row.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.mysql-fetch-row.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.mysql-fetch-array.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_array()</a> - Fetch a result row as an associative array, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_assoc()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-object.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_object()</a> - Fetch a result row as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-data-seek.php' class='function' rel='rdfs-seeAlso'>mysql_data_seek()</a> - Move internal result pointer</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-lengths.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_lengths()</a> - Get the length of each output in a result</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-result.php' class='function' rel='rdfs-seeAlso'>mysql_result()</a> - Get result data</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="mysql_fetch_object" value="<div id='function.mysql-fetch-object' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-fetch-object.php'>mysql_fetch_object</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_fetch_object</span> &amp;mdash; <span class='dc-title'>Fetch a result row as an object</span></p> </div> <a name='function.mysql-fetch-object.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>mysql_fetch_object</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$class_name</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$params</tt></span> ]] )</div> <p class='para rdfs-comment'> Returns an object with properties that correspond to the fetched row and moves the internal data pointer ahead. </p> </div> <a name='function.mysql-fetch-object.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>class_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the class to instantiate, set the properties of and return. If not specified, a <b class='classname'>stdClass</b> object is returned. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>params</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> of parameters to pass to the constructor for <i><tt class='parameter'>class_name</tt></i> objects. </p> </dd> </dl> <p> </p> </div> <a name='function.mysql-fetch-object.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.object.php' class='type object'>object</a> with string properties that correspond to the fetched row, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> <p class='para'> <a href='http://www.php.net/manual/en/function.mysql-fetch-row.php' class='function'>mysql_fetch_row()</a> fetches one row of data from the result associated with the specified result identifier. The row is returned as an array. Each result column is stored in an array offset, starting at offset 0. </p> </div> <a name='function.mysql-fetch-object.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'> Added the ability to return as a different object. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mysql-fetch-object.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_fetch_object()</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 />mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'hostname'</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 /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;mytable'</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>user_id</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fullname</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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>mysql_fetch_object()</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'>class&amp;nbsp;</span><span style='color: #0000BB'>foo&amp;nbsp;</span><span style='color: #007700'>{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;public&amp;nbsp;</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'hostname'</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 /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'select&amp;nbsp;name&amp;nbsp;from&amp;nbsp;mytable&amp;nbsp;limit&amp;nbsp;1'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'foo'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$obj</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.mysql-fetch-object.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>Performance</b><br /> Speed-wise, the function is identical to <a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function'>mysql_fetch_array()</a>, and almost as quick as <a href='http://www.php.net/manual/en/function.mysql-fetch-row.php' class='function'>mysql_fetch_row()</a> (the difference is insignificant). <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <b>mysql_fetch_object()</b> is similar to <a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function'>mysql_fetch_array()</a>, with one difference - an object is returned, instead of an array. Indirectly, that means that you can only access the data by the field names, and not by their offsets (numbers are illegal property names). <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Field names returned by this function are <em class='emphasis'>case-sensitive</em>.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.mysql-fetch-object.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.mysql-fetch-array.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_array()</a> - Fetch a result row as an associative array, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_assoc()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-row.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_row()</a> - Get a result row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-data-seek.php' class='function' rel='rdfs-seeAlso'>mysql_data_seek()</a> - Move internal result pointer</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</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="mysql_fetch_lengths" value="<div id='function.mysql-fetch-lengths' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-fetch-lengths.php'>mysql_fetch_lengths</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_fetch_lengths</span> &amp;mdash; <span class='dc-title'>Get the length of each output in a result</span></p> </div> <a name='function.mysql-fetch-lengths.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>mysql_fetch_lengths</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Returns an array that corresponds to the lengths of each field in the last row fetched by MySQL. </p> <p class='para'> <b>mysql_fetch_lengths()</b> stores the lengths of each result column in the last row returned by <a href='http://www.php.net/manual/en/function.mysql-fetch-row.php' class='function'>mysql_fetch_row()</a>, <a href='http://www.php.net/manual/en/function.mysql-fetch-assoc.php' class='function'>mysql_fetch_assoc()</a>, <a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function'>mysql_fetch_array()</a>, and <a href='http://www.php.net/manual/en/function.mysql-fetch-object.php' class='function'>mysql_fetch_object()</a> in an array, starting at offset 0. </p> </div> <a name='function.mysql-fetch-lengths.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-fetch-lengths.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 lengths on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-fetch-lengths.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>mysql_fetch_lengths()</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 />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,email&amp;nbsp;FROM&amp;nbsp;people&amp;nbsp;WHERE&amp;nbsp;id&amp;nbsp;=&amp;nbsp;'42''</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&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;run&amp;nbsp;query:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #0000BB'>$row&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$lengths&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_lengths</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$lengths</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 ( [id] =&amp;gt; 42 [email] =&amp;gt; user@example.com ) Array ( [0] =&amp;gt; 2 [1] =&amp;gt; 16 ) </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-fetch-lengths.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.mysql-field-len.php' class='function' rel='rdfs-seeAlso'>mysql_field_len()</a> - Returns the length of the specified field</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-row.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_row()</a> - Get a result row as an enumerated array</li> <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> </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="mysql_fetch_field" value="<div id='function.mysql-fetch-field' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-fetch-field.php'>mysql_fetch_field</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_fetch_field</span> &amp;mdash; <span class='dc-title'>Get column information from a result and return as an object</span></p> </div> <a name='function.mysql-fetch-field.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>mysql_fetch_field</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_offset</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Returns an object containing field information. This function can be used to obtain information about fields in the provided query result. </p> </div> <a name='function.mysql-fetch-field.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The numerical field offset. If the field offset is not specified, the next field that was not yet retrieved by this function is retrieved. The <i><tt class='parameter'>field_offset</tt></i> starts at <i>0</i>. </p> </dd> </dl> <p> </p> </div> <a name='function.mysql-fetch-field.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.object.php' class='type object'>object</a> containing field information. The properties of the object are: </p> <p class='para'> </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> name - column name </span> </li> <li class='listitem'> <span class='simpara'> table - name of the table the column belongs to </span> </li> <li class='listitem'> <span class='simpara'> def - default value of the column </span> </li> <li class='listitem'> <span class='simpara'> max_length - maximum length of the column </span> </li> <li class='listitem'> <span class='simpara'> not_null - 1 if the column cannot be <b><tt class='constant'>NULL</tt></b> </span> </li> <li class='listitem'> <span class='simpara'> primary_key - 1 if the column is a primary key </span> </li> <li class='listitem'> <span class='simpara'> unique_key - 1 if the column is a unique key </span> </li> <li class='listitem'> <span class='simpara'> multiple_key - 1 if the column is a non-unique key </span> </li> <li class='listitem'> <span class='simpara'> numeric - 1 if the column is numeric </span> </li> <li class='listitem'> <span class='simpara'> blob - 1 if the column is a BLOB </span> </li> <li class='listitem'> <span class='simpara'> type - the type of the column </span> </li> <li class='listitem'> <span class='simpara'> unsigned - 1 if the column is unsigned </span> </li> <li class='listitem'> <span class='simpara'> zerofill - 1 if the column is zero-filled </span> </li> </ul><p> </p> </div> <a name='function.mysql-fetch-field.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_fetch_field()</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 />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'database'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;table'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Query&amp;nbsp;failed:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #FF8000'>/*&amp;nbsp;get&amp;nbsp;column&amp;nbsp;metadata&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>mysql_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Information&amp;nbsp;for&amp;nbsp;column&amp;nbsp;</span><span style='color: #0000BB'>$i</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;</span><span style='color: #0000BB'>$meta&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_field</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(!</span><span style='color: #0000BB'>$meta</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'>'No&amp;nbsp;information&amp;nbsp;available&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;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;pre&amp;gt;<br />blob:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>blob</span><span style='color: #DD0000'><br />max_length:&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length</span><span style='color: #DD0000'><br />multiple_key:&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>multiple_key</span><span style='color: #DD0000'><br />name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</span><span style='color: #DD0000'><br />not_null:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>not_null</span><span style='color: #DD0000'><br />numeric:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>numeric</span><span style='color: #DD0000'><br />primary_key:&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>primary_key</span><span style='color: #DD0000'><br />table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>table</span><span style='color: #DD0000'><br />type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</span><span style='color: #DD0000'><br />default:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>def</span><span style='color: #DD0000'><br />unique_key:&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>unique_key</span><span style='color: #DD0000'><br />unsigned:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>unsigned</span><span style='color: #DD0000'><br />zerofill:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>zerofill</span><span style='color: #DD0000'><br />&amp;lt;/pre&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++;<br />}<br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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.mysql-fetch-field.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Field names returned by this function are <em class='emphasis'>case-sensitive</em>.</span></p></blockquote> </div> <a name='function.mysql-fetch-field.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.mysql-field-seek.php' class='function' rel='rdfs-seeAlso'>mysql_field_seek()</a> - Set result pointer to a specified field offset</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="mysql_fetch_assoc" value="<div id='function.mysql-fetch-assoc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-fetch-assoc.php'>mysql_fetch_assoc</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.3, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_fetch_assoc</span> &amp;mdash; <span class='dc-title'>Fetch a result row as an associative array</span></p> </div> <a name='function.mysql-fetch-assoc.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>mysql_fetch_assoc</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Returns an associative array that corresponds to the fetched row and moves the internal data pointer ahead. <b>mysql_fetch_assoc()</b> is equivalent to calling <a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function'>mysql_fetch_array()</a> with MYSQL_ASSOC for the optional second parameter. It only returns an associative array. </p> </div> <a name='function.mysql-fetch-assoc.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-fetch-assoc.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array of strings that corresponds to the fetched row, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> <p class='para'> If two or more columns of the result have the same field names, the last column will take precedence. To access the other column(s) of the same name, you either need to access the result with numeric indices by using <a href='http://www.php.net/manual/en/function.mysql-fetch-row.php' class='function'>mysql_fetch_row()</a> or add alias names. See the example at the <a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function'>mysql_fetch_array()</a> description about aliases. </p> </div> <a name='function.mysql-fetch-assoc.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 An expanded <b>mysql_fetch_assoc()</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 />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</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;connect&amp;nbsp;to&amp;nbsp;DB:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br />&amp;nbsp;&amp;nbsp;<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydbname'</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;select&amp;nbsp;mydbname:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id&amp;nbsp;as&amp;nbsp;userid,&amp;nbsp;fullname,&amp;nbsp;userstatus&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;FROM&amp;nbsp;&amp;nbsp;&amp;nbsp;sometable<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;WHERE&amp;nbsp;&amp;nbsp;userstatus&amp;nbsp;=&amp;nbsp;1'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&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;successfully&amp;nbsp;run&amp;nbsp;query&amp;nbsp;(</span><span style='color: #0000BB'>$sql</span><span style='color: #DD0000'>)&amp;nbsp;from&amp;nbsp;DB:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>mysql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;==&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'>'No&amp;nbsp;rows&amp;nbsp;found,&amp;nbsp;nothing&amp;nbsp;to&amp;nbsp;print&amp;nbsp;so&amp;nbsp;am&amp;nbsp;exiting'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;While&amp;nbsp;a&amp;nbsp;row&amp;nbsp;of&amp;nbsp;data&amp;nbsp;exists,&amp;nbsp;put&amp;nbsp;that&amp;nbsp;row&amp;nbsp;in&amp;nbsp;$row&amp;nbsp;as&amp;nbsp;an&amp;nbsp;associative&amp;nbsp;array<br />//&amp;nbsp;Note:&amp;nbsp;If&amp;nbsp;you're&amp;nbsp;expecting&amp;nbsp;just&amp;nbsp;one&amp;nbsp;row,&amp;nbsp;no&amp;nbsp;need&amp;nbsp;to&amp;nbsp;use&amp;nbsp;a&amp;nbsp;loop<br />//&amp;nbsp;Note:&amp;nbsp;If&amp;nbsp;you&amp;nbsp;put&amp;nbsp;extract($row);&amp;nbsp;inside&amp;nbsp;the&amp;nbsp;following&amp;nbsp;loop,&amp;nbsp;you'll<br />//&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;then&amp;nbsp;create&amp;nbsp;$userid,&amp;nbsp;$fullname,&amp;nbsp;and&amp;nbsp;$userstatus<br /></span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'userid'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'fullname'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'userstatus'</span><span style='color: #007700'>];<br />}<br /><br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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.mysql-fetch-assoc.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>Performance</b><br /> An important thing to note is that using <b>mysql_fetch_assoc()</b> is <em class='emphasis'>not significantly</em> slower than using <a href='http://www.php.net/manual/en/function.mysql-fetch-row.php' class='function'>mysql_fetch_row()</a>, while it provides a significant added value. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Field names returned by this function are <em class='emphasis'>case-sensitive</em>.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.mysql-fetch-assoc.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.mysql-fetch-row.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_row()</a> - Get a result row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_array()</a> - Fetch a result row as an associative array, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-data-seek.php' class='function' rel='rdfs-seeAlso'>mysql_data_seek()</a> - Move internal result pointer</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-error.php' class='function' rel='rdfs-seeAlso'>mysql_error()</a> - Returns the text of the error message from previous MySQL operation</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="mysql_fetch_array" value="<div id='function.mysql-fetch-array' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-fetch-array.php'>mysql_fetch_array</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_fetch_array</span> &amp;mdash; <span class='dc-title'>Fetch a result row as an associative array, a numeric array, or both</span></p> </div> <a name='function.mysql-fetch-array.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>mysql_fetch_array</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$result_type</tt><span class='initializer'> = MYSQL_BOTH</span></span> ] )</div> <p class='para rdfs-comment'> Returns an array that corresponds to the fetched row and moves the internal data pointer ahead. </p> </div> <a name='function.mysql-fetch-array.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The type of array that is to be fetched. It&amp;#039;s a constant and can take the following values: <b><tt class='constant'>MYSQL_ASSOC</tt></b>, <b><tt class='constant'>MYSQL_NUM</tt></b>, and the default value of <b><tt class='constant'>MYSQL_BOTH</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.mysql-fetch-array.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of strings that corresponds to the fetched row, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. The type of returned array depends on how <i><tt class='parameter'>result_type</tt></i> is defined. By using <b><tt class='constant'>MYSQL_BOTH</tt></b> (default), you&amp;#039;ll get an array with both associative and number indices. Using <b><tt class='constant'>MYSQL_ASSOC</tt></b>, you only get associative indices (as <a href='http://www.php.net/manual/en/function.mysql-fetch-assoc.php' class='function'>mysql_fetch_assoc()</a> works), using <b><tt class='constant'>MYSQL_NUM</tt></b>, you only get number indices (as <a href='http://www.php.net/manual/en/function.mysql-fetch-row.php' class='function'>mysql_fetch_row()</a> works). </p> <p class='para'> If two or more columns of the result have the same field names, the last column will take precedence. To access the other column(s) of the same name, you must use the numeric index of the column or make an alias for the column. For aliased columns, you cannot access the contents with the original column name. </p> </div> <a name='function.mysql-fetch-array.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Query with aliased duplicate field names</b></p> <div class='example-contents programlisting'> <div class='sqlcode'><pre class='sqlcode'>SELECT table1.field AS foo, table2.field AS bar FROM table1, table2</pre> </div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 <b>mysql_fetch_array()</b> with <b><tt class='constant'>MYSQL_NUM</tt></b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>)&amp;nbsp;or<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name&amp;nbsp;FROM&amp;nbsp;mytable'</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MYSQL_NUM</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ID:&amp;nbsp;%s&amp;nbsp;&amp;nbsp;Name:&amp;nbsp;%s'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]);&amp;nbsp;&amp;nbsp;<br />}<br /><br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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 #3 <b>mysql_fetch_array()</b> with <b><tt class='constant'>MYSQL_ASSOC</tt></b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>)&amp;nbsp;or<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name&amp;nbsp;FROM&amp;nbsp;mytable'</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MYSQL_ASSOC</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ID:&amp;nbsp;%s&amp;nbsp;&amp;nbsp;Name:&amp;nbsp;%s'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'id'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'name'</span><span style='color: #007700'>]);<br />}<br /><br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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 #4 <b>mysql_fetch_array()</b> with <b><tt class='constant'>MYSQL_BOTH</tt></b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>)&amp;nbsp;or<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name&amp;nbsp;FROM&amp;nbsp;mytable'</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MYSQL_BOTH</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ID:&amp;nbsp;%s&amp;nbsp;&amp;nbsp;Name:&amp;nbsp;%s'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'name'</span><span style='color: #007700'>]);<br />}<br /><br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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.mysql-fetch-array.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>Performance</b><br /> An important thing to note is that using <b>mysql_fetch_array()</b> is <em class='emphasis'>not significantly</em> slower than using <a href='http://www.php.net/manual/en/function.mysql-fetch-row.php' class='function'>mysql_fetch_row()</a>, while it provides a significant added value. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Field names returned by this function are <em class='emphasis'>case-sensitive</em>.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.mysql-fetch-array.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.mysql-fetch-row.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_row()</a> - Get a result row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_assoc()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-data-seek.php' class='function' rel='rdfs-seeAlso'>mysql_data_seek()</a> - Move internal result pointer</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</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="mysql_escape_string" value="<div id='function.mysql-escape-string' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-escape-string.php'>mysql_escape_string</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.3, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_escape_string</span> &amp;mdash; <span class='dc-title'>Escapes a string for use in a mysql_query</span></p> </div> <a name='function.mysql-escape-string.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>mysql_escape_string</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$unescaped_string</tt></span> )</div> <p class='para rdfs-comment'> This function will escape the <i><tt class='parameter'>unescaped_string</tt></i> , so that it is safe to place it in a <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>. This function is deprecated. </p> <p class='para'> This function is identical to <a href='http://www.php.net/manual/en/function.mysql-real-escape-string.php' class='function'>mysql_real_escape_string()</a> except that <a href='http://www.php.net/manual/en/function.mysql-real-escape-string.php' class='function'>mysql_real_escape_string()</a> takes a connection handler and escapes the string according to the current character set. <b>mysql_escape_string()</b> does not take a connection argument and does not respect the current charset setting. </p> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> as of PHP 5.3.0 and <em class='emphasis'>REMOVED</em> as of PHP 6.0.0. Relying on this feature is highly discouraged.</p></div> </div> <a name='function.mysql-escape-string.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'>unescaped_string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string that is to be escaped. </p> </dd> </dl> <p> </p> </div> <a name='function.mysql-escape-string.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the escaped string. </p> </div> <a name='function.mysql-escape-string.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.3.0</td> <td align='left'> This function now throws an E_DEPRECATED notice. </td> </tr> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> This function became deprecated, do not use this function. Instead, use <a href='http://www.php.net/manual/en/function.mysql-real-escape-string.php' class='function'>mysql_real_escape_string()</a>. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mysql-escape-string.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_escape_string()</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 />$item&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Zak's&amp;nbsp;Laptop'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$escaped_item&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_escape_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$item</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Escaped&amp;nbsp;string:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$escaped_item</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> Escaped string: Zak\&amp;#039;s Laptop </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-escape-string.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>mysql_escape_string()</b> does not escape <i>%</i> and <i>_</i>. <br /> </p></blockquote> </div> <a name='function.mysql-escape-string.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.mysql-real-escape-string.php' class='function' rel='rdfs-seeAlso'>mysql_real_escape_string()</a> - Escapes special characters in a string for use in a SQL statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.addslashes.php' class='function' rel='rdfs-seeAlso'>addslashes()</a> - Quote string with slashes</li> <li class='member'>The <a href='http://www.php.net/manual/en/info.configuration.php#ini.magic-quotes-gpc' class='link'>magic_quotes_gpc</a> directive.</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="mysql_error" value="<div id='function.mysql-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-error.php'>mysql_error</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_error</span> &amp;mdash; <span class='dc-title'>Returns the text of the error message from previous MySQL operation</span></p> </div> <a name='function.mysql-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>mysql_error</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Returns the error text from the last MySQL function. Errors coming back from the MySQL database backend no longer issue warnings. Instead, use <b>mysql_error()</b> to retrieve the error text. Note that this function only returns the error text from the most recently executed MySQL function (not including <b>mysql_error()</b> and <a href='http://www.php.net/manual/en/function.mysql-errno.php' class='function'>mysql_errno()</a>), so if you want to use it, make sure you check the value before calling another MySQL function. </p> </div> <a name='function.mysql-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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the error text from the last MySQL function, or <i>&amp;#039;&amp;#039;</i> (empty string) if no error occurred. </p> </div> <a name='function.mysql-error.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'nonexistentdb'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>mysql_errno</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>mysql_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'kossu'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;nonexistenttable'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>mysql_errno</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>mysql_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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 something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1049: Unknown database &amp;#039;nonexistentdb&amp;#039; 1146: Table &amp;#039;kossu.nonexistenttable&amp;#039; doesn&amp;#039;t exist </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-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.mysql-errno.php' class='function' rel='rdfs-seeAlso'>mysql_errno()</a> - Returns the numerical value of the error message from previous MySQL operation</li> <li class='member'><a href='http://dev.mysql.com/doc/mysql/en/error-handling.html' class='link external'>&amp;raquo; MySQL error codes</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="mysql_errno" value="<div id='function.mysql-errno' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-errno.php'>mysql_errno</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_errno</span> &amp;mdash; <span class='dc-title'>Returns the numerical value of the error message from previous MySQL operation</span></p> </div> <a name='function.mysql-errno.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>mysql_errno</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Returns the error number from the last MySQL function. </p> <p class='para'> Errors coming back from the MySQL database backend no longer issue warnings. Instead, use <b>mysql_errno()</b> to retrieve the error code. Note that this function only returns the error code from the most recently executed MySQL function (not including <a href='http://www.php.net/manual/en/function.mysql-error.php' class='function'>mysql_error()</a> and <b>mysql_errno()</b>), so if you want to use it, make sure you check the value before calling another MySQL function. </p> </div> <a name='function.mysql-errno.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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-errno.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the error number from the last MySQL function, or <i>0</i> (zero) if no error occurred. </p> </div> <a name='function.mysql-errno.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_errno()</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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'nonexistentdb'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>mysql_errno</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>mysql_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>).&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'kossu'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;nonexistenttable'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>mysql_errno</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>mysql_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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 above example will output something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1049: Unknown database &amp;#039;nonexistentdb&amp;#039; 1146: Table &amp;#039;kossu.nonexistenttable&amp;#039; doesn&amp;#039;t exist </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-errno.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.mysql-error.php' class='function' rel='rdfs-seeAlso'>mysql_error()</a> - Returns the text of the error message from previous MySQL operation</li> <li class='member'><a href='http://dev.mysql.com/doc/mysql/en/error-handling.html' class='link external'>&amp;raquo; MySQL error codes</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="mysql_db_query" value="<div id='function.mysql-db-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-db-query.php'>mysql_db_query</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_db_query</span> &amp;mdash; <span class='dc-title'>Send a MySQL query</span></p> </div> <a name='function.mysql-db-query.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>mysql_db_query</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$database</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> <b>mysql_db_query()</b> selects a database, and executes a query on it. </p> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> as of PHP 5.3.0 and <em class='emphasis'>REMOVED</em> as of PHP 6.0.0. Relying on this feature is highly discouraged.</p></div> </div> <a name='function.mysql-db-query.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'>database</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the database that will be selected. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The MySQL query. </p> <p class='para'> Data inside the query should be <a href='http://www.php.net/manual/en/function.mysql-real-escape-string.php' class='link'>properly escaped</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-db-query.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a positive MySQL result resource to the query result, or <b><tt class='constant'>FALSE</tt></b> on error. The function also returns <b><tt class='constant'>TRUE</tt></b>/<b><tt class='constant'>FALSE</tt></b> for <i>INSERT</i>/<i>UPDATE</i>/<i>DELETE</i> queries to indicate success/failure. </p> </div> <a name='function.mysql-db-query.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.3.0</td> <td align='left'> This function now throws an E_DEPRECATED notice. </td> </tr> <tr valign='middle'> <td align='left'>4.0.6</td> <td align='left'> This function is deprecated, do not use this function. Use <a href='http://www.php.net/manual/en/function.mysql-select-db.php' class='function'>mysql_select_db()</a> and <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a> instead. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mysql-db-query.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_db_query()</b> alternative 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'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mysql_host'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>))&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;connect&amp;nbsp;to&amp;nbsp;mysql'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mysql_dbname'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>))&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;select&amp;nbsp;database'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$sql&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;foo&amp;nbsp;FROM&amp;nbsp;bar&amp;nbsp;WHERE&amp;nbsp;id&amp;nbsp;=&amp;nbsp;42'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DB&amp;nbsp;Error,&amp;nbsp;could&amp;nbsp;not&amp;nbsp;query&amp;nbsp;the&amp;nbsp;database\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MySQL&amp;nbsp;Error:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'foo'</span><span style='color: #007700'>];<br />}<br /><br /></span><span style='color: #0000BB'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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.mysql-db-query.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Be aware that this function does <em class='emphasis'>NOT</em> switch back to the database you were connected before. In other words, you can&amp;#039;t use this function to <em class='emphasis'>temporarily</em> run a sql query on another database, you would have to manually switch back. Users are strongly encouraged to use the <i>database.table</i> syntax in their sql queries or <a href='http://www.php.net/manual/en/function.mysql-select-db.php' class='function'>mysql_select_db()</a> instead of this function. <br /> </p></blockquote> </div> <a name='function.mysql-db-query.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.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-select-db.php' class='function' rel='rdfs-seeAlso'>mysql_select_db()</a> - Select a MySQL database</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="mysql_db_name" value="<div id='function.mysql-db-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-db-name.php'>mysql_db_name</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_db_name</span> &amp;mdash; <span class='dc-title'>Get result data</span></p> </div> <a name='function.mysql-db-name.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>mysql_db_name</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$row</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'>$field</tt></span> ] )</div> <p class='para rdfs-comment'> Retrieve the database name from a call to <a href='http://www.php.net/manual/en/function.mysql-list-dbs.php' class='function'>mysql_list_dbs()</a>. </p> </div> <a name='function.mysql-db-name.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'>result</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result pointer from a call to <a href='http://www.php.net/manual/en/function.mysql-list-dbs.php' class='function'>mysql_list_dbs()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The index into the result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field name. </p> </dd> </dl> <p> </p> </div> <a name='function.mysql-db-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the database name on success, and <b><tt class='constant'>FALSE</tt></b> on failure. If <b><tt class='constant'>FALSE</tt></b> is returned, use <a href='http://www.php.net/manual/en/function.mysql-error.php' class='function'>mysql_error()</a> to determine the nature of the error. </p> </div> <a name='function.mysql-db-name.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_db_name()</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</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbhost'</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 /></span><span style='color: #0000BB'>$db_list&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_list_dbs</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$i&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'>$cnt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db_list</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>$cnt</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>mysql_db_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db_list</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</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;</span><span style='color: #0000BB'>$i</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.mysql-db-name.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: For backward compatibility, the following deprecated alias may be used: <b>mysql_dbname()</b> <br /> </p></blockquote> </div> <a name='function.mysql-db-name.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.mysql-list-dbs.php' class='function' rel='rdfs-seeAlso'>mysql_list_dbs()</a> - List databases available on a MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-tablename.php' class='function' rel='rdfs-seeAlso'>mysql_tablename()</a> - Get table name of field</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="mysql_data_seek" value="<div id='function.mysql-data-seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-data-seek.php'>mysql_data_seek</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_data_seek</span> &amp;mdash; <span class='dc-title'>Move internal result pointer</span></p> </div> <a name='function.mysql-data-seek.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>mysql_data_seek</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$row_number</tt></span> )</div> <p class='para rdfs-comment'> <b>mysql_data_seek()</b> moves the internal row pointer of the MySQL result associated with the specified result identifier to point to the specified row number. The next call to a MySQL fetch function, such as <a href='http://www.php.net/manual/en/function.mysql-fetch-assoc.php' class='function'>mysql_fetch_assoc()</a>, would return that row. </p> <p class='para'> <i><tt class='parameter'>row_number</tt></i> starts at 0. The <i><tt class='parameter'>row_number</tt></i> should be a value in the range from 0 to <a href='http://www.php.net/manual/en/function.mysql-num-rows.php' class='function'>mysql_num_rows()</a> - 1. However if the result set is empty (<a href='http://www.php.net/manual/en/function.mysql-num-rows.php' class='function'>mysql_num_rows()</a> == 0), a seek to 0 will fail with a <a href='http://www.php.net/manual/en/errorfunc.constants.php#errorfunc.constants.errorlevels.e-warning' class='link'>E_WARNING</a> and <b>mysql_data_seek()</b> will return <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mysql-data-seek.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> that is being evaluated. This result comes from a call to <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The desired row number of the new result pointer. </p> </dd> </dl> <p> </p> </div> <a name='function.mysql-data-seek.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.mysql-data-seek.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_data_seek()</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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>$db_selected&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'sample_db'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$db_selected</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;select&amp;nbsp;database:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;last_name,&amp;nbsp;first_name&amp;nbsp;FROM&amp;nbsp;friends'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Query&amp;nbsp;failed:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;rows&amp;nbsp;in&amp;nbsp;reverse&amp;nbsp;order&amp;nbsp;*/<br /></span><span style='color: #007700'>for&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;gt;=&amp;nbsp;</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;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(!</span><span style='color: #0000BB'>mysql_data_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Cannot&amp;nbsp;seek&amp;nbsp;to&amp;nbsp;row&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #DD0000'>:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</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;continue;<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'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;continue;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'last_name'</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'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'first_name'</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'>mysql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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.mysql-data-seek.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The function <b>mysql_data_seek()</b> can be used in conjunction only with <a href='http://www.php.net/manual/en/function.mysql-query.php' class='function'>mysql_query()</a>, not with <a href='http://www.php.net/manual/en/function.mysql-unbuffered-query.php' class='function'>mysql_unbuffered_query()</a>. <br /> </p></blockquote> </div> <a name='function.mysql-data-seek.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.mysql-query.php' class='function' rel='rdfs-seeAlso'>mysql_query()</a> - Send a MySQL query</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-num-rows.php' class='function' rel='rdfs-seeAlso'>mysql_num_rows()</a> - Get number of rows in result</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-row.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_row()</a> - Get a result row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_assoc()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-array.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_array()</a> - Fetch a result row as an associative array, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-fetch-object.php' class='function' rel='rdfs-seeAlso'>mysql_fetch_object()</a> - Fetch a result row as an object</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="mysql_connect" value="<div id='function.mysql-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-connect.php'>mysql_connect</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_connect</span> &amp;mdash; <span class='dc-title'>Open a connection to a MySQL Server</span></p> </div> <a name='function.mysql-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>mysql_connect</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$server</tt><span class='initializer'> = ini_get(&amp;quot;mysql.default_host&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt><span class='initializer'> = ini_get(&amp;quot;mysql.default_user&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt><span class='initializer'> = ini_get(&amp;quot;mysql.default_password&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$new_link</tt><span class='initializer'> = false</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$client_flags</tt><span class='initializer'> = 0</span></span> ]]]]] )</div> <p class='para rdfs-comment'> Opens or reuses a connection to a MySQL server. </p> </div> <a name='function.mysql-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'>server</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The MySQL server. It can also include a port number. e.g. &amp;quot;hostname:port&amp;quot; or a path to a local socket e.g. &amp;quot;:/path/to/socket&amp;quot; for the localhost. </p> <p class='para'> If the PHP directive <a href='http://www.php.net/manual/en/mysql.configuration.php#ini.mysql.default-host' class='link'> mysql.default_host</a> is undefined (default), then the default value is &amp;#039;localhost:3306&amp;#039;. In <a href='http://www.php.net/manual/en/ini.core.php#ini.sql.safe-mode' class='link'>SQL safe mode</a>, this parameter is ignored and value &amp;#039;localhost:3306&amp;#039; is always used. </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. Default value is defined by <a href='http://www.php.net/manual/en/mysql.configuration.php#ini.mysql.default-user' class='link'>mysql.default_user</a>. In <a href='http://www.php.net/manual/en/ini.core.php#ini.sql.safe-mode' class='link'>SQL safe mode</a>, this parameter is ignored and the name of the user that owns the server process is used. </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. Default value is defined by <a href='http://www.php.net/manual/en/mysql.configuration.php#ini.mysql.default-password' class='link'>mysql.default_password</a>. In <a href='http://www.php.net/manual/en/ini.core.php#ini.sql.safe-mode' class='link'>SQL safe mode</a>, this parameter is ignored and empty password is used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>new_link</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If a second call is made to <b>mysql_connect()</b> with the same arguments, no new link will be established, but instead, the link identifier of the already opened link will be returned. The <i><tt class='parameter'>new_link</tt></i> parameter modifies this behavior and makes <b>mysql_connect()</b> always open a new link, even if <b>mysql_connect()</b> was called before with the same parameters. In <a href='http://www.php.net/manual/en/ini.core.php#ini.sql.safe-mode' class='link'>SQL safe mode</a>, this parameter is ignored. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>client_flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>client_flags</tt></i> parameter can be a combination of the following constants: 128 (enable <i>LOAD DATA LOCAL</i> handling), <b><tt class='constant'>MYSQL_CLIENT_SSL</tt></b>, <b><tt class='constant'>MYSQL_CLIENT_COMPRESS</tt></b>, <b><tt class='constant'>MYSQL_CLIENT_IGNORE_SPACE</tt></b> or <b><tt class='constant'>MYSQL_CLIENT_INTERACTIVE</tt></b>. Read the section about <a href='http://www.php.net/manual/en/mysql.constants.php' class='xref'>Predefined Constants</a> for further information. In <a href='http://www.php.net/manual/en/ini.core.php#ini.sql.safe-mode' class='link'>SQL safe mode</a>, this parameter is ignored. </p> </dd> </dl> <p> </p> </div> <a name='function.mysql-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a MySQL link identifier on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mysql-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.3.0</td> <td align='left'> Added the <i><tt class='parameter'>client_flags</tt></i> parameter. </td> </tr> <tr valign='middle'> <td align='left'>4.2.0</td> <td align='left'> Added the <i><tt class='parameter'>new_link</tt></i> parameter. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mysql-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Connected&amp;nbsp;successfully'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>mysql_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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>mysql_connect()</b> example using <i>hostname:port</i> syntax</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;we&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;example.com&amp;nbsp;and&amp;nbsp;port&amp;nbsp;3307<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'example.com:3307'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Connected&amp;nbsp;successfully'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>mysql_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;we&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;localhost&amp;nbsp;at&amp;nbsp;port&amp;nbsp;3307<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'127.0.0.1:3307'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Connected&amp;nbsp;successfully'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>mysql_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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 #3 <b>mysql_connect()</b> example using &amp;quot;:/path/to/socket&amp;quot; syntax</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;we&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;localhost&amp;nbsp;and&amp;nbsp;socket&amp;nbsp;e.g.&amp;nbsp;/tmp/mysql.sock<br /><br />//variant&amp;nbsp;1:&amp;nbsp;ommit&amp;nbsp;localhost<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>':/tmp/mysql'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Connected&amp;nbsp;successfully'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>mysql_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;variant&amp;nbsp;2:&amp;nbsp;with&amp;nbsp;localhost<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost:/tmp/mysql.sock'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Connected&amp;nbsp;successfully'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>mysql_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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.mysql-connect.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Whenever you specify &amp;quot;localhost&amp;quot; or &amp;quot;localhost:port&amp;quot; as server, the MySQL client library will override this and try to connect to a local socket (named pipe on Windows). If you want to use TCP/IP, use &amp;quot;127.0.0.1&amp;quot; instead of &amp;quot;localhost&amp;quot;. If the MySQL client library tries to connect to the wrong local socket, you should set the correct path as <a href='http://www.php.net/manual/en/mysql.configuration.php' class='xref'>Runtime Configuration</a> in your PHP configuration and leave the server field blank. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: The link to the server will be closed as soon as the execution of the script ends, unless it&amp;#039;s closed earlier by explicitly calling <a href='http://www.php.net/manual/en/function.mysql-close.php' class='function'>mysql_close()</a>. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: You can suppress the error message on failure by prepending a <a href='http://www.php.net/manual/en/language.operators.errorcontrol.php' class='link'>@</a> to the function name. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: Error &amp;quot;Can&amp;#039;t create TCP/IP socket (10106)&amp;quot; usually means that the <a href='http://www.php.net/manual/en/ini.core.php#ini.variables-order' class='link'>variables_order</a> configure directive doesn&amp;#039;t contain character <i>E</i>. On Windows, if the environment is not copied the <i>SYSTEMROOT</i> environment variable won&amp;#039;t be available and PHP will have problems loading Winsock. <br /> </p></blockquote> </div> <a name='function.mysql-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.mysql-pconnect.php' class='function' rel='rdfs-seeAlso'>mysql_pconnect()</a> - Open a persistent connection to a MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-close.php' class='function' rel='rdfs-seeAlso'>mysql_close()</a> - Close MySQL 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="mysql_close" value="<div id='function.mysql-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-close.php'>mysql_close</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_close</span> &amp;mdash; <span class='dc-title'>Close MySQL connection</span></p> </div> <a name='function.mysql-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>mysql_close</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> <b>mysql_close()</b> closes the non-persistent connection to the MySQL server that&amp;#039;s associated with the specified link identifier. If <i><tt class='parameter'>link_identifier</tt></i> isn&amp;#039;t specified, the last opened link is used. </p> <p class='para'> Using <b>mysql_close()</b> isn&amp;#039;t usually necessary, as non-persistent open links are automatically closed at the end of the script&amp;#039;s execution. See also <a href='http://www.php.net/manual/en/language.types.resource.php#language.types.resource.self-destruct' class='link'>freeing resources</a>. </p> </div> <a name='function.mysql-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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-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.mysql-close.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Connected&amp;nbsp;successfully'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>mysql_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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> Connected successfully </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-close.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>mysql_close()</b> will not close persistent links created by <a href='http://www.php.net/manual/en/function.mysql-pconnect.php' class='function'>mysql_pconnect()</a>. <br /> </p></blockquote> </div> <a name='function.mysql-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.mysql-connect.php' class='function' rel='rdfs-seeAlso'>mysql_connect()</a> - Open a connection to a MySQL Server</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-free-result.php' class='function' rel='rdfs-seeAlso'>mysql_free_result()</a> - Free result memory</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="mysql_client_encoding" value="<div id='function.mysql-client-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-client-encoding.php'>mysql_client_encoding</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_client_encoding</span> &amp;mdash; <span class='dc-title'>Returns the name of the character set</span></p> </div> <a name='function.mysql-client-encoding.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>mysql_client_encoding</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Retrieves the <i>character_set</i> variable from MySQL. </p> </div> <a name='function.mysql-client-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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-client-encoding.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the default character set name for the current connection. </p> </div> <a name='function.mysql-client-encoding.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_client_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 />$link&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$charset&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_client_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;current&amp;nbsp;character&amp;nbsp;set&amp;nbsp;is:&amp;nbsp;</span><span style='color: #0000BB'>$charset</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 something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> The current character set is: latin1 </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-client-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.mysql-set-charset.php' class='function' rel='rdfs-seeAlso'>mysql_set_charset()</a> - Sets the client character set</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-real-escape-string.php' class='function' rel='rdfs-seeAlso'>mysql_real_escape_string()</a> - Escapes special characters in a string for use in a SQL statement</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="mysql_affected_rows" value="<div id='function.mysql-affected-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysql-affected-rows.php'>mysql_affected_rows</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mysql_affected_rows</span> &amp;mdash; <span class='dc-title'>Get number of affected rows in previous MySQL operation</span></p> </div> <a name='function.mysql-affected-rows.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>mysql_affected_rows</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Get the number of affected rows by the last INSERT, UPDATE, REPLACE or DELETE query associated with <i><tt class='parameter'>link_identifier</tt></i> . </p> </div> <a name='function.mysql-affected-rows.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'> link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The MySQL connection. If the link identifier is not specified, the last link opened by <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> is assumed. If no such link is found, it will try to create one as if <a href='http://www.php.net/manual/en/function.mysql-connect.php' class='function'>mysql_connect()</a> was called with no arguments. If by chance no connection is found or established, an <b><tt class='constant'>E_WARNING</tt></b> level error is generated.</p></dd> </dl> <p> </p> </div> <a name='function.mysql-affected-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of affected rows on success, and -1 if the last query failed. </p> <p class='para'> If the last query was a DELETE query with no WHERE clause, all of the records will have been deleted from the table but this function will return zero with MySQL versions prior to 4.1.2. </p> <p class='para'> When using UPDATE, MySQL will not update columns where the new value is the same as the old value. This creates the possibility that <b>mysql_affected_rows()</b> may not actually equal the number of rows matched, only the number of rows that were literally affected by the query. </p> <p class='para'> The REPLACE statement first deletes the record with the same primary key and then inserts the new record. This function returns the number of deleted records plus the number of inserted records. </p> </div> <a name='function.mysql-affected-rows.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mysql_affected_rows()</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 />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;this&amp;nbsp;should&amp;nbsp;return&amp;nbsp;the&amp;nbsp;correct&amp;nbsp;numbers&amp;nbsp;of&amp;nbsp;deleted&amp;nbsp;records&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;mytable&amp;nbsp;WHERE&amp;nbsp;id&amp;nbsp;&amp;lt;&amp;nbsp;10'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Records&amp;nbsp;deleted:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysql_affected_rows</span><span style='color: #007700'>());<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;with&amp;nbsp;a&amp;nbsp;where&amp;nbsp;clause&amp;nbsp;that&amp;nbsp;is&amp;nbsp;never&amp;nbsp;true,&amp;nbsp;it&amp;nbsp;should&amp;nbsp;return&amp;nbsp;0&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;mytable&amp;nbsp;WHERE&amp;nbsp;0'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Records&amp;nbsp;deleted:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysql_affected_rows</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> Records deleted: 10 Records deleted: 0 </pre></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 <b>mysql_affected_rows()</b> example using transactions</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_password'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>mysql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mydb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Update&amp;nbsp;records&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'UPDATE&amp;nbsp;mytable&amp;nbsp;SET&amp;nbsp;used=1&amp;nbsp;WHERE&amp;nbsp;id&amp;nbsp;&amp;lt;&amp;nbsp;10'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Updated&amp;nbsp;records:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysql_affected_rows</span><span style='color: #007700'>());<br /></span><span style='color: #0000BB'>mysql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'COMMIT'</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> Updated Records: 10 </pre></div> </div> </div><p> </p> </div> <a name='function.mysql-affected-rows.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>Transactions</b><br /> If you are using transactions, you need to call <b>mysql_affected_rows()</b> after your INSERT, UPDATE, or DELETE query, not after the COMMIT. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <b>SELECT Statements</b><br /> To retrieve the number of rows returned by a SELECT, it is possible to use <a href='http://www.php.net/manual/en/function.mysql-num-rows.php' class='function'>mysql_num_rows()</a>. <br /> </p></blockquote> </div> <a name='function.mysql-affected-rows.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.mysql-num-rows.php' class='function' rel='rdfs-seeAlso'>mysql_num_rows()</a> - Get number of rows in result</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysql-info.php' class='function' rel='rdfs-seeAlso'>mysql_info()</a> - Get information about the most recent query</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="mysqli_warning_count" value="<div id='mysqli.warning-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.warning-count.php'>mysqli::warning_count</a></h1> <h1 class='refname'>mysqli_warning_count</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::warning_count</span> -- <span class='refname'>mysqli_warning_count</span> &amp;mdash; <span class='dc-title'>Returns the number of warnings from the last query for the given link</span></p> </div> <a name='mysqli.warning-count.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$warning_count</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_warning_count</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of warnings from the last query in the connection. </p> <blockquote><p><b class='note'>Note</b>: For retrieving warning messages you can use the SQL command <i>SHOW WARNINGS [limit row_count]</i>. <br /> </p></blockquote> </div> <a name='mysqli.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.warning-count.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Number of warnings or zero if there are no warnings. </p> </div> <a name='mysqli.warning-count.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;a&amp;nbsp;remarkable&amp;nbsp;city&amp;nbsp;in&amp;nbsp;Wales&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCity&amp;nbsp;(CountryCode,&amp;nbsp;Name)&amp;nbsp;VALUES('GBR',<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'Llanfairpwllgwyngyllgogerychwyrndrobwllllantysiliogogogoch')'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>warning_count</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SHOW&amp;nbsp;WARNINGS'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%d):&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</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'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;a&amp;nbsp;remarkable&amp;nbsp;long&amp;nbsp;city&amp;nbsp;name&amp;nbsp;in&amp;nbsp;Wales&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCity&amp;nbsp;(CountryCode,&amp;nbsp;Name)&amp;nbsp;VALUES('GBR',<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'Llanfairpwllgwyngyllgogerychwyrndrobwllllantysiliogogogoch')'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_warning_count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SHOW&amp;nbsp;WARNINGS'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%d):&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</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'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Warning (1264): Data truncated for column &amp;#039;Name&amp;#039; at row 1 </pre></div> </div> </div> <a name='mysqli.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/mysqli.errno.php' class='function' rel='rdfs-seeAlso'>mysqli_errno()</a> - Returns the error code for the most recent function call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.error.php' class='function' rel='rdfs-seeAlso'>mysqli_error()</a> - Returns a string description of the last error</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.sqlstate.php' class='function' rel='rdfs-seeAlso'>mysqli_sqlstate()</a> - Returns the SQLSTATE error from previous MySQL operation</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="mysqli_use_result" value="<div id='mysqli.use-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.use-result.php'>mysqli::use_result</a></h1> <h1 class='refname'>mysqli_use_result</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::use_result</span> -- <span class='refname'>mysqli_use_result</span> &amp;mdash; <span class='dc-title'>Initiate a result set retrieval</span></p> </div> <a name='mysqli.use-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <span class='methodname'><b>mysqli::use_result</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <span class='methodname'><b>mysqli_use_result</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Used to initiate the retrieval of a result set from the last query executed using the <a href='http://www.php.net/manual/en/mysqli.real-query.php' class='function'>mysqli_real_query()</a> function on the database connection. </p> <p class='para'> Either this or the <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> function must be called before the results of a query can be retrieved, and one or the other must be called to prevent the next query on that database connection from failing. </p> <blockquote><p><b class='note'>Note</b>: The <b>mysqli_use_result()</b> function does not transfer the entire result set from the database and hence cannot be used functions such as <a href='http://www.php.net/manual/en/mysqli-result.data-seek.php' class='function'>mysqli_data_seek()</a> to move to a particular row within the set. To use this functionality, the result set must be stored using <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a>. One should not use <b>mysqli_use_result()</b> if a lot of processing on the client side is performed, since this will tie up the server and prevent other threads from updating any tables from which the data is being fetched. <br /> </p></blockquote> </div> <a name='mysqli.use-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an unbuffered result object or <b><tt class='constant'>FALSE</tt></b> if an error occurred. </p> </div> <a name='mysqli.use-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;CURRENT_USER();'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;ID&amp;nbsp;LIMIT&amp;nbsp;20,&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;multi&amp;nbsp;query&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>multi_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;do&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;store&amp;nbsp;first&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>use_result</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;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</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;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</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;}<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'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;divider&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>more_results</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'>printf</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>next_result</span><span style='color: #007700'>());<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;CURRENT_USER();'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;ID&amp;nbsp;LIMIT&amp;nbsp;20,&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;multi&amp;nbsp;query&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_multi_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;do&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;store&amp;nbsp;first&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_use_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</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;}<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'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;divider&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_more_results</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>printf</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_next_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> my_user@localhost ----------------- Amersfoort Maastricht Dordrecht Leiden Haarlemmermeer </pre></div> </div> </div> <a name='mysqli.use-result.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/mysqli.real-query.php' class='function' rel='rdfs-seeAlso'>mysqli_real_query()</a> - Execute an SQL query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_store_result()</a> - Transfers a result set from the last query</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="mysqli_thread_safe" value="<div id='mysqli.thread-safe' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.thread-safe.php'>mysqli::thread_safe</a></h1> <h1 class='refname'>mysqli_thread_safe</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::thread_safe</span> -- <span class='refname'>mysqli_thread_safe</span> &amp;mdash; <span class='dc-title'>Returns whether thread safety is given or not</span></p> </div> <a name='mysqli.thread-safe.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>mysqli_thread_safe</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Tells whether the client library is compiled as thread-safe. </p> </div> <a name='mysqli.thread-safe.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b><tt class='constant'>TRUE</tt></b> if the client library is thread-safe, otherwise <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="mysqli_thread_id" value="<div id='mysqli.thread-id' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.thread-id.php'>mysqli::thread_id</a></h1> <h1 class='refname'>mysqli_thread_id</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::thread_id</span> -- <span class='refname'>mysqli_thread_id</span> &amp;mdash; <span class='dc-title'>Returns the thread ID for the current connection</span></p> </div> <a name='mysqli.thread-id.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$thread_id</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_thread_id</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> The <b>mysqli_thread_id()</b> function returns the thread ID for the current connection which can then be killed using the <a href='http://www.php.net/manual/en/mysqli.kill.php' class='function'>mysqli_kill()</a> function. If the connection is lost and you reconnect with <a href='http://www.php.net/manual/en/mysqli.ping.php' class='function'>mysqli_ping()</a>, the thread ID will be other. Therefore you should get the thread ID only when you need it. </p> <blockquote><p><b class='note'>Note</b>: The thread ID is assigned on a connection-by-connection basis. Hence, if the connection is broken and then re-established a new thread ID will be assigned. <br /> To kill a running query you can use the SQL command <i>KILL QUERY processid</i>. <br /> </p></blockquote> </div> <a name='mysqli.thread-id.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.thread-id.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the Thread ID for the current connection. </p> </div> <a name='mysqli.thread-id.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;determine&amp;nbsp;our&amp;nbsp;thread&amp;nbsp;id&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$thread_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>thread_id</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Kill&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>kill</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$thread_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;This&amp;nbsp;should&amp;nbsp;produce&amp;nbsp;an&amp;nbsp;error&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>error</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;determine&amp;nbsp;our&amp;nbsp;thread&amp;nbsp;id&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$thread_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_thread_id</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Kill&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_kill</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$thread_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;This&amp;nbsp;should&amp;nbsp;produce&amp;nbsp;an&amp;nbsp;error&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Error: MySQL server has gone away </pre></div> </div> </div> <a name='mysqli.thread-id.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/mysqli.kill.php' class='function' rel='rdfs-seeAlso'>mysqli_kill()</a> - Asks the server to kill a MySQL thread</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="mysqli_store_result" value="<div id='mysqli.store-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.store-result.php'>mysqli::store_result</a></h1> <h1 class='refname'>mysqli_store_result</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::store_result</span> -- <span class='refname'>mysqli_store_result</span> &amp;mdash; <span class='dc-title'>Transfers a result set from the last query</span></p> </div> <a name='mysqli.store-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <span class='methodname'><b>mysqli::store_result</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <span class='methodname'><b>mysqli_store_result</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Transfers the result set from the last query on the database connection represented by the <i><tt class='parameter'>link</tt></i> parameter to be used with the <a href='http://www.php.net/manual/en/mysqli-result.data-seek.php' class='function'>mysqli_data_seek()</a> function. </p> </div> <a name='mysqli.store-result.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.store-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a buffered result object or <b><tt class='constant'>FALSE</tt></b> if an error occurred. </p> <blockquote><p><b class='note'>Note</b>: <b>mysqli_store_result()</b> returns <b><tt class='constant'>FALSE</tt></b> in case the query didn&amp;#039;t return a result set (if the query was, for example an INSERT statement). This function also returns <b><tt class='constant'>FALSE</tt></b> if the reading of the result set failed. You can check if you have got an error by checking if <a href='http://www.php.net/manual/en/mysqli.error.php' class='function'>mysqli_error()</a> doesn&amp;#039;t return an empty string, if <a href='http://www.php.net/manual/en/mysqli.errno.php' class='function'>mysqli_errno()</a> returns a non zero value, or if <a href='http://www.php.net/manual/en/mysqli.field-count.php' class='function'>mysqli_field_count()</a> returns a non zero value. Also possible reason for this function returning <b><tt class='constant'>FALSE</tt></b> after successful call to <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a> can be too large result set (memory for it cannot be allocated). If <a href='http://www.php.net/manual/en/mysqli.field-count.php' class='function'>mysqli_field_count()</a> returns a non-zero value, the statement should have produced a non-empty result set. <br /> </p></blockquote> </div> <a name='mysqli.store-result.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Although it is always good practice to free the memory used by the result of a query using the <a href='http://www.php.net/manual/en/mysqli-result.free.php' class='function'>mysqli_free_result()</a> function, when transferring large result sets using the <b>mysqli_store_result()</b> this becomes particularly important. <br /> </p></blockquote> </div> <a name='mysqli.store-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> See <a href='http://www.php.net/manual/en/mysqli.multi-query.php' class='function'>mysqli_multi_query()</a>. </p> </div> <a name='mysqli.store-result.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/mysqli.real-query.php' class='function' rel='rdfs-seeAlso'>mysqli_real_query()</a> - Execute an SQL query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function' rel='rdfs-seeAlso'>mysqli_use_result()</a> - Initiate a result set retrieval</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="mysqli_stmt_store_result" value="<div id='mysqli-stmt.store-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.store-result.php'>mysqli_stmt::store_result</a></h1> <h1 class='refname'>mysqli_stmt_store_result</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::store_result</span> -- <span class='refname'>mysqli_stmt_store_result</span> &amp;mdash; <span class='dc-title'>Transfers a result set from a prepared statement</span></p> </div> <a name='mysqli-stmt.store-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt::store_result</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt_store_result</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> You must call <b>mysqli_stmt_store_result()</b> for every query that successfully produces a result set (<i>SELECT, SHOW, DESCRIBE, EXPLAIN</i>), and only if you want to buffer the complete result set by the client, so that the subsequent <a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function'>mysqli_stmt_fetch()</a> call returns buffered data. </p> <blockquote><p><b class='note'>Note</b>: It is unnecessary to call <b>mysqli_stmt_store_result()</b> for other queries, but if you do, it will not harm or cause any notable performance in all cases. You can detect whether the query produced a result set by checking if <a href='http://www.php.net/manual/en/mysqli-stmt.result-metadata.php' class='function'>mysqli_stmt_result_metadata()</a> returns NULL. <br /> </p></blockquote> </div> <a name='mysqli-stmt.store-result.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.store-result.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='mysqli-stmt.store-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name&amp;nbsp;LIMIT&amp;nbsp;20'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;store&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>store_result</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Number&amp;nbsp;of&amp;nbsp;rows:&amp;nbsp;%d.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>num_rows</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>free_result</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name&amp;nbsp;LIMIT&amp;nbsp;20'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;store&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_store_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Number&amp;nbsp;of&amp;nbsp;rows:&amp;nbsp;%d.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Number of rows: 20. </pre></div> </div> </div> <a name='mysqli-stmt.store-result.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/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.result-metadata.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_result_metadata()</a> - Returns result set metadata from a prepared statement</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_fetch()</a> - Fetch results from a prepared statement into the bound variables</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="mysqli_stmt_sqlstate" value="<div id='mysqli-stmt.sqlstate' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.sqlstate.php'>mysqli_stmt::sqlstate</a></h1> <h1 class='refname'>mysqli_stmt_sqlstate</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::sqlstate</span> -- <span class='refname'>mysqli_stmt_sqlstate</span> &amp;mdash; <span class='dc-title'>Returns SQLSTATE error from previous statement operation</span></p> </div> <a name='mysqli-stmt.sqlstate.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-stmt.php' class='classname'>mysqli_stmt</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$sqlstate</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_stmt_sqlstate</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Returns a string containing the SQLSTATE error code for the most recently invoked prepared statement function that can succeed or fail. The error code consists of five characters. <i>&amp;#039;00000&amp;#039;</i> means no error. The values are specified by ANSI SQL and ODBC. For a list of possible values, see <a href='http://dev.mysql.com/doc/mysql/en/error-handling.html' class='link external'>&amp;raquo; http://dev.mysql.com/doc/mysql/en/error-handling.html</a>. </p> </div> <a name='mysqli-stmt.sqlstate.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.sqlstate.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. <i>&amp;#039;00000&amp;#039;</i> means no error. </p> </div> <a name='mysqli-stmt.sqlstate.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Note that not all MySQL errors are yet mapped to SQLSTATE&amp;#039;s. The value <i>HY000</i> (general error) is used for unmapped errors. <br /> </p></blockquote> </div> <a name='mysqli-stmt.sqlstate.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCountry&amp;nbsp;LIKE&amp;nbsp;Country'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCountry&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;Country'</span><span style='color: #007700'>);<br /><br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;Code&amp;nbsp;FROM&amp;nbsp;myCountry&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;drop&amp;nbsp;table&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCountry'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>sqlstate</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCountry&amp;nbsp;LIKE&amp;nbsp;Country'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCountry&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;Country'</span><span style='color: #007700'>);<br /><br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;Code&amp;nbsp;FROM&amp;nbsp;myCountry&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;drop&amp;nbsp;table&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCountry'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_sqlstate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Error: 42S02. </pre></div> </div> </div> <a name='mysqli-stmt.sqlstate.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/mysqli-stmt.errno.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_errno()</a> - Returns the error code for the most recent statement call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.error.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_error()</a> - Returns a string description for last statement 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="mysqli_stmt_send_long_data" value="<div id='mysqli-stmt.send-long-data' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.send-long-data.php'>mysqli_stmt::send_long_data</a></h1> <h1 class='refname'>mysqli_stmt_send_long_data</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::send_long_data</span> -- <span class='refname'>mysqli_stmt_send_long_data</span> &amp;mdash; <span class='dc-title'>Send data in blocks</span></p> </div> <a name='mysqli-stmt.send-long-data.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method)</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt::send_long_data</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$param_nr</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt_send_long_data</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$param_nr</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> )</div> <p class='para rdfs-comment'> Allows to send parameter data to the server in pieces (or chunks), e.g. if the size of a blob exceeds the size of <i>max_allowed_packet</i>. This function can be called multiple times to send the parts of a character or binary data value for a column, which must be one of the TEXT or BLOB datatypes. </p> </div> <a name='mysqli-stmt.send-long-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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>param_nr</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Indicates which parameter to associate the data with. Parameters are numbered beginning with 0. </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 containing data to be sent. </p> </dd> </dl> <p> </p> </div> <a name='mysqli-stmt.send-long-data.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='mysqli-stmt.send-long-data.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;messages&amp;nbsp;(message)&amp;nbsp;VALUES&amp;nbsp;(?)'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$null&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'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_param</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'b'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$null</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: #DD0000'>'messages.txt'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'r'</span><span style='color: #007700'>);<br />while&amp;nbsp;(!</span><span style='color: #0000BB'>feof</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fp</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>send_long_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0</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'>8192</span><span style='color: #007700'>));<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'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='mysqli-stmt.send-long-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/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_param()</a> - Binds variables to a prepared statement as parameters</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="mysqli_stmt_result_metadata" value="<div id='mysqli-stmt.result-metadata' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.result-metadata.php'>mysqli_stmt::result_metadata</a></h1> <h1 class='refname'>mysqli_stmt_result_metadata</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::result_metadata</span> -- <span class='refname'>mysqli_stmt_result_metadata</span> &amp;mdash; <span class='dc-title'>Returns result set metadata from a prepared statement</span></p> </div> <a name='mysqli-stmt.result-metadata.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <span class='methodname'><b>mysqli_stmt::result_metadata</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <span class='methodname'><b>mysqli_stmt_result_metadata</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> If a statement passed to <a href='http://www.php.net/manual/en/mysqli.prepare.php' class='function'>mysqli_prepare()</a> is one that produces a result set, <b>mysqli_stmt_result_metadata()</b> returns the result object that can be used to process the meta information such as total number of fields and individual field information. </p> <blockquote><p><b class='note'>Note</b>: This result set pointer can be passed as an argument to any of the field-based functions that process result set metadata, such as: </p><ul class='itemizedlist'> <li class='listitem'><p class='para'><a href='http://www.php.net/manual/en/mysqli-result.field-count.php' class='function'>mysqli_num_fields()</a></p></li> <li class='listitem'><p class='para'><a href='http://www.php.net/manual/en/mysqli-result.fetch-field.php' class='function'>mysqli_fetch_field()</a></p></li> <li class='listitem'><p class='para'><a href='http://www.php.net/manual/en/mysqli-result.fetch-field-direct.php' class='function'>mysqli_fetch_field_direct()</a></p></li> <li class='listitem'><p class='para'><a href='http://www.php.net/manual/en/mysqli-result.fetch-fields.php' class='function'>mysqli_fetch_fields()</a></p></li> <li class='listitem'><p class='para'><a href='http://www.php.net/manual/en/mysqli.field-count.php' class='function'>mysqli_field_count()</a></p></li> <li class='listitem'><p class='para'><a href='http://www.php.net/manual/en/mysqli-result.field-seek.php' class='function'>mysqli_field_seek()</a></p></li> <li class='listitem'><p class='para'><a href='http://www.php.net/manual/en/mysqli-result.current-field.php' class='function'>mysqli_field_tell()</a></p></li> <li class='listitem'><p class='para'><a href='http://www.php.net/manual/en/mysqli-result.free.php' class='function'>mysqli_free_result()</a></p></li> </ul><p> <br /> </p></blockquote> <p class='para'> The result set structure should be freed when you are done with it, which you can do by passing it to <a href='http://www.php.net/manual/en/mysqli-result.free.php' class='function'>mysqli_free_result()</a> </p> <blockquote><p><b class='note'>Note</b>: The result set returned by <b>mysqli_stmt_result_metadata()</b> contains only metadata. It does not contain any row results. The rows are obtained by using the statement handle with <a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function'>mysqli_stmt_fetch()</a>. <br /> </p></blockquote> </div> <a name='mysqli-stmt.result-metadata.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.result-metadata.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a result object or <b><tt class='constant'>FALSE</tt></b> if an error occurred. </p> </div> <a name='mysqli-stmt.result-metadata.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;IF&amp;nbsp;EXISTS&amp;nbsp;friends'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;friends&amp;nbsp;(id&amp;nbsp;int,&amp;nbsp;name&amp;nbsp;varchar(20))'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;friends&amp;nbsp;VALUES&amp;nbsp;(1,'Hartmut'),&amp;nbsp;(2,&amp;nbsp;'Ulf')'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name&amp;nbsp;FROM&amp;nbsp;friends'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;get&amp;nbsp;resultset&amp;nbsp;for&amp;nbsp;metadata&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>result_metadata</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;retrieve&amp;nbsp;field&amp;nbsp;information&amp;nbsp;from&amp;nbsp;metadata&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$field&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_field</span><span style='color: #007700'>();<br /><br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Fieldname:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$field</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;resultset&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;IF&amp;nbsp;EXISTS&amp;nbsp;friends'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;friends&amp;nbsp;(id&amp;nbsp;int,&amp;nbsp;name&amp;nbsp;varchar(20))'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;friends&amp;nbsp;VALUES&amp;nbsp;(1,'Hartmut'),&amp;nbsp;(2,&amp;nbsp;'Ulf')'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name&amp;nbsp;FROM&amp;nbsp;friends'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;get&amp;nbsp;resultset&amp;nbsp;for&amp;nbsp;metadata&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_result_metadata</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;retrieve&amp;nbsp;field&amp;nbsp;information&amp;nbsp;from&amp;nbsp;metadata&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$field&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_field</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Fieldname:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$field</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;resultset&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='mysqli-stmt.result-metadata.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/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.free.php' class='function' rel='rdfs-seeAlso'>mysqli_free_result()</a> - Frees the memory associated with a result</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="mysqli_stmt_reset" value="<div id='mysqli-stmt.reset' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.reset.php'>mysqli_stmt::reset</a></h1> <h1 class='refname'>mysqli_stmt_reset</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::reset</span> -- <span class='refname'>mysqli_stmt_reset</span> &amp;mdash; <span class='dc-title'>Resets a prepared statement</span></p> </div> <a name='mysqli-stmt.reset.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt::reset</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt_reset</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Resets a prepared statement on client and server to state after prepare. </p> <p class='para'> It resets the statement on the server, data sent using <a href='http://www.php.net/manual/en/mysqli-stmt.send-long-data.php' class='function'>mysqli_stmt_send_long_data()</a>, unbuffered result sets and current errors. It does not clear bindings or stored result sets. Stored result sets will be cleared when executing the prepared statement (or closing it). </p> <p class='para'> To prepare a statement with another query use function <a href='http://www.php.net/manual/en/mysqli-stmt.prepare.php' class='function'>mysqli_stmt_prepare()</a>. </p> </div> <a name='mysqli-stmt.reset.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.reset.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='mysqli-stmt.reset.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/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</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="mysqli_stmt_prepare" value="<div id='mysqli-stmt.prepare' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.prepare.php'>mysqli_stmt::prepare</a></h1> <h1 class='refname'>mysqli_stmt_prepare</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::prepare</span> -- <span class='refname'>mysqli_stmt_prepare</span> &amp;mdash; <span class='dc-title'>Prepare a SQL statement for execution</span></p> </div> <a name='mysqli-stmt.prepare.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method)</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>mysqli_stmt::prepare</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'>Procedure style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt_prepare</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'> Prepares the SQL query pointed to by the null-terminated string query. </p> <p class='para'> The parameter markers must be bound to application variables using <a href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php' class='function'>mysqli_stmt_bind_param()</a> and/or <a href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php' class='function'>mysqli_stmt_bind_result()</a> before executing the statement or fetching rows. </p> </div> <a name='mysqli-stmt.prepare.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The query, as a string. It must consist of a single SQL statement. </p> <p class='para'> You can include one or more parameter markers in the SQL statement by embedding question mark (<i>?</i>) characters at the appropriate positions. </p> <blockquote><p><b class='note'>Note</b>: You should not add a terminating semicolon or <i>\g</i> to the statement. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: The markers are legal only in certain places in SQL statements. For example, they are allowed in the VALUES() list of an INSERT statement (to specify column values for a row), or in a comparison with a column in a WHERE clause to specify a comparison value. <br /> However, they are not allowed for identifiers (such as table or column names), in the select list that names the columns to be returned by a SELECT statement), or to specify both operands of a binary operator such as the <i>=</i> equal sign. The latter restriction is necessary because it would be impossible to determine the parameter type. In general, parameters are legal only in Data Manipulation Language (DML) statements, and not in Data Definition Language (DDL) statements. <br /> </p></blockquote> </dd> </dl> <p> </p> </div> <a name='mysqli-stmt.prepare.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='mysqli-stmt.prepare.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$city&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Amersfoort'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;create&amp;nbsp;a&amp;nbsp;prepared&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>stmt_init</span><span style='color: #007700'>();<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;District&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;WHERE&amp;nbsp;Name=?'</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;parameters&amp;nbsp;for&amp;nbsp;markers&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_param</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'s'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$city</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;result&amp;nbsp;variables&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$district</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;value&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;is&amp;nbsp;in&amp;nbsp;district&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$city</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$district</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$city&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Amersfoort'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;create&amp;nbsp;a&amp;nbsp;prepared&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_init</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_stmt_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;District&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;WHERE&amp;nbsp;Name=?'</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;parameters&amp;nbsp;for&amp;nbsp;markers&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'s'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$city</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;result&amp;nbsp;variables&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_bind_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$district</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;value&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_fetch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;is&amp;nbsp;in&amp;nbsp;district&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$city</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$district</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Amersfoort is in district Utrecht </pre></div> </div> </div> <a name='mysqli-stmt.prepare.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_init()</a> - Initializes a statement and returns an object for use with mysqli_stmt_prepare, <a href='http://www.php.net/manual/en/mysqli-stmt.execute.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_execute()</a> - Executes a prepared Query, <a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_fetch()</a> - Fetch results from a prepared statement into the bound variables, <a href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_param()</a> - Binds variables to a prepared statement as parameters, <a href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_result()</a> - Binds variables to a prepared statement for result storage <a href='http://www.php.net/manual/en/mysqli-stmt.close.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_close()</a> - Closes a prepared statement. </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="mysqli_stmt_param_count" value="<div id='mysqli-stmt.param-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.param-count.php'>mysqli_stmt-&amp;gt;param_count</a></h1> <h1 class='refname'>mysqli_stmt_param_count</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt-&amp;gt;param_count</span> -- <span class='refname'>mysqli_stmt_param_count</span> &amp;mdash; <span class='dc-title'>Returns the number of parameter for the given statement</span></p> </div> <a name='mysqli-stmt.param-count.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-stmt.php' class='classname'>mysqli_stmt</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$param_count</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_stmt_param_count</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of parameter markers present in the prepared statement. </p> </div> <a name='mysqli-stmt.param-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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.param-count.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an integer representing the number of parameters. </p> </div> <a name='mysqli-stmt.param-count.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;Country&amp;nbsp;WHERE&amp;nbsp;Name=?&amp;nbsp;OR&amp;nbsp;Code=?'</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$marker&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>param_count</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: #DD0000'>'Statement&amp;nbsp;has&amp;nbsp;%d&amp;nbsp;markers.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$marker</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;Country&amp;nbsp;WHERE&amp;nbsp;Name=?&amp;nbsp;OR&amp;nbsp;Code=?'</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$marker&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_param_count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</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: #DD0000'>'Statement&amp;nbsp;has&amp;nbsp;%d&amp;nbsp;markers.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$marker</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Statement has 2 markers. </pre></div> </div> </div> <a name='mysqli-stmt.param-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/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</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="mysqli_stmt_num_rows" value="<div id='mysqli-stmt.num-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.num-rows.php'>mysqli_stmt::num_rows</a></h1> <h1 class='refname'>mysqli_stmt_num_rows</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::num_rows</span> -- <span class='refname'>mysqli_stmt_num_rows</span> &amp;mdash; <span class='dc-title'>Return the number of rows in statements result set</span></p> </div> <a name='mysqli-stmt.num-rows.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-stmt.php' class='classname'>mysqli_stmt</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$num_rows</var>;</div> </div> <p class='para'>Procedural style :</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_stmt_num_rows</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of rows in the result set. The use of <b>mysqli_stmt_num_rows()</b> depends on whether or not you used <a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php' class='function'>mysqli_stmt_store_result()</a> to buffer the entire result set in the statement handle. </p> <p class='para'> If you use <a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php' class='function'>mysqli_stmt_store_result()</a>, <b>mysqli_stmt_num_rows()</b> may be called immediately. </p> </div> <a name='mysqli-stmt.num-rows.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.num-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An integer representing the number of rows in result set. </p> </div> <a name='mysqli-stmt.num-rows.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name&amp;nbsp;LIMIT&amp;nbsp;20'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;store&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>store_result</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Number&amp;nbsp;of&amp;nbsp;rows:&amp;nbsp;%d.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>num_rows</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name&amp;nbsp;LIMIT&amp;nbsp;20'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;store&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_store_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Number&amp;nbsp;of&amp;nbsp;rows:&amp;nbsp;%d.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Number of rows: 20. </pre></div> </div> </div> <a name='mysqli-stmt.num-rows.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/mysqli-stmt.affected-rows.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_affected_rows()</a> - Returns the total number of rows changed, deleted, or inserted by the last executed statement</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_store_result()</a> - Transfers a result set from a prepared statement</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="mysqli_stmt_insert_id" value="<div id='mysqli-stmt.insert-id' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.insert-id.php'>mysqli_stmt-&amp;gt;insert_id</a></h1> <h1 class='refname'>mysqli_stmt_insert_id</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt-&amp;gt;insert_id</span> -- <span class='refname'>mysqli_stmt_insert_id</span> &amp;mdash; <span class='dc-title'>Get the ID generated from the previous INSERT operation</span></p> </div> <a name='mysqli-stmt.insert-id.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-stmt.php' class='classname'>mysqli_stmt</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$insert_id</var>;</div> </div> <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>mysqli_stmt_insert_id</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</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> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mysqli_stmt_init" value="<div id='mysqli.stmt-init' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.stmt-init.php'>mysqli::stmt_init</a></h1> <h1 class='refname'>mysqli_stmt_init</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::stmt_init</span> -- <span class='refname'>mysqli_stmt_init</span> &amp;mdash; <span class='dc-title'>Initializes a statement and returns an object for use with mysqli_stmt_prepare</span></p> </div> <a name='mysqli.stmt-init.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='methodsynopsis dc-description'> <span class='type'>mysqli_stmt</span> <span class='methodname'><b>stmt_init</b></span> ( <span class='methodparam'>void</span> )</div> </div> <p class='para'>Procedural style :</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <span class='methodname'><b>mysqli_stmt_init</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Allocates and initializes a statement object suitable for <a href='http://www.php.net/manual/en/mysqli-stmt.prepare.php' class='function'>mysqli_stmt_prepare()</a>. </p> <blockquote><p><b class='note'>Note</b>: Any subsequent calls to any mysqli_stmt function will fail until <a href='http://www.php.net/manual/en/mysqli-stmt.prepare.php' class='function'>mysqli_stmt_prepare()</a> was called. <br /> </p></blockquote> </div> <a name='mysqli.stmt-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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.stmt-init.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object. </p> </div> <a name='mysqli.stmt-init.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/mysqli-stmt.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_prepare()</a> - Prepare a SQL statement for execution</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="mysqli_stmt_get_warnings" value="<div id='mysqli-stmt.get-warnings' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.get-warnings.php'>mysqli_stmt::get_warnings</a></h1> <h1 class='refname'>mysqli_stmt_get_warnings</h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::get_warnings</span> -- <span class='refname'>mysqli_stmt_get_warnings</span> &amp;mdash; <span class='dc-title'>Get result of SHOW WARNINGS</span></p> </div> <a name='mysqli-stmt.get-warnings.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>mysqli_stmt::get_warnings</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mysqli_stmt_get_warnings</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</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> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mysqli_stmt_free_result" value="<div id='mysqli-stmt.free-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.free-result.php'>mysqli_stmt::free_result</a></h1> <h1 class='refname'>mysqli_stmt_free_result</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::free_result</span> -- <span class='refname'>mysqli_stmt_free_result</span> &amp;mdash; <span class='dc-title'>Frees stored result memory for the given statement handle</span></p> </div> <a name='mysqli-stmt.free-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mysqli_stmt::free_result</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mysqli_stmt_free_result</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Frees the result memory associated with the statement, which was allocated by <a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php' class='function'>mysqli_stmt_store_result()</a>. </p> </div> <a name='mysqli-stmt.free-result.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.free-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='mysqli-stmt.free-result.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/mysqli-stmt.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_store_result()</a> - Transfers a result set from a prepared statement</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="mysqli_stmt_field_count" value="<div id='mysqli-stmt.field-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.field-count.php'>mysqli_stmt-&amp;gt;field_count</a></h1> <h1 class='refname'>mysqli_stmt_field_count</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt-&amp;gt;field_count</span> -- <span class='refname'>mysqli_stmt_field_count</span> &amp;mdash; <span class='dc-title'>Returns the number of field in the given statement</span></p> </div> <a name='mysqli-stmt.field-count.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-stmt.php' class='classname'>mysqli_stmt</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$field_count</var>;</div> </div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_stmt_field_count</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</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> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mysqli_stmt_fetch" value="<div id='mysqli-stmt.fetch' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.fetch.php'>mysqli_stmt::fetch</a></h1> <h1 class='refname'>mysqli_stmt_fetch</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::fetch</span> -- <span class='refname'>mysqli_stmt_fetch</span> &amp;mdash; <span class='dc-title'>Fetch results from a prepared statement into the bound variables</span></p> </div> <a name='mysqli-stmt.fetch.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt::fetch</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt_fetch</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Fetch the result from a prepared statement into the variables bound by <a href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php' class='function'>mysqli_stmt_bind_result()</a>. </p> <blockquote><p><b class='note'>Note</b>: Note that all columns must be bound by the application before calling <b>mysqli_stmt_fetch()</b>. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: Data are transferred unbuffered without calling <a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php' class='function'>mysqli_stmt_store_result()</a> which can decrease performance (but reduces memory cost). <br /> </p></blockquote> </div> <a name='mysqli-stmt.fetch.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.fetch.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <table class='doctable table'> <caption><b>Return Values</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Value</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>TRUE</tt></b></td> <td align='left'>Success. Data has been fetched</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>FALSE</tt></b></td> <td align='left'>Error occurred</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>NULL</tt></b></td> <td align='left'>No more rows/data exists or data truncation occurred</td> </tr> </tbody> </table> </div> <a name='mysqli-stmt.fetch.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;by&amp;nbsp;ID&amp;nbsp;DESC&amp;nbsp;LIMIT&amp;nbsp;150,5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;result&amp;nbsp;variables&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;values&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</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;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;by&amp;nbsp;ID&amp;nbsp;DESC&amp;nbsp;LIMIT&amp;nbsp;150,5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;result&amp;nbsp;variables&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_bind_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;values&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_stmt_fetch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</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;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Rockford (USA) Tallahassee (USA) Salinas (USA) Santa Clarita (USA) Springfield (USA) </pre></div> </div> </div> <a name='mysqli-stmt.fetch.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/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.errno.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_errno()</a> - Returns the error code for the most recent statement call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.error.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_error()</a> - Returns a string description for last statement error</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_result()</a> - Binds variables to a prepared statement for result storage</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="mysqli_stmt_execute" value="<div id='mysqli-stmt.execute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.execute.php'>mysqli_stmt::execute</a></h1> <h1 class='refname'>mysqli_stmt_execute</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::execute</span> -- <span class='refname'>mysqli_stmt_execute</span> &amp;mdash; <span class='dc-title'>Executes a prepared Query</span></p> </div> <a name='mysqli-stmt.execute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt::execute</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt_execute</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Executes a query that has been previously prepared using the <a href='http://www.php.net/manual/en/mysqli.prepare.php' class='function'>mysqli_prepare()</a> function. When executed any parameter markers which exist will automatically be replaced with the appropriate data. </p> <p class='para'> If the statement is <i>UPDATE</i>, <i>DELETE</i>, or <i>INSERT</i>, the total number of affected rows can be determined by using the <a href='http://www.php.net/manual/en/mysqli-stmt.affected-rows.php' class='function'>mysqli_stmt_affected_rows()</a> function. Likewise, if the query yields a result set the <a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function'>mysqli_stmt_fetch()</a> function is used. </p> <blockquote><p><b class='note'>Note</b>: When using <b>mysqli_stmt_execute()</b>, the <a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function'>mysqli_stmt_fetch()</a> function must be used to fetch the data prior to performing any additional queries. <br /> </p></blockquote> </div> <a name='mysqli-stmt.execute.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.execute.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='mysqli-stmt.execute.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Prepare&amp;nbsp;an&amp;nbsp;insert&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCity&amp;nbsp;(Name,&amp;nbsp;CountryCode,&amp;nbsp;District)&amp;nbsp;VALUES&amp;nbsp;(?,?,?)'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_param</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'sss'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$val1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$val2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$val3</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$val1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Stuttgart'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$val2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DEU'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$val3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Baden-Wuerttemberg'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br /></span><span style='color: #0000BB'>$val1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Bordeaux'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$val2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'FRA'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$val3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Aquitaine'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;retrieve&amp;nbsp;all&amp;nbsp;rows&amp;nbsp;from&amp;nbsp;myCity&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode,&amp;nbsp;District&amp;nbsp;FROM&amp;nbsp;myCity'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s,%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</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: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;remove&amp;nbsp;table&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCity'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Prepare&amp;nbsp;an&amp;nbsp;insert&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCity&amp;nbsp;(Name,&amp;nbsp;CountryCode,&amp;nbsp;District)&amp;nbsp;VALUES&amp;nbsp;(?,?,?)'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysqli_stmt_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sss'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$val1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$val2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$val3</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$val1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Stuttgart'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$val2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DEU'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$val3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Baden-Wuerttemberg'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$val1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Bordeaux'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$val2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'FRA'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$val3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Aquitaine'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;retrieve&amp;nbsp;all&amp;nbsp;rows&amp;nbsp;from&amp;nbsp;myCity&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode,&amp;nbsp;District&amp;nbsp;FROM&amp;nbsp;myCity'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s,%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</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: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;remove&amp;nbsp;table&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCity'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Stuttgart (DEU,Baden-Wuerttemberg) Bordeaux (FRA,Aquitaine) </pre></div> </div> </div> <a name='mysqli-stmt.execute.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/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_param()</a> - Binds variables to a prepared statement as parameters</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="mysqli_stmt_error" value="<div id='mysqli-stmt.error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.error.php'>mysqli_stmt-&amp;gt;error</a></h1> <h1 class='refname'>mysqli_stmt_error</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt-&amp;gt;error</span> -- <span class='refname'>mysqli_stmt_error</span> &amp;mdash; <span class='dc-title'>Returns a string description for last statement error</span></p> </div> <a name='mysqli-stmt.error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-stmt.php' class='classname'>mysqli_stmt</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$error</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_stmt_error</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Returns a containing the error message for the most recently invoked statement function that can succeed or fail. </p> </div> <a name='mysqli-stmt.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A string that describes the error. An empty string if no error occurred. </p> </div> <a name='mysqli-stmt.error.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCountry&amp;nbsp;LIKE&amp;nbsp;Country'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCountry&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;Country'</span><span style='color: #007700'>);<br /><br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;Code&amp;nbsp;FROM&amp;nbsp;myCountry&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;drop&amp;nbsp;table&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCountry'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>error</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCountry&amp;nbsp;LIKE&amp;nbsp;Country'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCountry&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;Country'</span><span style='color: #007700'>);<br /><br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;Code&amp;nbsp;FROM&amp;nbsp;myCountry&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;drop&amp;nbsp;table&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCountry'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Error: Table &amp;#039;world.myCountry&amp;#039; doesn&amp;#039;t exist. </pre></div> </div> </div> <a name='mysqli-stmt.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/mysqli-stmt.errno.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_errno()</a> - Returns the error code for the most recent statement call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.sqlstate.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_sqlstate()</a> - Returns SQLSTATE error from previous statement operation</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="mysqli_stmt_errno" value="<div id='mysqli-stmt.errno' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.errno.php'>mysqli_stmt-&amp;gt;errno</a></h1> <h1 class='refname'>mysqli_stmt_errno</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt-&amp;gt;errno</span> -- <span class='refname'>mysqli_stmt_errno</span> &amp;mdash; <span class='dc-title'>Returns the error code for the most recent statement call</span></p> </div> <a name='mysqli-stmt.errno.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-stmt.php' class='classname'>mysqli_stmt</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$errno</var>;</div> </div> <p class='para'>Procedural style :</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_stmt_errno</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Returns the error code for the most recently invoked statement function that can succeed or fail. </p> <p class='para'> Client error message numbers are listed in the MySQL <var class='filename'>errmsg.h</var> header file, server error message numbers are listed in <var class='filename'>mysqld_error.h</var>. In the MySQL source distribution you can find a complete list of error messages and error numbers in the file <var class='filename'>Docs/mysqld_error.txt</var>. </p> </div> <a name='mysqli-stmt.errno.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.errno.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An error code value. Zero means no error occurred. </p> </div> <a name='mysqli-stmt.errno.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCountry&amp;nbsp;LIKE&amp;nbsp;Country'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCountry&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;Country'</span><span style='color: #007700'>);<br /><br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;Code&amp;nbsp;FROM&amp;nbsp;myCountry&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;drop&amp;nbsp;table&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCountry'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%d.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>errno</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCountry&amp;nbsp;LIKE&amp;nbsp;Country'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCountry&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;Country'</span><span style='color: #007700'>);<br /><br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;Code&amp;nbsp;FROM&amp;nbsp;myCountry&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;drop&amp;nbsp;table&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCountry'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%d.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_errno</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Error: 1146. </pre></div> </div> </div> <a name='mysqli-stmt.errno.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/mysqli-stmt.error.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_error()</a> - Returns a string description for last statement error</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.sqlstate.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_sqlstate()</a> - Returns SQLSTATE error from previous statement operation</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="mysqli_stmt_data_seek" value="<div id='mysqli-stmt.data-seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.data-seek.php'>mysqli_stmt::data_seek</a></h1> <h1 class='refname'>mysqli_stmt_data_seek</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::data_seek</span> -- <span class='refname'>mysqli_stmt_data_seek</span> &amp;mdash; <span class='dc-title'>Seeks to an arbitrary row in statement result set</span></p> </div> <a name='mysqli-stmt.data-seek.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mysqli_stmt::data_seek</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mysqli_stmt_data_seek</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> )</div> <p class='para rdfs-comment'> Seeks to an arbitrary result pointer in the statement result set. </p> <p class='para'> <a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php' class='function'>mysqli_stmt_store_result()</a> must be called prior to <b>mysqli_stmt_data_seek()</b>. </p> </div> <a name='mysqli-stmt.data-seek.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Must be between zero and the total number of rows minus one (0.. <a href='http://www.php.net/manual/en/mysqli-stmt.num-rows.php' class='function'>mysqli_stmt_num_rows()</a> - 1). </p> </dd> </dl> <p> </p> </div> <a name='mysqli-stmt.data-seek.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='mysqli-stmt.data-seek.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;result&amp;nbsp;variables&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;store&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>store_result</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;seek&amp;nbsp;to&amp;nbsp;row&amp;nbsp;no.&amp;nbsp;400&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>data_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>399</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;values&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'City:&amp;nbsp;%s&amp;nbsp;&amp;nbsp;Countrycode:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;result&amp;nbsp;variables&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_bind_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;store&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_store_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;seek&amp;nbsp;to&amp;nbsp;row&amp;nbsp;no.&amp;nbsp;400&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_data_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>399</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;values&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_fetch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'City:&amp;nbsp;%s&amp;nbsp;&amp;nbsp;Countrycode:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> City: Benin City Countrycode: NGA </pre></div> </div> </div> <a name='mysqli-stmt.data-seek.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/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</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="mysqli_stmt_close" value="<div id='mysqli-stmt.close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.close.php'>mysqli_stmt::close</a></h1> <h1 class='refname'>mysqli_stmt_close</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::close</span> -- <span class='refname'>mysqli_stmt_close</span> &amp;mdash; <span class='dc-title'>Closes a prepared statement</span></p> </div> <a name='mysqli-stmt.close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt::close</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt_close</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Closes a prepared statement. <b>mysqli_stmt_close()</b> also deallocates the statement handle. If the current statement has pending or unread results, this function cancels them so that the next query can be executed. </p> </div> <a name='mysqli-stmt.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.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='mysqli-stmt.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/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</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="mysqli_stmt_bind_result" value="<div id='mysqli-stmt.bind-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php'>mysqli_stmt::bind_result</a></h1> <h1 class='refname'>mysqli_stmt_bind_result</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::bind_result</span> -- <span class='refname'>mysqli_stmt_bind_result</span> &amp;mdash; <span class='dc-title'>Binds variables to a prepared statement for result storage</span></p> </div> <a name='mysqli-stmt.bind-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt::bind_result</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 reference'>&amp;amp;$var1</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 reference'>&amp;amp;$...</tt></span> ] )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt_bind_result</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</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 reference'>&amp;amp;$var1</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 reference'>&amp;amp;$...</tt></span> ] )</div> <p class='para rdfs-comment'> Binds columns in the result set to variables. </p> <p class='para'> When <a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function'>mysqli_stmt_fetch()</a> is called to fetch data, the MySQL client/server protocol places the data for the bound columns into the specified variables <i><tt class='parameter'>var1, ...</tt></i> . </p> <blockquote><p><b class='note'>Note</b>: Note that all columns must be bound after <a href='http://www.php.net/manual/en/mysqli-stmt.execute.php' class='function'>mysqli_stmt_execute()</a> and prior to calling <a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function'>mysqli_stmt_fetch()</a>. Depending on column types bound variables can silently change to the corresponding PHP type. <br /> A column can be bound or rebound at any time, even after a result set has been partially retrieved. The new binding takes effect the next time <a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function'>mysqli_stmt_fetch()</a> is called. <br /> </p></blockquote> </div> <a name='mysqli-stmt.bind-result.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>var1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable to be bound. </p> </dd> </dl> <p> </p> </div> <a name='mysqli-stmt.bind-result.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='mysqli-stmt.bind-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;prepare&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Code,&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;variables&amp;nbsp;to&amp;nbsp;prepared&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$col1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$col2</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;values&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$col1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$col2</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;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</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> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;prepare&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Code,&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;variables&amp;nbsp;to&amp;nbsp;prepared&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_bind_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$col1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$col2</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;values&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_stmt_fetch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$col1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$col2</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;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> AFG Afghanistan ALB Albania DZA Algeria ASM American Samoa AND Andorra </pre></div> </div> </div> <a name='mysqli-stmt.bind-result.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/mysqli-stmt.bind-param.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_param()</a> - Binds variables to a prepared statement as parameters</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.execute.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_execute()</a> - Executes a prepared Query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_fetch()</a> - Fetch results from a prepared statement into the bound variables</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_prepare()</a> - Prepare a SQL statement for execution</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_init()</a> - Initializes a statement and returns an object for use with mysqli_stmt_prepare</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.errno.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_errno()</a> - Returns the error code for the most recent statement call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.error.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_error()</a> - Returns a string description for last statement 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="mysqli_stmt_bind_param" value="<div id='mysqli-stmt.bind-param' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php'>mysqli_stmt::bind_param</a></h1> <h1 class='refname'>mysqli_stmt_bind_param</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::bind_param</span> -- <span class='refname'>mysqli_stmt_bind_param</span> &amp;mdash; <span class='dc-title'>Binds variables to a prepared statement as parameters</span></p> </div> <a name='mysqli-stmt.bind-param.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt::bind_param</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$types</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 reference'>&amp;amp;$var1</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 reference'>&amp;amp;$...</tt></span> ] )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt_bind_param</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$types</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 reference'>&amp;amp;$var1</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 reference'>&amp;amp;$...</tt></span> ] )</div> <p class='para rdfs-comment'> Bind variables for the parameter markers in the SQL statement that was passed to <a href='http://www.php.net/manual/en/mysqli.prepare.php' class='function'>mysqli_prepare()</a>. </p> <blockquote><p><b class='note'>Note</b>: If data size of a variable exceeds max. allowed packet size (max_allowed_packet), you have to specify <i>b</i> in <i><tt class='parameter'>types</tt></i> and use <a href='http://www.php.net/manual/en/mysqli-stmt.send-long-data.php' class='function'>mysqli_stmt_send_long_data()</a> to send the data in packets. <br /> </p></blockquote> </div> <a name='mysqli-stmt.bind-param.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>types</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A string that contains one or more characters which specify the types for the corresponding bind variables: </p><table class='doctable table'> <caption><b>Type specification chars</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Character</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>i</td> <td align='left'>corresponding variable has type integer</td> </tr> <tr valign='middle'> <td align='left'>d</td> <td align='left'>corresponding variable has type double</td> </tr> <tr valign='middle'> <td align='left'>s</td> <td align='left'>corresponding variable has type string</td> </tr> <tr valign='middle'> <td align='left'>b</td> <td align='left'>corresponding variable is a blob and will be sent in packets</td> </tr> </tbody> </table> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>var1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of variables and length of string <i><tt class='parameter'>types</tt></i> must match the parameters in the statement. </p> </dd> </dl> <p> </p> </div> <a name='mysqli-stmt.bind-param.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='mysqli-stmt.bind-param.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;CountryLanguage&amp;nbsp;VALUES&amp;nbsp;(?,&amp;nbsp;?,&amp;nbsp;?,&amp;nbsp;?)'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_param</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'sssd'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$language</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$official</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$percent</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$code&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DEU'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$language&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Bavarian'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$official&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'F'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$percent&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>11.2</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;prepared&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%d&amp;nbsp;Row&amp;nbsp;inserted.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>affected_rows</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;and&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Clean&amp;nbsp;up&amp;nbsp;table&amp;nbsp;CountryLanguage&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;CountryLanguage&amp;nbsp;WHERE&amp;nbsp;Language='Bavarian''</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%d&amp;nbsp;Row&amp;nbsp;deleted.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>affected_rows</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;CountryLanguage&amp;nbsp;VALUES&amp;nbsp;(?,&amp;nbsp;?,&amp;nbsp;?,&amp;nbsp;?)'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysqli_stmt_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sssd'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$language</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$official</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$percent</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$code&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DEU'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$language&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Bavarian'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$official&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'F'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$percent&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>11.2</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;prepared&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%d&amp;nbsp;Row&amp;nbsp;inserted.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_affected_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;and&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Clean&amp;nbsp;up&amp;nbsp;table&amp;nbsp;CountryLanguage&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;CountryLanguage&amp;nbsp;WHERE&amp;nbsp;Language='Bavarian''</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%d&amp;nbsp;Row&amp;nbsp;deleted.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_affected_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> 1 Row inserted. 1 Row deleted. </pre></div> </div> </div> <a name='mysqli-stmt.bind-param.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/mysqli-stmt.bind-result.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_result()</a> - Binds variables to a prepared statement for result storage</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.execute.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_execute()</a> - Executes a prepared Query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_fetch()</a> - Fetch results from a prepared statement into the bound variables</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.send-long-data.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_send_long_data()</a> - Send data in blocks</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.errno.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_errno()</a> - Returns the error code for the most recent statement call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.error.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_error()</a> - Returns a string description for last statement 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="mysqli_stmt_attr_set" value="<div id='mysqli-stmt.attr-set' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.attr-set.php'>mysqli_stmt::attr_set</a></h1> <h1 class='refname'>mysqli_stmt_attr_set</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::attr_set</span> -- <span class='refname'>mysqli_stmt_attr_set</span> &amp;mdash; <span class='dc-title'>Used to modify the behavior of a prepared statement</span></p> </div> <a name='mysqli-stmt.attr-set.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt::attr_set</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$attr</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_stmt_attr_set</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$attr</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> )</div> <p class='para rdfs-comment'> Used to modify the behavior of a prepared statement. This function may be called multiple times to set several attributes. </p> </div> <a name='mysqli-stmt.attr-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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attr</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The attribute that you want to set. It can have one of the following values: </p><table class='doctable table'> <caption><b>Attribute values</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Character</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH</td> <td align='left'> If set to 1, causes <a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php' class='function'>mysqli_stmt_store_result()</a> to update the metadata <i>MYSQL_FIELD-&amp;gt;max_length</i> value. </td> </tr> <tr valign='middle'> <td align='left'>MYSQLI_STMT_ATTR_CURSOR_TYPE</td> <td align='left'> Type of cursor to open for statement when <a href='http://www.php.net/manual/en/mysqli-stmt.execute.php' class='function'>mysqli_stmt_execute()</a> is invoked. <i><tt class='parameter'>mode</tt></i> can be <i>MYSQLI_CURSOR_TYPE_NO_CURSOR</i> (the default) or <i>MYSQLI_CURSOR_TYPE_READ_ONLY</i>. </td> </tr> <tr valign='middle'> <td align='left'>MYSQLI_STMT_ATTR_PREFETCH_ROWS</td> <td align='left'> Number of rows to fetch from server at a time when using a cursor. <i><tt class='parameter'>mode</tt></i> can be in the range from 1 to the maximum value of unsigned long. The default is 1. </td> </tr> </tbody> </table> <p> </p> <p class='para'> If you use the <i>MYSQLI_STMT_ATTR_CURSOR_TYPE</i> option with <i>MYSQLI_CURSOR_TYPE_READ_ONLY</i>, a cursor is opened for the statement when you invoke <a href='http://www.php.net/manual/en/mysqli-stmt.execute.php' class='function'>mysqli_stmt_execute()</a>. If there is already an open cursor from a previous <a href='http://www.php.net/manual/en/mysqli-stmt.execute.php' class='function'>mysqli_stmt_execute()</a> call, it closes the cursor before opening a new one. <a href='http://www.php.net/manual/en/mysqli-stmt.reset.php' class='function'>mysqli_stmt_reset()</a> also closes any open cursor before preparing the statement for re-execution. <a href='http://www.php.net/manual/en/mysqli-stmt.free-result.php' class='function'>mysqli_stmt_free_result()</a> closes any open cursor. </p> <p class='para'> If you open a cursor for a prepared statement, <a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php' class='function'>mysqli_stmt_store_result()</a> is unnecessary. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The value to assign to the attribute.</p> </dd> </dl> <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="mysqli_stmt_attr_get" value="<div id='mysqli-stmt.attr-get' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.attr-get.php'>mysqli_stmt::attr_get</a></h1> <h1 class='refname'>mysqli_stmt_attr_get</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt::attr_get</span> -- <span class='refname'>mysqli_stmt_attr_get</span> &amp;mdash; <span class='dc-title'>Used to get the current value of a statement attribute</span></p> </div> <a name='mysqli-stmt.attr-get.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_stmt::attr_get</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$attr</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_stmt_attr_get</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$attr</tt></span> )</div> <p class='para rdfs-comment'> Gets the current value of a statement attribute. </p> </div> <a name='mysqli-stmt.attr-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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attr</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The attribute that you want to get. </p> </dd> </dl> <p> </p> </div> <a name='mysqli-stmt.attr-get.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>FALSE</tt></b> if the attribute is not found, otherwise returns the value of the attribute. </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="mysqli_stmt_affected_rows" value="<div id='mysqli-stmt.affected-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-stmt.affected-rows.php'>mysqli_stmt-&amp;gt;affected_rows</a></h1> <h1 class='refname'>mysqli_stmt_affected_rows</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_stmt-&amp;gt;affected_rows</span> -- <span class='refname'>mysqli_stmt_affected_rows</span> &amp;mdash; <span class='dc-title'>Returns the total number of rows changed, deleted, or inserted by the last executed statement </span></p> </div> <a name='mysqli-stmt.affected-rows.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-stmt.php' class='classname'>mysqli_stmt</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$affected_rows</var>;</div> </div> <p class='para'>Procedural style :</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_stmt_affected_rows</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of rows affected by <i>INSERT</i>, <i>UPDATE</i>, or <i>DELETE</i> query. </p> <p class='para'> This function only works with queries which update a table. In order to get the number of rows from a SELECT query, use <a href='http://www.php.net/manual/en/mysqli-stmt.num-rows.php' class='function'>mysqli_stmt_num_rows()</a> instead. </p> </div> <a name='mysqli-stmt.affected-rows.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'> stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A statement identifier returned by <a href='http://www.php.net/manual/en/mysqli.stmt-init.php' class='function'>mysqli_stmt_init()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-stmt.affected-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An integer greater than zero indicates the number of rows affected or retrieved. Zero indicates that no records where updated for an UPDATE/DELETE statement, no rows matched the WHERE clause in the query or that no query has yet been executed. -1 indicates that the query has returned an error. NULL indicates an invalid argument was supplied to the function. </p> <blockquote><p><b class='note'>Note</b>: If the number of affected rows is greater than maximal PHP int value, the number of affected rows will be returned as a string value. <br /> </p></blockquote> </div> <a name='mysqli-stmt.affected-rows.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;create&amp;nbsp;temp&amp;nbsp;table&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TEMPORARY&amp;nbsp;TABLE&amp;nbsp;myCountry&amp;nbsp;LIKE&amp;nbsp;Country'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCountry&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;Country&amp;nbsp;WHERE&amp;nbsp;Code&amp;nbsp;LIKE&amp;nbsp;?'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;prepare&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Bind&amp;nbsp;variable&amp;nbsp;for&amp;nbsp;placeholder&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$code&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'A%'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_param</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'s'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'rows&amp;nbsp;inserted:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>affected_rows</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;create&amp;nbsp;temp&amp;nbsp;table&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TEMPORARY&amp;nbsp;TABLE&amp;nbsp;myCountry&amp;nbsp;LIKE&amp;nbsp;Country'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCountry&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;Country&amp;nbsp;WHERE&amp;nbsp;Code&amp;nbsp;LIKE&amp;nbsp;?'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;prepare&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Bind&amp;nbsp;variable&amp;nbsp;for&amp;nbsp;placeholder&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$code&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'A%'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'s'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$code</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'rows&amp;nbsp;inserted:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_affected_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> rows inserted: 17 </pre></div> </div> </div> <a name='mysqli-stmt.affected-rows.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/mysqli-stmt.num-rows.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_num_rows()</a> - Return the number of rows in statements result set</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.prepare.php' class='function' rel='rdfs-seeAlso'>mysqli_prepare()</a> - Prepare a SQL statement for execution</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="MySQLi_STMT" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.mysqli-stmt.php'>The MySQLi_STMT class</a></h1> <div class='partintro'> <div id='mysqli-stmt.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> Represents a prepared statement. </p> </div> <div id='mysqli-stmt.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>MySQLi_STMT</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>MySQLi_STMT</b> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Properties */</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$affected_rows</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$errno</var>;</div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$error</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$field_count</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$insert_id</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$num_rows</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$param_count</var>;</div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$sqlstate</var>;</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.affected-rows.php' class='function'>mysqli_stmt_affected_rows</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.attr-get.php' class='function'>mysqli_stmt::attr_get</a></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$attr</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.attr-set.php' class='function'>mysqli_stmt::attr_set</a></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$attr</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php' class='function'>mysqli_stmt::bind_param</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$types</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 reference'>&amp;amp;$var1</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 reference'>&amp;amp;$...</tt></span> ] )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php' class='function'>mysqli_stmt::bind_result</a></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 reference'>&amp;amp;$var1</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 reference'>&amp;amp;$...</tt></span> ] )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.close.php' class='function'>mysqli_stmt::close</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.data-seek.php' class='function'>mysqli_stmt::data_seek</a></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.errno.php' class='function'>mysqli_stmt_errno</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.error.php' class='function'>mysqli_stmt_error</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.execute.php' class='function'>mysqli_stmt::execute</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/mysqli-stmt.fetch.php' class='function'>mysqli_stmt::fetch</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/mysqli-stmt.field-count.php' class='function'>mysqli_stmt_field_count</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.free-result.php' class='function'>mysqli_stmt::free_result</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.get-warnings.php' class='function'>mysqli_stmt::get_warnings</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mixed</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.insert-id.php' class='function'>mysqli_stmt_insert_id</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.num-rows.php' class='function'>mysqli_stmt_num_rows</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.param-count.php' class='function'>mysqli_stmt_param_count</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mixed</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.prepare.php' class='function'>mysqli_stmt::prepare</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.reset.php' class='function'>mysqli_stmt::reset</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mysqli_result</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.result-metadata.php' class='function'>mysqli_stmt::result_metadata</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/mysqli-stmt.send-long-data.php' class='function'>mysqli_stmt::send_long_data</a></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$param_nr</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.sqlstate.php' class='function'>mysqli_stmt_sqlstate</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <tt class='parameter'>$stmt</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php' class='function'>mysqli_stmt::store_result</a></span> ( <span class='methodparam'>void</span> )</div> }</div> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/mysqli-stmt.affected-rows.php'>mysqli_stmt->affected_rows</a> &amp;acirc;&amp;#128;&amp;#148; Returns the total number of rows changed, deleted, or inserted by the last executed statement</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.attr-get.php'>mysqli_stmt::attr_get</a> &amp;acirc;&amp;#128;&amp;#148; Used to get the current value of a statement attribute</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.attr-set.php'>mysqli_stmt::attr_set</a> &amp;acirc;&amp;#128;&amp;#148; Used to modify the behavior of a prepared statement</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php'>mysqli_stmt::bind_param</a> &amp;acirc;&amp;#128;&amp;#148; Binds variables to a prepared statement as parameters</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php'>mysqli_stmt::bind_result</a> &amp;acirc;&amp;#128;&amp;#148; Binds variables to a prepared statement for result storage</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.close.php'>mysqli_stmt::close</a> &amp;acirc;&amp;#128;&amp;#148; Closes a prepared statement</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.data-seek.php'>mysqli_stmt::data_seek</a> &amp;acirc;&amp;#128;&amp;#148; Seeks to an arbitrary row in statement result set</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.errno.php'>mysqli_stmt->errno</a> &amp;acirc;&amp;#128;&amp;#148; Returns the error code for the most recent statement call</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.error.php'>mysqli_stmt->error</a> &amp;acirc;&amp;#128;&amp;#148; Returns a string description for last statement error</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.execute.php'>mysqli_stmt::execute</a> &amp;acirc;&amp;#128;&amp;#148; Executes a prepared Query</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php'>mysqli_stmt::fetch</a> &amp;acirc;&amp;#128;&amp;#148; Fetch results from a prepared statement into the bound variables</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.field-count.php'>mysqli_stmt->field_count</a> &amp;acirc;&amp;#128;&amp;#148; Returns the number of field in the given statement</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.free-result.php'>mysqli_stmt::free_result</a> &amp;acirc;&amp;#128;&amp;#148; Frees stored result memory for the given statement handle</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.get-warnings.php'>mysqli_stmt::get_warnings</a> &amp;acirc;&amp;#128;&amp;#148; Get result of SHOW WARNINGS</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.insert-id.php'>mysqli_stmt->insert_id</a> &amp;acirc;&amp;#128;&amp;#148; Get the ID generated from the previous INSERT operation</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.num-rows.php'>mysqli_stmt::num_rows</a> &amp;acirc;&amp;#128;&amp;#148; Return the number of rows in statements result set</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.param-count.php'>mysqli_stmt->param_count</a> &amp;acirc;&amp;#128;&amp;#148; Returns the number of parameter for the given statement</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.prepare.php'>mysqli_stmt::prepare</a> &amp;acirc;&amp;#128;&amp;#148; Prepare a SQL statement for execution</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.reset.php'>mysqli_stmt::reset</a> &amp;acirc;&amp;#128;&amp;#148; Resets a prepared statement</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.result-metadata.php'>mysqli_stmt::result_metadata</a> &amp;acirc;&amp;#128;&amp;#148; Returns result set metadata from a prepared statement</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.send-long-data.php'>mysqli_stmt::send_long_data</a> &amp;acirc;&amp;#128;&amp;#148; Send data in blocks</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.sqlstate.php'>mysqli_stmt::sqlstate</a> &amp;acirc;&amp;#128;&amp;#148; Returns SQLSTATE error from previous statement operation</li><li><a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php'>mysqli_stmt::store_result</a> &amp;acirc;&amp;#128;&amp;#148; Transfers a result set from a prepared statement</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="mysqli_stat" value="<div id='mysqli.stat' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.stat.php'>mysqli::stat</a></h1> <h1 class='refname'>mysqli_stat</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::stat</span> -- <span class='refname'>mysqli_stat</span> &amp;mdash; <span class='dc-title'>Gets the current system status</span></p> </div> <a name='mysqli.stat.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli::stat</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_stat</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> <b>mysqli_stat()</b> returns a string containing information similar to that provided by the &amp;#039;mysqladmin status&amp;#039; command. This includes uptime in seconds and the number of running threads, questions, reloads, and open tables. </p> </div> <a name='mysqli.stat.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.stat.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A string describing the server status. <b><tt class='constant'>FALSE</tt></b> if an error occurred. </p> </div> <a name='mysqli.stat.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'System&amp;nbsp;status:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>stat</span><span style='color: #007700'>());<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'System&amp;nbsp;status:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stat</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> System status: Uptime: 272 Threads: 1 Questions: 5340 Slow queries: 0 Opens: 13 Flush tables: 1 Open tables: 0 Queries per second avg: 19.632 Memory in use: 8496K Max memory used: 8560K </pre></div> </div> </div> <a name='mysqli.stat.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/mysqli.get-server-info.php' class='function' rel='rdfs-seeAlso'>mysqli_get_server_info()</a> - Returns the version of the MySQL 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="mysqli_ssl_set" value="<div id='mysqli.ssl-set' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.ssl-set.php'>mysqli::ssl_set</a></h1> <h1 class='refname'>mysqli_ssl_set</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::ssl_set</span> -- <span class='refname'>mysqli_ssl_set</span> &amp;mdash; <span class='dc-title'>Used for establishing secure connections using SSL</span></p> </div> <a name='mysqli.ssl-set.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::ssl_set</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$key</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$cert</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$ca</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$capath</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$cipher</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_ssl_set</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$key</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$cert</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$ca</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$capath</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$cipher</tt></span> )</div> <p class='para rdfs-comment'> Used for establishing secure connections using SSL. It must be called before <a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function'>mysqli_real_connect()</a>. This function does nothing unless OpenSSL support is enabled. </p> </div> <a name='mysqli.ssl-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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>key</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path name to the key file. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cert</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path name to the certificate file. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ca</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path name to the certificate authority file. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>capath</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The pathname to a directory that contains trusted SSL CA certificates in PEM format. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cipher</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A list of allowable ciphers to use for SSL encryption. </p> </dd> </dl> <p> </p> <p class='para'> Any unused SSL parameters may be given as <b><tt class='constant'>NULL</tt></b> </p> </div> <a name='mysqli.ssl-set.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> This function always returns <b><tt class='constant'>TRUE</tt></b> value. If SSL setup is incorrect <a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function'>mysqli_real_connect()</a> will return an error when you attempt to connect. </p> </div> <a name='mysqli.ssl-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/mysqli.options.php' class='function' rel='rdfs-seeAlso'>mysqli_options()</a> - Set options</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function' rel='rdfs-seeAlso'>mysqli_real_connect()</a> - Opens a connection to a mysql 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="mysqli_sqlstate" value="<div id='mysqli.sqlstate' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.sqlstate.php'>mysqli-&amp;gt;sqlstate</a></h1> <h1 class='refname'>mysqli_sqlstate</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;sqlstate</span> -- <span class='refname'>mysqli_sqlstate</span> &amp;mdash; <span class='dc-title'>Returns the SQLSTATE error from previous MySQL operation</span></p> </div> <a name='mysqli.sqlstate.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$sqlstate</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_sqlstate</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. <i>&amp;#039;00000&amp;#039;</i> means no error. The values are specified by ANSI SQL and ODBC. For a list of possible values, see <a href='http://dev.mysql.com/doc/mysql/en/error-handling.html' class='link external'>&amp;raquo; http://dev.mysql.com/doc/mysql/en/error-handling.html</a>. </p> <blockquote><p><b class='note'>Note</b>: Note that not all MySQL errors are yet mapped to SQLSTATE&amp;#039;s. The value <i>HY000</i> (general error) is used for unmapped errors. <br /> </p></blockquote> </div> <a name='mysqli.sqlstate.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.sqlstate.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. <i>&amp;#039;00000&amp;#039;</i> means no error. </p> </div> <a name='mysqli.sqlstate.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Table&amp;nbsp;City&amp;nbsp;already&amp;nbsp;exists,&amp;nbsp;so&amp;nbsp;we&amp;nbsp;should&amp;nbsp;get&amp;nbsp;an&amp;nbsp;error&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;City&amp;nbsp;(ID&amp;nbsp;INT,&amp;nbsp;Name&amp;nbsp;VARCHAR(30))'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error&amp;nbsp;-&amp;nbsp;SQLSTATE&amp;nbsp;%s.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>sqlstate</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Table&amp;nbsp;City&amp;nbsp;already&amp;nbsp;exists,&amp;nbsp;so&amp;nbsp;we&amp;nbsp;should&amp;nbsp;get&amp;nbsp;an&amp;nbsp;error&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;City&amp;nbsp;(ID&amp;nbsp;INT,&amp;nbsp;Name&amp;nbsp;VARCHAR(30))'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error&amp;nbsp;-&amp;nbsp;SQLSTATE&amp;nbsp;%s.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_sqlstate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Error - SQLSTATE 42S01. </pre></div> </div> </div> <a name='mysqli.sqlstate.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/mysqli.errno.php' class='function' rel='rdfs-seeAlso'>mysqli_errno()</a> - Returns the error code for the most recent function call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.error.php' class='function' rel='rdfs-seeAlso'>mysqli_error()</a> - Returns a string description of the last 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="mysqli_slave_query" value="<div id='function.mysqli-slave-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-slave-query.php'>mysqli_slave_query</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_slave_query</span> &amp;mdash; <span class='dc-title'>Force execution of a query on a slave in a master/slave setup</span></p> </div> <a name='function.mysqli-slave-query.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>mysqli_slave_query</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</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 class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> and <em class='emphasis'>REMOVED</em> as of PHP 5.3.0.</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="mysqli_set_opt" value="<div id='function.mysqli-set-opt' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-set-opt.php'>mysqli_set_opt</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_set_opt</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/mysqli.options.php' class='function'>mysqli_options()</a></span></p> </div> <a name='function.mysqli-set-opt.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of <a href='http://www.php.net/manual/en/mysqli.options.php' class='function'>mysqli_options()</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="mysqli_set_local_infile_handler" value="<div id='mysqli.set-local-infile-handler' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.set-local-infile-handler.php'>mysqli::set_local_infile_handler</a></h1> <h1 class='refname'>mysqli_set_local_infile_handler</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::set_local_infile_handler</span> -- <span class='refname'>mysqli_set_local_infile_handler</span> &amp;mdash; <span class='dc-title'>Set callback function for LOAD DATA LOCAL INFILE command</span></p> </div> <a name='mysqli.set-local-infile-handler.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>mysqli_set_local_infile_handler</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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'>$read_func</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style (method)</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>set_local_infile_handler</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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'>$read_func</tt></span> )</div> </div> <p class='para'>Set callback function for LOAD DATA LOCAL INFILE command</p> <p class='para'> The callbacks task is to read input from the file specified in the <i>LOAD DATA LOCAL INFILE</i> and to reformat it into the format understood by <i>LOAD DATA INFILE</i>. </p> <p class='para'> The returned data needs to match the format specified in the <i>LOAD DATA</i> </p> </div> <a name='mysqli.set-local-infile-handler.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>read_func</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A callback function or object method taking the following parameters: </p> <dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>stream</tt></i> </span> </dt><dd class='listitem'> <p class='para'>A PHP stream associated with the SQL commands INFILE</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>&amp;amp;buffer</tt></i> </span> </dt><dd class='listitem'> <p class='para'>A string buffer to store the rewritten input into</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>buflen</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The maximum number of characters to be stored in the buffer</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>&amp;amp;errormsg</tt></i> </span> </dt><dd class='listitem'> <p class='para'>If an error occurs you can store an error message in here</p></dd> </dl> </dd> </dl> <p> </p> <p class='para'> The callback function should return the number of characters stored in the <i><tt class='parameter'>buffer</tt></i> or a negative value if an error occurred. </p> </div> <a name='mysqli.set-local-infile-handler.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='mysqli.set-local-infile-handler.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_init</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>real_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'root'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>callme</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stream</span><span style='color: #007700'>,&amp;nbsp;&amp;amp;</span><span style='color: #0000BB'>$buffer</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$buflen</span><span style='color: #007700'>,&amp;nbsp;&amp;amp;</span><span style='color: #0000BB'>$errmsg</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$buffer&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>fgets</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stream</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$buffer</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;convert&amp;nbsp;to&amp;nbsp;upper&amp;nbsp;case&amp;nbsp;and&amp;nbsp;replace&amp;nbsp;','&amp;nbsp;delimiter&amp;nbsp;with&amp;nbsp;[TAB]<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$buffer&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>strtoupper</span><span style='color: #007700'>(</span><span style='color: #0000BB'>str_replace</span><span style='color: #007700'>(</span><span style='color: #DD0000'>','</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\t'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$buffer</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>strlen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$buffer</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br /><br /><br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Input:\n'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>set_local_infile_handler</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'callme'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'LOAD&amp;nbsp;DATA&amp;nbsp;LOCAL&amp;nbsp;INFILE&amp;nbsp;'input.txt'&amp;nbsp;INTO&amp;nbsp;TABLE&amp;nbsp;t1'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>set_local_infile_default</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;t1'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\nResult:\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_assoc</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>join</span><span style='color: #007700'>(</span><span style='color: #DD0000'>','</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>).</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_init</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_real_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'root'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>callme</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stream</span><span style='color: #007700'>,&amp;nbsp;&amp;amp;</span><span style='color: #0000BB'>$buffer</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$buflen</span><span style='color: #007700'>,&amp;nbsp;&amp;amp;</span><span style='color: #0000BB'>$errmsg</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$buffer&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>fgets</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stream</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$buffer</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;convert&amp;nbsp;to&amp;nbsp;upper&amp;nbsp;case&amp;nbsp;and&amp;nbsp;replace&amp;nbsp;','&amp;nbsp;delimiter&amp;nbsp;with&amp;nbsp;[TAB]<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$buffer&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>strtoupper</span><span style='color: #007700'>(</span><span style='color: #0000BB'>str_replace</span><span style='color: #007700'>(</span><span style='color: #DD0000'>','</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\t'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$buffer</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>strlen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$buffer</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br /><br /><br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Input:\n'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_set_local_infile_handler</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'callme'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'LOAD&amp;nbsp;DATA&amp;nbsp;LOCAL&amp;nbsp;INFILE&amp;nbsp;'input.txt'&amp;nbsp;INTO&amp;nbsp;TABLE&amp;nbsp;t1'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_set_local_infile_default</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;t1'</span><span style='color: #007700'>);<br /><br /><br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\nResult:\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>join</span><span style='color: #007700'>(</span><span style='color: #DD0000'>','</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>).</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Input: 23,foo 42,bar Output: 23,FOO 42,BAR </pre></div> </div> </div> <a name='mysqli.set-local-infile-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/mysqli.set-local-infile-default.php' class='function' rel='rdfs-seeAlso'>mysqli_set_local_infile_default()</a> - Unsets user defined handler for load local infile command</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="mysqli_set_local_infile_default" value="<div id='mysqli.set-local-infile-default' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.set-local-infile-default.php'>mysqli::set_local_infile_default</a></h1> <h1 class='refname'>mysqli_set_local_infile_default</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::set_local_infile_default</span> -- <span class='refname'>mysqli_set_local_infile_default</span> &amp;mdash; <span class='dc-title'>Unsets user defined handler for load local infile command</span></p> </div> <a name='mysqli.set-local-infile-default.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>mysqli_set_local_infile_default</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Deactivates a <i>LOAD DATA INFILE LOCAL</i> handler previously set with <a href='http://www.php.net/manual/en/mysqli.set-local-infile-handler.php' class='function'>mysqli_set_local_infile_handler()</a>. </p> </div> <a name='mysqli.set-local-infile-default.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.set-local-infile-default.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='mysqli.set-local-infile-default.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'>See <a href='http://www.php.net/manual/en/mysqli.set-local-infile-handler.php' class='function'>mysqli_set_local_infile_handler()</a> examples</p> </div> <a name='mysqli.set-local-infile-default.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/mysqli.set-local-infile-handler.php' class='function' rel='rdfs-seeAlso'>mysqli_set_local_infile_handler()</a> - Set callback function for LOAD DATA LOCAL INFILE command</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="mysqli_set_charset" value="<div id='mysqli.set-charset' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.set-charset.php'>mysqli::set_charset</a></h1> <h1 class='refname'>mysqli_set_charset</h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.0.5)</p><p class='refpurpose'><span class='refname'>mysqli::set_charset</span> -- <span class='refname'>mysqli_set_charset</span> &amp;mdash; <span class='dc-title'>Sets the default client character set</span></p> </div> <a name='mysqli.set-charset.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::set_charset</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_set_charset</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> )</div> <p class='para rdfs-comment'> Sets the default character set to be used when sending data from and to the database server. </p> </div> <a name='mysqli.set-charset.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The charset to be set as default. </p> </dd> </dl> <p> </p> </div> <a name='mysqli.set-charset.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='mysqli.set-charset.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: To use this function on a Windows platform you need MySQL client library version 4.1.11 or above (for MySQL 5.0 you need 5.0.6 or above). <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: This is the preferred way to change the charset. Using <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli::query()</a> to execute <i>SET NAMES ..</i> is not recommended. <br /> </p></blockquote> </div> <a name='mysqli.set-charset.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;change&amp;nbsp;character&amp;nbsp;set&amp;nbsp;to&amp;nbsp;utf8&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>set_charset</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'utf8'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error&amp;nbsp;loading&amp;nbsp;character&amp;nbsp;set&amp;nbsp;utf8:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>error</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Current&amp;nbsp;character&amp;nbsp;set:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>character_set_name</span><span style='color: #007700'>());<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;change&amp;nbsp;character&amp;nbsp;set&amp;nbsp;to&amp;nbsp;utf8&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_set_charset</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'utf8'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error&amp;nbsp;loading&amp;nbsp;character&amp;nbsp;set&amp;nbsp;utf8:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Current&amp;nbsp;character&amp;nbsp;set:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_character_set_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Current character set: utf8 </pre></div> </div> </div> <a name='mysqli.set-charset.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/mysqli.character-set-name.php' class='function' rel='rdfs-seeAlso'>mysqli_character_set_name()</a> - Returns the default character set for the database connection</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.real-escape-string.php' class='function' rel='rdfs-seeAlso'>mysqli_real_escape_string()</a> - Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection</li> <li class='member'><a href='http://dev.mysql.com/doc/refman/5.1/en/charset-charsets.html' class='link external'>&amp;raquo; List of character sets that MySQL supports</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="mysqli_send_query" value="<div id='function.mysqli-send-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-send-query.php'>mysqli_send_query</a></h1> <h1 class='refname'>mysqli-&amp;gt;send_query</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_send_query</span> -- <span class='refname'>mysqli-&amp;gt;send_query</span> &amp;mdash; <span class='dc-title'>Send the query and return</span></p> </div> <a name='function.mysqli-send-query.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>mysqli_send_query</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style (method)</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>send_query</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> </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 class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> and <em class='emphasis'>REMOVED</em> as of PHP 5.3.0.</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="mysqli_send_long_data" value="<div id='function.mysqli-send-long-data' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-send-long-data.php'>mysqli_send_long_data</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_send_long_data</span> &amp;mdash; <span class='dc-title'>Alias for <a href='http://www.php.net/manual/en/mysqli-stmt.send-long-data.php' class='function'>mysqli_stmt_send_long_data()</a></span></p> </div> <a name='function.mysqli-send-long-data.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of <a href='http://www.php.net/manual/en/mysqli-stmt.send-long-data.php' class='function'>mysqli_stmt_send_long_data()</a>. </p> </div> <a name='function.mysqli-send-long-data.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>mysqli_send_long_data()</b> is deprecated and will be removed. <br /> </p></blockquote> </div> <a name='function.mysqli-send-long-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/mysqli-stmt.send-long-data.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_send_long_data()</a> - Send data in blocks</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="mysqli_select_db" value="<div id='mysqli.select-db' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.select-db.php'>mysqli::select_db</a></h1> <h1 class='refname'>mysqli_select_db</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::select_db</span> -- <span class='refname'>mysqli_select_db</span> &amp;mdash; <span class='dc-title'>Selects the default database for database queries</span></p> </div> <a name='mysqli.select-db.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::select_db</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dbname</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_select_db</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dbname</tt></span> )</div> <p class='para rdfs-comment'> Selects the default database to be used when performing queries against the database connection. </p> <blockquote><p><b class='note'>Note</b>: This function should only be used to change the default database for the connection. You can select the default database with 4th parameter in <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a>. <br /> </p></blockquote> </div> <a name='mysqli.select-db.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dbname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The database name. </p> </dd> </dl> <p> </p> </div> <a name='mysqli.select-db.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='mysqli.select-db.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;return&amp;nbsp;name&amp;nbsp;of&amp;nbsp;current&amp;nbsp;default&amp;nbsp;database&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;DATABASE()'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</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: #DD0000'>'Default&amp;nbsp;database&amp;nbsp;is&amp;nbsp;%s.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;change&amp;nbsp;db&amp;nbsp;to&amp;nbsp;world&amp;nbsp;db&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;return&amp;nbsp;name&amp;nbsp;of&amp;nbsp;current&amp;nbsp;default&amp;nbsp;database&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;DATABASE()'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</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: #DD0000'>'Default&amp;nbsp;database&amp;nbsp;is&amp;nbsp;%s.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;return&amp;nbsp;name&amp;nbsp;of&amp;nbsp;current&amp;nbsp;default&amp;nbsp;database&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;DATABASE()'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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: #DD0000'>'Default&amp;nbsp;database&amp;nbsp;is&amp;nbsp;%s.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;change&amp;nbsp;db&amp;nbsp;to&amp;nbsp;world&amp;nbsp;db&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_select_db</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;return&amp;nbsp;name&amp;nbsp;of&amp;nbsp;current&amp;nbsp;default&amp;nbsp;database&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;DATABASE()'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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: #DD0000'>'Default&amp;nbsp;database&amp;nbsp;is&amp;nbsp;%s.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Default database is test. Default database is world. </pre></div> </div> </div> <a name='mysqli.select-db.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/mysqli.connect.php' class='function' rel='rdfs-seeAlso'>mysqli_connect()</a> - Open a new connection to the MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function' rel='rdfs-seeAlso'>mysqli_real_connect()</a> - Opens a connection to a mysql 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="mysqli_rpl_query_type" value="<div id='function.mysqli-rpl-query-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-rpl-query-type.php'>mysqli_rpl_query_type</a></h1> <h1 class='refname'>mysqli-&amp;gt;rpl_query_type</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_rpl_query_type</span> -- <span class='refname'>mysqli-&amp;gt;rpl_query_type</span> &amp;mdash; <span class='dc-title'>Returns RPL query type</span></p> </div> <a name='function.mysqli-rpl-query-type.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>mysqli_rpl_query_type</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style (method)</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>rpl_query_type</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> </div> <p class='para'> Returns <b><tt class='constant'>MYSQLI_RPL_MASTER</tt></b>, <b><tt class='constant'>MYSQLI_RPL_SLAVE</tt></b> or <b><tt class='constant'>MYSQLI_RPL_ADMIN</tt></b> depending on a query type. <i>INSERT</i>, <i>UPDATE</i> and similar are <em class='emphasis'>master</em> queries, <i>SELECT</i> is <em class='emphasis'>slave</em>, and <i>FLUSH</i>, <i>REPAIR</i> and similar are <em class='emphasis'>admin</em>. </p> <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 class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> and <em class='emphasis'>REMOVED</em> as of PHP 5.3.0.</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="mysqli_rpl_probe" value="<div id='function.mysqli-rpl-probe' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-rpl-probe.php'>mysqli_rpl_probe</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_rpl_probe</span> &amp;mdash; <span class='dc-title'>RPL probe</span></p> </div> <a name='function.mysqli-rpl-probe.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>mysqli_rpl_probe</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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 class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> and <em class='emphasis'>REMOVED</em> as of PHP 5.3.0.</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="mysqli_rpl_parse_enabled" value="<div id='function.mysqli-rpl-parse-enabled' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-rpl-parse-enabled.php'>mysqli_rpl_parse_enabled</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_rpl_parse_enabled</span> &amp;mdash; <span class='dc-title'>Check if RPL parse is enabled</span></p> </div> <a name='function.mysqli-rpl-parse-enabled.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>mysqli_rpl_parse_enabled</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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 class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> and <em class='emphasis'>REMOVED</em> as of PHP 5.3.0.</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="mysqli_rollback" value="<div id='mysqli.rollback' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.rollback.php'>mysqli::rollback</a></h1> <h1 class='refname'>mysqli_rollback</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::rollback</span> -- <span class='refname'>mysqli_rollback</span> &amp;mdash; <span class='dc-title'>Rolls back current transaction</span></p> </div> <a name='mysqli.rollback.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::rollback</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_rollback</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Rollbacks the current transaction for the database. </p> </div> <a name='mysqli.rollback.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.rollback.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='mysqli.rollback.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;disable&amp;nbsp;autocommit&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>FALSE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ALTER&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;Type=InnoDB'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCity&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;LIMIT&amp;nbsp;50'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;commit&amp;nbsp;insert&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>commit</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;delete&amp;nbsp;all&amp;nbsp;rows&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;myCity'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;COUNT(*)&amp;nbsp;FROM&amp;nbsp;myCity'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</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: #DD0000'>'%d&amp;nbsp;rows&amp;nbsp;in&amp;nbsp;table&amp;nbsp;myCity.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Free&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Rollback&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>rollback</span><span style='color: #007700'>();<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;COUNT(*)&amp;nbsp;FROM&amp;nbsp;myCity'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</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: #DD0000'>'%d&amp;nbsp;rows&amp;nbsp;in&amp;nbsp;table&amp;nbsp;myCity&amp;nbsp;(after&amp;nbsp;rollback).\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Free&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Drop&amp;nbsp;table&amp;nbsp;myCity&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCity'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;disable&amp;nbsp;autocommit&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FALSE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ALTER&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;Type=InnoDB'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCity&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;LIMIT&amp;nbsp;50'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;commit&amp;nbsp;insert&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;delete&amp;nbsp;all&amp;nbsp;rows&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;myCity'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;COUNT(*)&amp;nbsp;FROM&amp;nbsp;myCity'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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: #DD0000'>'%d&amp;nbsp;rows&amp;nbsp;in&amp;nbsp;table&amp;nbsp;myCity.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Free&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Rollback&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_rollback</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;COUNT(*)&amp;nbsp;FROM&amp;nbsp;myCity'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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: #DD0000'>'%d&amp;nbsp;rows&amp;nbsp;in&amp;nbsp;table&amp;nbsp;myCity&amp;nbsp;(after&amp;nbsp;rollback).\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Free&amp;nbsp;result&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Drop&amp;nbsp;table&amp;nbsp;myCity&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCity'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> 0 rows in table myCity. 50 rows in table myCity (after rollback). </pre></div> </div> </div> <a name='mysqli.rollback.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/mysqli.commit.php' class='function' rel='rdfs-seeAlso'>mysqli_commit()</a> - Commits the current transaction</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.autocommit.php' class='function' rel='rdfs-seeAlso'>mysqli_autocommit()</a> - Turns on or off auto-commiting database modifications</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="MySQLi_Result" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.mysqli-result.php'>The MySQLi_Result class</a></h1> <div class='partintro'> <div id='mysqli-result.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> Represents the result set obtained from a query against the database. </p> </div> <div id='mysqli-result.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>MySQLi_Result</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>MySQLi_Result</b> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Properties */</div> <div class='fieldsynopsis'> <span class='type'>int</span> <var class='varname'>$current_field</var> ;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$field_count</var>;</div> <div class='fieldsynopsis'><span class='type'>array</span> <var class='varname'>$lengths</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$num_rows</var>;</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.current-field.php' class='function'>mysqli_field_tell</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.data-seek.php' class='function'>mysqli_result::data_seek</a></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mixed</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.fetch-all.php' class='function'>mysqli_result::fetch_all</a></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resulttype</tt></span> ] )</div> <div class='methodsynopsis dc-description'> <span class='type'>mixed</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.fetch-array.php' class='function'>mysqli_result::fetch_array</a></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resulttype</tt></span> ] )</div> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.fetch-assoc.php' class='function'>mysqli_result::fetch_assoc</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.fetch-field-direct.php' class='function'>mysqli_result::fetch_field_direct</a></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$fieldnr</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.fetch-field.php' class='function'>mysqli_result::fetch_field</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.fetch-fields.php' class='function'>mysqli_result::fetch_fields</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.fetch-object.php' class='function'>mysqli_result::fetch_object</a></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$class_name</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$params</tt></span> ]] )</div> <div class='methodsynopsis dc-description'> <span class='type'>mixed</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.fetch-row.php' class='function'>mysqli_result::fetch_row</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/mysqli-result.field-count.php' class='function'>mysqli_num_fields</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.field-seek.php' class='function'>mysqli_result::field_seek</a></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$fieldnr</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.free.php' class='function'>mysqli_result::free</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.lengths.php' class='function'>mysqli_fetch_lengths</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-result.num-rows.php' class='function'>mysqli_num_rows</a></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> }</div> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/mysqli-result.current-field.php'>mysqli_result->current_field</a> &amp;acirc;&amp;#128;&amp;#148; Get current field offset of a result pointer</li><li><a href='http://www.php.net/manual/en/mysqli-result.data-seek.php'>mysqli_result::data_seek</a> &amp;acirc;&amp;#128;&amp;#148; Adjusts the result pointer to an arbitary row in the result</li><li><a href='http://www.php.net/manual/en/mysqli-result.fetch-all.php'>mysqli_result::fetch_all</a> &amp;acirc;&amp;#128;&amp;#148; Fetches all result rows as an associative array, a numeric array, or both</li><li><a href='http://www.php.net/manual/en/mysqli-result.fetch-array.php'>mysqli_result::fetch_array</a> &amp;acirc;&amp;#128;&amp;#148; Fetch a result row as an associative, a numeric array, or both</li><li><a href='http://www.php.net/manual/en/mysqli-result.fetch-assoc.php'>mysqli_result::fetch_assoc</a> &amp;acirc;&amp;#128;&amp;#148; Fetch a result row as an associative array</li><li><a href='http://www.php.net/manual/en/mysqli-result.fetch-field-direct.php'>mysqli_result::fetch_field_direct</a> &amp;acirc;&amp;#128;&amp;#148; Fetch meta-data for a single field</li><li><a href='http://www.php.net/manual/en/mysqli-result.fetch-field.php'>mysqli_result::fetch_field</a> &amp;acirc;&amp;#128;&amp;#148; Returns the next field in the result set</li><li><a href='http://www.php.net/manual/en/mysqli-result.fetch-fields.php'>mysqli_result::fetch_fields</a> &amp;acirc;&amp;#128;&amp;#148; Returns an array of objects representing the fields in a result set</li><li><a href='http://www.php.net/manual/en/mysqli-result.fetch-object.php'>mysqli_result::fetch_object</a> &amp;acirc;&amp;#128;&amp;#148; Returns the current row of a result set as an object</li><li><a href='http://www.php.net/manual/en/mysqli-result.fetch-row.php'>mysqli_result::fetch_row</a> &amp;acirc;&amp;#128;&amp;#148; Get a result row as an enumerated array</li><li><a href='http://www.php.net/manual/en/mysqli-result.field-count.php'>mysqli_result->field_count</a> &amp;acirc;&amp;#128;&amp;#148; Get the number of fields in a result</li><li><a href='http://www.php.net/manual/en/mysqli-result.field-seek.php'>mysqli_result::field_seek</a> &amp;acirc;&amp;#128;&amp;#148; Set result pointer to a specified field offset</li><li><a href='http://www.php.net/manual/en/mysqli-result.free.php'>mysqli_result::free</a> &amp;acirc;&amp;#128;&amp;#148; Frees the memory associated with a result</li><li><a href='http://www.php.net/manual/en/mysqli-result.lengths.php'>mysqli_result->lengths</a> &amp;acirc;&amp;#128;&amp;#148; Returns the lengths of the columns of the current row in the result set</li><li><a href='http://www.php.net/manual/en/mysqli-result.num-rows.php'>mysqli_result->num_rows</a> &amp;acirc;&amp;#128;&amp;#148; Gets the number of rows in a result</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="mysqli_report" value="<div id='function.mysqli-report' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-report.php'>mysqli_report</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_report</span> &amp;mdash; <span class='dc-title'>Enables or disables internal report functions</span></p> </div> <a name='function.mysqli-report.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>mysqli_report</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt></span> )</div> <p class='para rdfs-comment'> <b>mysqli_report()</b> is a powerful function to improve your queries and code during development and testing phase. Depending on the flags it reports errors from mysqli function calls or queries which don&amp;#039;t use an index (or use a bad index). </p> </div> <a name='function.mysqli-report.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'>flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p><table class='doctable table'> <caption><b>Supported flags</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'><b><tt class='constant'>MYSQLI_REPORT_OFF</tt></b></td> <td align='left'>Turns reporting off</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_REPORT_ERROR</tt></b></td> <td align='left'>Report errors from mysqli function calls</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_REPORT_STRICT</tt></b></td> <td align='left'>Report warnings from mysqli function calls</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_REPORT_INDEX</tt></b></td> <td align='left'>Report if no index or bad index was used in a query</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_REPORT_ALL</tt></b></td> <td align='left'>Set all options (report all)</td> </tr> </tbody> </table> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.mysqli-report.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.mysqli-report.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Object oriented style</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;activate&amp;nbsp;reporting&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_report</span><span style='color: #007700'>(</span><span style='color: #0000BB'>MYSQLI_REPORT_ALL</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;this&amp;nbsp;query&amp;nbsp;should&amp;nbsp;report&amp;nbsp;an&amp;nbsp;error&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;Nonexistingtable&amp;nbsp;WHERE&amp;nbsp;population&amp;nbsp;&amp;gt;&amp;nbsp;50000'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;this&amp;nbsp;query&amp;nbsp;should&amp;nbsp;report&amp;nbsp;a&amp;nbsp;warning&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;WHERE&amp;nbsp;population&amp;nbsp;&amp;gt;&amp;nbsp;50000'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result</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'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</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.mysqli-report.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/mysqli.debug.php' class='function' rel='rdfs-seeAlso'>mysqli_debug()</a> - Performs debugging operations</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.dump-debug-info.php' class='function' rel='rdfs-seeAlso'>mysqli_dump_debug_info()</a> - Dump debugging information into the log</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="mysqli_real_query" value="<div id='mysqli.real-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.real-query.php'>mysqli::real_query</a></h1> <h1 class='refname'>mysqli_real_query</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::real_query</span> -- <span class='refname'>mysqli_real_query</span> &amp;mdash; <span class='dc-title'>Execute an SQL query</span></p> </div> <a name='mysqli.real-query.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::real_query</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_real_query</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'> Executes a single query against the database whose result can then be retrieved or stored using the <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a> functions. </p> <p class='para'> In order to determine if a given query should return a result set or not, see <a href='http://www.php.net/manual/en/mysqli.field-count.php' class='function'>mysqli_field_count()</a>. </p> </div> <a name='mysqli.real-query.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The query, as a string. </p> <p class='para'> Data inside the query should be <a href='http://www.php.net/manual/en/mysqli.real-escape-string.php' class='link'>properly escaped</a>. </p> </dd> </dl> <p> </p> </div> <a name='mysqli.real-query.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='mysqli.real-query.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/mysqli.query.php' class='function' rel='rdfs-seeAlso'>mysqli_query()</a> - Performs a query on the database</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_store_result()</a> - Transfers a result set from the last query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function' rel='rdfs-seeAlso'>mysqli_use_result()</a> - Initiate a result set retrieval</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="mysqli_real_escape_string" value="<div id='mysqli.real-escape-string' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.real-escape-string.php'>mysqli::real_escape_string</a></h1> <h1 class='refname'>mysqli_real_escape_string</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::real_escape_string</span> -- <span class='refname'>mysqli_real_escape_string</span> &amp;mdash; <span class='dc-title'>Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection</span></p> </div> <a name='mysqli.real-escape-string.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (both methods are equivalent):</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/function.mysqli-escape-string.php' class='function'>mysqli::escape_string</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$escapestr</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli::real_escape_string</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$escapestr</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_real_escape_string</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$escapestr</tt></span> )</div> <p class='para rdfs-comment'> This function is used to create a legal SQL string that you can use in an SQL statement. The given string is encoded to an escaped SQL string, taking into account the current character set of the connection. </p> </div> <a name='mysqli.real-escape-string.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>escapestr</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to be escaped. </p> <p class='para'> Characters encoded are <i>NUL (ASCII 0), \n, \r, \, &amp;#039;, &amp;quot;, and Control-Z</i>. </p> </dd> </dl> <p> </p> </div> <a name='mysqli.real-escape-string.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an escaped string. </p> </div> <a name='mysqli.real-escape-string.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TEMPORARY&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$city&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>''s&amp;nbsp;Hertogenbosch'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;this&amp;nbsp;query&amp;nbsp;will&amp;nbsp;fail,&amp;nbsp;cause&amp;nbsp;we&amp;nbsp;didn't&amp;nbsp;escape&amp;nbsp;$city&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;into&amp;nbsp;myCity&amp;nbsp;(Name)&amp;nbsp;VALUES&amp;nbsp;('</span><span style='color: #0000BB'>$city</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>sqlstate</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>$city&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>real_escape_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$city</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;this&amp;nbsp;query&amp;nbsp;with&amp;nbsp;escaped&amp;nbsp;$city&amp;nbsp;will&amp;nbsp;work&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;into&amp;nbsp;myCity&amp;nbsp;(Name)&amp;nbsp;VALUES&amp;nbsp;('</span><span style='color: #0000BB'>$city</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%d&amp;nbsp;Row&amp;nbsp;inserted.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>affected_rows</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TEMPORARY&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$city&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>''s&amp;nbsp;Hertogenbosch'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;this&amp;nbsp;query&amp;nbsp;will&amp;nbsp;fail,&amp;nbsp;cause&amp;nbsp;we&amp;nbsp;didn't&amp;nbsp;escape&amp;nbsp;$city&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;into&amp;nbsp;myCity&amp;nbsp;(Name)&amp;nbsp;VALUES&amp;nbsp;('</span><span style='color: #0000BB'>$city</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_sqlstate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />}<br /><br /></span><span style='color: #0000BB'>$city&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_real_escape_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$city</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;this&amp;nbsp;query&amp;nbsp;with&amp;nbsp;escaped&amp;nbsp;$city&amp;nbsp;will&amp;nbsp;work&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;into&amp;nbsp;myCity&amp;nbsp;(Name)&amp;nbsp;VALUES&amp;nbsp;('</span><span style='color: #0000BB'>$city</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%d&amp;nbsp;Row&amp;nbsp;inserted.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_affected_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Error: 42000 1 Row inserted. </pre></div> </div> </div> <a name='mysqli.real-escape-string.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/mysqli.character-set-name.php' class='function' rel='rdfs-seeAlso'>mysqli_character_set_name()</a> - Returns the default character set for the database 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="mysqli_real_connect" value="<div id='mysqli.real-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.real-connect.php'>mysqli::real_connect</a></h1> <h1 class='refname'>mysqli_real_connect</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::real_connect</span> -- <span class='refname'>mysqli_real_connect</span> &amp;mdash; <span class='dc-title'>Opens a connection to a mysql server</span></p> </div> <a name='mysqli.real-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method)</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::real_connect</b></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'>$username</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$passwd</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dbname</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$socket</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt></span> ]]]]]]] )</div> <p class='para rdfs-comment'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_real_connect</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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'>$username</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$passwd</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dbname</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$socket</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt></span> ]]]]]]] )</div> <p class='para rdfs-comment'> Establish a connection to a MySQL database engine. </p> <p class='para'> This function differs from <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a>: </p> <ul class='itemizedlist'> <li class='listitem'> <p class='para'> <b>mysqli_real_connect()</b> needs a valid object which has to be created by function <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a>. </p> </li> <li class='listitem'> <p class='para'> With the <a href='http://www.php.net/manual/en/mysqli.options.php' class='function'>mysqli_options()</a> function you can set various options for connection. </p> </li> <li class='listitem'> <p class='para'> There is a <i><tt class='parameter'>flags</tt></i> parameter. </p> </li> </ul> </div> <a name='mysqli.real-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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>host</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be either a host name or an IP address. Passing the <b><tt class='constant'>NULL</tt></b> value or the string &amp;quot;localhost&amp;quot; to this parameter, the local host is assumed. When possible, pipes will be used instead of the TCP/IP protocol. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The MySQL user name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>passwd</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If provided or <b><tt class='constant'>NULL</tt></b>, the MySQL server will attempt to authenticate the user against those user records which have no password only. This allows one username to be used with different permissions (depending on if a password as provided or not). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dbname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If provided will specify the default database to be used when performing queries. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the port number to attempt to connect to the MySQL server. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the socket or named pipe that should be used. </p> <blockquote><p><b class='note'>Note</b>: Specifying the <i><tt class='parameter'>socket</tt></i> parameter will not explicitly determine the type of connection to be used when connecting to the MySQL server. How the connection is made to the MySQL database is determined by the <i><tt class='parameter'>host</tt></i> parameter. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> With the parameter <i><tt class='parameter'>flags</tt></i> you can set different connection options: </p> <table class='doctable table'> <caption><b>Supported flags</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'><b><tt class='constant'>MYSQLI_CLIENT_COMPRESS</tt></b></td> <td align='left'>Use compression protocol</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_CLIENT_FOUND_ROWS</tt></b></td> <td align='left'>return number of matched rows, not the number of affected rows</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_CLIENT_IGNORE_SPACE</tt></b></td> <td align='left'>Allow spaces after function names. Makes all function names reserved words.</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_CLIENT_INTERACTIVE</tt></b></td> <td align='left'> Allow <i>interactive_timeout</i> seconds (instead of <i>wait_timeout</i> seconds) of inactivity before closing the connection </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_CLIENT_SSL</tt></b></td> <td align='left'>Use SSL (encryption)</td> </tr> </tbody> </table> <blockquote><p><b class='note'>Note</b>: For security reasons the <b><tt class='constant'>MULTI_STATEMENT</tt></b> flag is not supported in PHP. If you want to execute multiple queries use the <a href='http://www.php.net/manual/en/mysqli.multi-query.php' class='function'>mysqli_multi_query()</a> function. <br /> </p></blockquote> </dd> </dl> <p> </p> </div> <a name='mysqli.real-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='mysqli.real-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_init</span><span style='color: #007700'>();<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'mysqli_init&amp;nbsp;failed'</span><span style='color: #007700'>);<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>options</span><span style='color: #007700'>(</span><span style='color: #0000BB'>MYSQLI_INIT_COMMAND</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SET&amp;nbsp;AUTOCOMMIT&amp;nbsp;=&amp;nbsp;0'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Setting&amp;nbsp;MYSQLI_INIT_COMMAND&amp;nbsp;failed'</span><span style='color: #007700'>);<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>options</span><span style='color: #007700'>(</span><span style='color: #0000BB'>MYSQLI_OPT_CONNECT_TIMEOUT</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Setting&amp;nbsp;MYSQLI_OPT_CONNECT_TIMEOUT&amp;nbsp;failed'</span><span style='color: #007700'>);<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>real_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_db'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error&amp;nbsp;('&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>')&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: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Success...&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>host_info&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'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Object oriented style when extending mysqli class</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'>class&amp;nbsp;</span><span style='color: #0000BB'>foo_mysqli&amp;nbsp;</span><span style='color: #007700'>extends&amp;nbsp;</span><span style='color: #0000BB'>mysqli&amp;nbsp;</span><span style='color: #007700'>{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;public&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>__construct</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$host</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$pass</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>parent</span><span style='color: #007700'>::</span><span style='color: #0000BB'>init</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'>parent</span><span style='color: #007700'>::</span><span style='color: #0000BB'>options</span><span style='color: #007700'>(</span><span style='color: #0000BB'>MYSQLI_INIT_COMMAND</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SET&amp;nbsp;AUTOCOMMIT&amp;nbsp;=&amp;nbsp;0'</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;die(</span><span style='color: #DD0000'>'Setting&amp;nbsp;MYSQLI_INIT_COMMAND&amp;nbsp;failed'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<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'>parent</span><span style='color: #007700'>::</span><span style='color: #0000BB'>options</span><span style='color: #007700'>(</span><span style='color: #0000BB'>MYSQLI_OPT_CONNECT_TIMEOUT</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>5</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;die(</span><span style='color: #DD0000'>'Setting&amp;nbsp;MYSQLI_OPT_CONNECT_TIMEOUT&amp;nbsp;failed'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<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'>parent</span><span style='color: #007700'>::</span><span style='color: #0000BB'>real_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$host</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$pass</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$db</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;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error&amp;nbsp;('&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>')&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;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</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'>$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>foo_mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_db'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Success...&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>host_info&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'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #3 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_init</span><span style='color: #007700'>();<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'mysqli_init&amp;nbsp;failed'</span><span style='color: #007700'>);<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_options</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MYSQLI_INIT_COMMAND</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SET&amp;nbsp;AUTOCOMMIT&amp;nbsp;=&amp;nbsp;0'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Setting&amp;nbsp;MYSQLI_INIT_COMMAND&amp;nbsp;failed'</span><span style='color: #007700'>);<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_options</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MYSQLI_OPT_CONNECT_TIMEOUT</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Setting&amp;nbsp;MYSQLI_OPT_CONNECT_TIMEOUT&amp;nbsp;failed'</span><span style='color: #007700'>);<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_real_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_db'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error&amp;nbsp;('&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>')&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: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Success...&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_get_host_info</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Success... MySQL host info: localhost via TCP/IP </pre></div> </div> </div> <a name='mysqli.real-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/mysqli.connect.php' class='function' rel='rdfs-seeAlso'>mysqli_connect()</a> - Open a new connection to the MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.init.php' class='function' rel='rdfs-seeAlso'>mysqli_init()</a> - Initializes MySQLi and returns a resource for use with mysqli_real_connect()</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.options.php' class='function' rel='rdfs-seeAlso'>mysqli_options()</a> - Set options</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.ssl-set.php' class='function' rel='rdfs-seeAlso'>mysqli_ssl_set()</a> - Used for establishing secure connections using SSL</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.close.php' class='function' rel='rdfs-seeAlso'>mysqli_close()</a> - Closes a previously opened database 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="mysqli_query" value="<div id='mysqli.query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.query.php'>mysqli::query</a></h1> <h1 class='refname'>mysqli_query</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::query</span> -- <span class='refname'>mysqli_query</span> &amp;mdash; <span class='dc-title'>Performs a query on the database</span></p> </div> <a name='mysqli.query.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</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>mysqli::query</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resultmode</tt></span> ] )</div> <p class='para rdfs-comment'>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>mysqli_query</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resultmode</tt></span> ] )</div> <p class='para rdfs-comment'> Performs a <i><tt class='parameter'>query</tt></i> against the database. </p> <p class='para'> Functionally, using this function is identical to calling <a href='http://www.php.net/manual/en/mysqli.real-query.php' class='function'>mysqli_real_query()</a> followed either by <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a> or <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a>. </p> </div> <a name='mysqli.query.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The query string. </p> <p class='para'> Data inside the query should be <a href='http://www.php.net/manual/en/mysqli.real-escape-string.php' class='link'>properly escaped</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>resultmode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Either the constant <b><tt class='constant'>MYSQLI_USE_RESULT</tt></b> or <b><tt class='constant'>MYSQLI_STORE_RESULT</tt></b> depending on the desired behavior. By default, <b><tt class='constant'>MYSQLI_STORE_RESULT</tt></b> is used. </p> <p class='para'> If you use <b><tt class='constant'>MYSQLI_USE_RESULT</tt></b> all subsequent calls will return error <i>Commands out of sync</i> unless you call <a href='http://www.php.net/manual/en/mysqli-result.free.php' class='function'>mysqli_free_result()</a> </p> <p class='para'> With <b><tt class='constant'>MYSQLI_ASYNC</tt></b> (available with mysqlnd), it is possible to perform query asynchronously. <a href='http://www.php.net/manual/en/mysqli.poll.php' class='function'>mysqli_poll()</a> is then used to get results from such queries. </p> </dd> </dl> <p> </p> </div> <a name='mysqli.query.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. For <i>SELECT, SHOW, DESCRIBE</i> or <i>EXPLAIN</i> <b>mysqli_query()</b> will return a result object. </p> </div> <a name='mysqli.query.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.3.0</td> <td align='left'> Added the ability of async queries. </td> </tr> </tbody> </table> <p> </p> </div> <a name='mysqli.query.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;table&amp;nbsp;doesn't&amp;nbsp;return&amp;nbsp;a&amp;nbsp;resultset&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TEMPORARY&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>)&amp;nbsp;===&amp;nbsp;</span><span style='color: #0000BB'>TRUE</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Table&amp;nbsp;myCity&amp;nbsp;successfully&amp;nbsp;created.\n'</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Select&amp;nbsp;queries&amp;nbsp;return&amp;nbsp;a&amp;nbsp;resultset&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;LIMIT&amp;nbsp;10'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Select&amp;nbsp;returned&amp;nbsp;%d&amp;nbsp;rows.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>num_rows</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;If&amp;nbsp;we&amp;nbsp;have&amp;nbsp;to&amp;nbsp;retrieve&amp;nbsp;large&amp;nbsp;amount&amp;nbsp;of&amp;nbsp;data&amp;nbsp;we&amp;nbsp;use&amp;nbsp;MYSQLI_USE_RESULT&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;City'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MYSQLI_USE_RESULT</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Note,&amp;nbsp;that&amp;nbsp;we&amp;nbsp;can't&amp;nbsp;execute&amp;nbsp;any&amp;nbsp;functions&amp;nbsp;which&amp;nbsp;interact&amp;nbsp;with&amp;nbsp;the<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;server&amp;nbsp;until&amp;nbsp;result&amp;nbsp;set&amp;nbsp;was&amp;nbsp;closed.&amp;nbsp;All&amp;nbsp;calls&amp;nbsp;will&amp;nbsp;return&amp;nbsp;an<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'out&amp;nbsp;of&amp;nbsp;sync'&amp;nbsp;error&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SET&amp;nbsp;@a:='this&amp;nbsp;will&amp;nbsp;not&amp;nbsp;work''</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>error</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'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;table&amp;nbsp;doesn't&amp;nbsp;return&amp;nbsp;a&amp;nbsp;resultset&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TEMPORARY&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>)&amp;nbsp;===&amp;nbsp;</span><span style='color: #0000BB'>TRUE</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Table&amp;nbsp;myCity&amp;nbsp;successfully&amp;nbsp;created.\n'</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Select&amp;nbsp;queries&amp;nbsp;return&amp;nbsp;a&amp;nbsp;resultset&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;LIMIT&amp;nbsp;10'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Select&amp;nbsp;returned&amp;nbsp;%d&amp;nbsp;rows.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;If&amp;nbsp;we&amp;nbsp;have&amp;nbsp;to&amp;nbsp;retrieve&amp;nbsp;large&amp;nbsp;amount&amp;nbsp;of&amp;nbsp;data&amp;nbsp;we&amp;nbsp;use&amp;nbsp;MYSQLI_USE_RESULT&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;City'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MYSQLI_USE_RESULT</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Note,&amp;nbsp;that&amp;nbsp;we&amp;nbsp;can't&amp;nbsp;execute&amp;nbsp;any&amp;nbsp;functions&amp;nbsp;which&amp;nbsp;interact&amp;nbsp;with&amp;nbsp;the<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;server&amp;nbsp;until&amp;nbsp;result&amp;nbsp;set&amp;nbsp;was&amp;nbsp;closed.&amp;nbsp;All&amp;nbsp;calls&amp;nbsp;will&amp;nbsp;return&amp;nbsp;an<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'out&amp;nbsp;of&amp;nbsp;sync'&amp;nbsp;error&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SET&amp;nbsp;@a:='this&amp;nbsp;will&amp;nbsp;not&amp;nbsp;work''</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Table myCity successfully created. Select returned 10 rows. Error: Commands out of sync; You can&amp;#039;t run this command now </pre></div> </div> </div> <a name='mysqli.query.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/mysqli.real-query.php' class='function' rel='rdfs-seeAlso'>mysqli_real_query()</a> - Execute an SQL query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.multi-query.php' class='function' rel='rdfs-seeAlso'>mysqli_multi_query()</a> - Performs a query on the database</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.free.php' class='function' rel='rdfs-seeAlso'>mysqli_free_result()</a> - Frees the memory associated with a result</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="mysqli_prepare" value="<div id='mysqli.prepare' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.prepare.php'>mysqli::prepare</a></h1> <h1 class='refname'>mysqli_prepare</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::prepare</span> -- <span class='refname'>mysqli_prepare</span> &amp;mdash; <span class='dc-title'>Prepare a SQL statement for execution</span></p> </div> <a name='mysqli.prepare.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method)</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <span class='methodname'><b>mysqli::prepare</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'>Procedure style:</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type mysqli_stmt'>mysqli_stmt</span></span> <span class='methodname'><b>mysqli_prepare</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'> Prepares the SQL query pointed to by the null-terminated string query, and returns a statement handle to be used for further operations on the statement. The query must consist of a single SQL statement. </p> <p class='para'> The parameter markers must be bound to application variables using <a href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php' class='function'>mysqli_stmt_bind_param()</a> and/or <a href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php' class='function'>mysqli_stmt_bind_result()</a> before executing the statement or fetching rows. </p> </div> <a name='mysqli.prepare.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The query, as a string. </p> <blockquote><p><b class='note'>Note</b>: You should not add a terminating semicolon or <i>\g</i> to the statement. <br /> </p></blockquote> <p class='para'> This parameter can include one or more parameter markers in the SQL statement by embedding question mark (<i>?</i>) characters at the appropriate positions. </p> <blockquote><p><b class='note'>Note</b>: The markers are legal only in certain places in SQL statements. For example, they are allowed in the <i>VALUES()</i> list of an <i>INSERT</i> statement (to specify column values for a row), or in a comparison with a column in a <i>WHERE</i> clause to specify a comparison value. <br /> However, they are not allowed for identifiers (such as table or column names), in the select list that names the columns to be returned by a <i>SELECT</i> statement, or to specify both operands of a binary operator such as the <i>=</i> equal sign. The latter restriction is necessary because it would be impossible to determine the parameter type. It&amp;#039;s not allowed to compare marker with <i>NULL</i> by <i>? IS NULL</i> too. In general, parameters are legal only in Data Manipulation Language (DML) statements, and not in Data Definition Language (DDL) statements. <br /> </p></blockquote> </dd> </dl> <p> </p> </div> <a name='mysqli.prepare.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>mysqli_prepare()</b> returns a statement object or <b><tt class='constant'>FALSE</tt></b> if an error occurred. </p> </div> <a name='mysqli.prepare.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$city&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Amersfoort'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;create&amp;nbsp;a&amp;nbsp;prepared&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>prepare</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;District&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;WHERE&amp;nbsp;Name=?'</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;parameters&amp;nbsp;for&amp;nbsp;markers&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_param</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'s'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$city</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>execute</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;result&amp;nbsp;variables&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>bind_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$district</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;value&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;is&amp;nbsp;in&amp;nbsp;district&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$city</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$district</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$city&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Amersfoort'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;create&amp;nbsp;a&amp;nbsp;prepared&amp;nbsp;statement&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;District&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;WHERE&amp;nbsp;Name=?'</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;parameters&amp;nbsp;for&amp;nbsp;markers&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'s'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$city</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;bind&amp;nbsp;result&amp;nbsp;variables&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_bind_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$district</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;value&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_fetch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;is&amp;nbsp;in&amp;nbsp;district&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$city</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$district</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;statement&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_stmt_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Amersfoort is in district Utrecht </pre></div> </div> </div> <a name='mysqli.prepare.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/mysqli-stmt.execute.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_execute()</a> - Executes a prepared Query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_fetch()</a> - Fetch results from a prepared statement into the bound variables</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_param()</a> - Binds variables to a prepared statement as parameters</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_result()</a> - Binds variables to a prepared statement for result storage</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.close.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_close()</a> - Closes a prepared statement</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="mysqli_ping" value="<div id='mysqli.ping' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.ping.php'>mysqli::ping</a></h1> <h1 class='refname'>mysqli_ping</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::ping</span> -- <span class='refname'>mysqli_ping</span> &amp;mdash; <span class='dc-title'>Pings a server connection, or tries to reconnect if the connection has gone down</span></p> </div> <a name='mysqli.ping.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::ping</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_ping</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Checks whether the connection to the server is working. If it has gone down, and global option <i>mysqli.reconnect</i> is enabled an automatic reconnection is attempted. </p> <p class='para'> This function can be used by clients that remain idle for a long while, to check whether the server has closed the connection and reconnect if necessary. </p> </div> <a name='mysqli.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.ping.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='mysqli.ping.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;if&amp;nbsp;server&amp;nbsp;is&amp;nbsp;alive&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>ping</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Our&amp;nbsp;connection&amp;nbsp;is&amp;nbsp;ok!\n'</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'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>error</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;if&amp;nbsp;server&amp;nbsp;is&amp;nbsp;alive&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_ping</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Our&amp;nbsp;connection&amp;nbsp;is&amp;nbsp;ok!\n'</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'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Our connection is ok! </pre></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="mysqli_param_count" value="<div id='function.mysqli-param-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-param-count.php'>mysqli_param_count</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_param_count</span> &amp;mdash; <span class='dc-title'>Alias for <a href='http://www.php.net/manual/en/mysqli-stmt.param-count.php' class='function'>mysqli_stmt_param_count()</a></span></p> </div> <a name='function.mysqli-param-count.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of <a href='http://www.php.net/manual/en/mysqli-stmt.param-count.php' class='function'>mysqli_stmt_param_count()</a>. </p> </div> <a name='function.mysqli-param-count.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>mysqli_param_count()</b> is deprecated and will be removed. <br /> </p></blockquote> </div> <a name='function.mysqli-param-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/mysqli-stmt.param-count.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_param_count()</a> - Returns the number of parameter for the given statement</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="mysqli_options" value="<div id='mysqli.options' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.options.php'>mysqli::options</a></h1> <h1 class='refname'>mysqli_options</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::options</span> -- <span class='refname'>mysqli_options</span> &amp;mdash; <span class='dc-title'>Set options</span></p> </div> <a name='mysqli.options.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method)</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::options</b></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'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_options</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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'> Used to set extra connect options and affect behavior for a connection. </p> <p class='para'> This function may be called multiple times to set several options. </p> <p class='para'> <b>mysqli_options()</b> should be called after <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> and before <a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function'>mysqli_real_connect()</a>. </p> </div> <a name='mysqli.options.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The option that you want to set. It can be one of the following values: </p><table class='doctable table'> <caption><b>Valid options</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'><b><tt class='constant'>MYSQLI_OPT_CONNECT_TIMEOUT</tt></b></td> <td align='left'>connection timeout in seconds</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_OPT_LOCAL_INFILE</tt></b></td> <td align='left'>enable/disable use of <i>LOAD LOCAL INFILE</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_INIT_COMMAND</tt></b></td> <td align='left'>command to execute after when connecting to MySQL server</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_READ_DEFAULT_FILE</tt></b></td> <td align='left'> Read options from named option file instead of <var class='filename'>my.cnf</var> </td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>MYSQLI_READ_DEFAULT_GROUP</tt></b></td> <td align='left'> Read options from the named group from <var class='filename'>my.cnf</var> or the file specified with <b><tt class='constant'>MYSQL_READ_DEFAULT_FILE</tt></b>. </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'> The value for the option. </p> </dd> </dl> <p> </p> </div> <a name='mysqli.options.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='mysqli.options.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> See <a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function'>mysqli_real_connect()</a>. </p> </div> <a name='mysqli.options.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/mysqli.init.php' class='function' rel='rdfs-seeAlso'>mysqli_init()</a> - Initializes MySQLi and returns a resource for use with mysqli_real_connect()</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function' rel='rdfs-seeAlso'>mysqli_real_connect()</a> - Opens a connection to a mysql 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="mysqli_num_rows" value="<div id='mysqli-result.num-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.num-rows.php'>mysqli_result-&amp;gt;num_rows</a></h1> <h1 class='refname'>mysqli_num_rows</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result-&amp;gt;num_rows</span> -- <span class='refname'>mysqli_num_rows</span> &amp;mdash; <span class='dc-title'>Gets the number of rows in a result</span></p> </div> <a name='mysqli-result.num-rows.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-result.php' class='classname'>mysqli_result</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$num_rows</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_num_rows</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of rows in the result set. </p> <p class='para'> The use of <b>mysqli_num_rows()</b> depends on whether you use buffered or unbuffered result sets. In case you use unbuffered resultsets <b>mysqli_num_rows()</b> will not correct the correct number of rows until all the rows in the result have been retrieved. </p> </div> <a name='mysqli-result.num-rows.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-result.num-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns number of rows in the result set. </p> <blockquote><p><b class='note'>Note</b>: If the number of rows is greater than maximal int value, the number will be returned as a string. <br /> </p></blockquote> </div> <a name='mysqli-result.num-rows.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Code,&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;determine&amp;nbsp;number&amp;nbsp;of&amp;nbsp;rows&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row_cnt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>num_rows</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Result&amp;nbsp;set&amp;nbsp;has&amp;nbsp;%d&amp;nbsp;rows.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row_cnt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Code,&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;determine&amp;nbsp;number&amp;nbsp;of&amp;nbsp;rows&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row_cnt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Result&amp;nbsp;set&amp;nbsp;has&amp;nbsp;%d&amp;nbsp;rows.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row_cnt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Result set has 239 rows. </pre></div> </div> </div> <a name='mysqli-result.num-rows.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/mysqli.affected-rows.php' class='function' rel='rdfs-seeAlso'>mysqli_affected_rows()</a> - Gets the number of affected rows in a previous MySQL operation</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_store_result()</a> - Transfers a result set from the last query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function' rel='rdfs-seeAlso'>mysqli_use_result()</a> - Initiate a result set retrieval</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.query.php' class='function' rel='rdfs-seeAlso'>mysqli_query()</a> - Performs a query on the database</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="mysqli_num_fields" value="<div id='mysqli-result.field-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.field-count.php'>mysqli_result-&amp;gt;field_count</a></h1> <h1 class='refname'>mysqli_num_fields</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result-&amp;gt;field_count</span> -- <span class='refname'>mysqli_num_fields</span> &amp;mdash; <span class='dc-title'>Get the number of fields in a result</span></p> </div> <a name='mysqli-result.field-count.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-result.php' class='classname'>mysqli_result</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$field_count</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_num_fields</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of fields from specified result set. </p> </div> <a name='mysqli-result.field-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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-result.field-count.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The number of fields from a result set. </p> </div> <a name='mysqli-result.field-count.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;ID&amp;nbsp;LIMIT&amp;nbsp;1'</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;determine&amp;nbsp;number&amp;nbsp;of&amp;nbsp;fields&amp;nbsp;in&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$field_cnt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>field_count</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Result&amp;nbsp;set&amp;nbsp;has&amp;nbsp;%d&amp;nbsp;fields.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$field_cnt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;ID&amp;nbsp;LIMIT&amp;nbsp;1'</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;determine&amp;nbsp;number&amp;nbsp;of&amp;nbsp;fields&amp;nbsp;in&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$field_cnt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Result&amp;nbsp;set&amp;nbsp;has&amp;nbsp;%d&amp;nbsp;fields.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$field_cnt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Result set has 5 fields. </pre></div> </div> </div> <a name='mysqli-result.field-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/mysqli-result.fetch-field.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_field()</a> - Returns the next field in the result 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="mysqli_next_result" value="<div id='mysqli.next-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.next-result.php'>mysqli::next_result</a></h1> <h1 class='refname'>mysqli_next_result</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::next_result</span> -- <span class='refname'>mysqli_next_result</span> &amp;mdash; <span class='dc-title'>Prepare next result from multi_query</span></p> </div> <a name='mysqli.next-result.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>mysqli::next_result</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_next_result</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Prepares next result set from a previous call to <a href='http://www.php.net/manual/en/mysqli.multi-query.php' class='function'>mysqli_multi_query()</a> which can be retrieved by <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>. </p> </div> <a name='mysqli.next-result.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.next-result.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='mysqli.next-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> See <a href='http://www.php.net/manual/en/mysqli.multi-query.php' class='function'>mysqli_multi_query()</a>. </p> </div> <a name='mysqli.next-result.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/mysqli.multi-query.php' class='function' rel='rdfs-seeAlso'>mysqli_multi_query()</a> - Performs a query on the database</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.more-results.php' class='function' rel='rdfs-seeAlso'>mysqli_more_results()</a> - Check if there are any more query results from a multi query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_store_result()</a> - Transfers a result set from the last query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function' rel='rdfs-seeAlso'>mysqli_use_result()</a> - Initiate a result set retrieval</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="mysqli_multi_query" value="<div id='mysqli.multi-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.multi-query.php'>mysqli::multi_query</a></h1> <h1 class='refname'>mysqli_multi_query</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::multi_query</span> -- <span class='refname'>mysqli_multi_query</span> &amp;mdash; <span class='dc-title'>Performs a query on the database</span></p> </div> <a name='mysqli.multi-query.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::multi_query</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_multi_query</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'> Executes one or multiple queries which are concatenated by a semicolon. </p> <p class='para'> To retrieve the resultset from the first query you can use <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a> or <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a>. All subsequent query results can be processed using <a href='http://www.php.net/manual/en/mysqli.more-results.php' class='function'>mysqli_more_results()</a> and <a href='http://www.php.net/manual/en/mysqli.next-result.php' class='function'>mysqli_next_result()</a>. </p> </div> <a name='mysqli.multi-query.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The query, as a string. </p> <p class='para'> Data inside the query should be <a href='http://www.php.net/manual/en/mysqli.real-escape-string.php' class='link'>properly escaped</a>. </p> </dd> </dl> <p> </p> </div> <a name='mysqli.multi-query.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>FALSE</tt></b> if the first statement failed. To retrieve subsequent errors from other statements you have to call <a href='http://www.php.net/manual/en/mysqli.next-result.php' class='function'>mysqli_next_result()</a> first. </p> </div> <a name='mysqli.multi-query.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;CURRENT_USER();'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;ID&amp;nbsp;LIMIT&amp;nbsp;20,&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;multi&amp;nbsp;query&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>multi_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;do&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;store&amp;nbsp;first&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>store_result</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;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</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;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</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;}<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'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>free</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;divider&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>more_results</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'>printf</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>next_result</span><span style='color: #007700'>());<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;CURRENT_USER();'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;ID&amp;nbsp;LIMIT&amp;nbsp;20,&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;execute&amp;nbsp;multi&amp;nbsp;query&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_multi_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;do&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;store&amp;nbsp;first&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_store_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</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;}<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'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;divider&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_more_results</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>printf</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_next_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output something similar to:</p> <div class='example-contents screen'> <div class='cdata'><pre> my_user@localhost ----------------- Amersfoort Maastricht Dordrecht Leiden Haarlemmermeer </pre></div> </div> </div> <a name='mysqli.multi-query.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/mysqli.use-result.php' class='function' rel='rdfs-seeAlso'>mysqli_use_result()</a> - Initiate a result set retrieval</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_store_result()</a> - Transfers a result set from the last query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.next-result.php' class='function' rel='rdfs-seeAlso'>mysqli_next_result()</a> - Prepare next result from multi_query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.more-results.php' class='function' rel='rdfs-seeAlso'>mysqli_more_results()</a> - Check if there are any more query results from a multi query</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="mysqli_more_results" value="<div id='mysqli.more-results' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.more-results.php'>mysqli::more_results</a></h1> <h1 class='refname'>mysqli_more_results</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::more_results</span> -- <span class='refname'>mysqli_more_results</span> &amp;mdash; <span class='dc-title'>Check if there are any more query results from a multi query</span></p> </div> <a name='mysqli.more-results.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>mysqli::more_results</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_more_results</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Indicates if one or more result sets are available from a previous call to <a href='http://www.php.net/manual/en/mysqli.multi-query.php' class='function'>mysqli_multi_query()</a>. </p> </div> <a name='mysqli.more-results.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.more-results.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='mysqli.more-results.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'>See <a href='http://www.php.net/manual/en/mysqli.multi-query.php' class='function'>mysqli_multi_query()</a>.</p> </div> <a name='mysqli.more-results.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/mysqli.multi-query.php' class='function' rel='rdfs-seeAlso'>mysqli_multi_query()</a> - Performs a query on the database</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.next-result.php' class='function' rel='rdfs-seeAlso'>mysqli_next_result()</a> - Prepare next result from multi_query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_store_result()</a> - Transfers a result set from the last query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function' rel='rdfs-seeAlso'>mysqli_use_result()</a> - Initiate a result set retrieval</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="mysqli_master_query" value="<div id='function.mysqli-master-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-master-query.php'>mysqli_master_query</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_master_query</span> &amp;mdash; <span class='dc-title'>Enforce execution of a query on the master in a master/slave setup</span></p> </div> <a name='function.mysqli-master-query.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>mysqli_master_query</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</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 class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> and <em class='emphasis'>REMOVED</em> as of PHP 5.3.0.</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="mysqli_kill" value="<div id='mysqli.kill' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.kill.php'>mysqli::kill</a></h1> <h1 class='refname'>mysqli_kill</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::kill</span> -- <span class='refname'>mysqli_kill</span> &amp;mdash; <span class='dc-title'>Asks the server to kill a MySQL thread</span></p> </div> <a name='mysqli.kill.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method)</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::kill</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$processid</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_kill</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$processid</tt></span> )</div> <p class='para rdfs-comment'> This function is used to ask the server to kill a MySQL thread specified by the <i><tt class='parameter'>processid</tt></i> parameter. This value must be retrieved by calling the <a href='http://www.php.net/manual/en/mysqli.thread-id.php' class='function'>mysqli_thread_id()</a> function. </p> <p class='para'> To stop a running query you should use the SQL command <i>KILL QUERY processid</i>. </p> </div> <a name='mysqli.kill.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.kill.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='mysqli.kill.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;determine&amp;nbsp;our&amp;nbsp;thread&amp;nbsp;id&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$thread_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>thread_id</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Kill&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>kill</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$thread_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;This&amp;nbsp;should&amp;nbsp;produce&amp;nbsp;an&amp;nbsp;error&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>error</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;determine&amp;nbsp;our&amp;nbsp;thread&amp;nbsp;id&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$thread_id&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_thread_id</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Kill&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_kill</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$thread_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;This&amp;nbsp;should&amp;nbsp;produce&amp;nbsp;an&amp;nbsp;error&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Error: MySQL server has gone away </pre></div> </div> </div> <a name='mysqli.kill.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/mysqli.thread-id.php' class='function' rel='rdfs-seeAlso'>mysqli_thread_id()</a> - Returns the thread ID for the current 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="mysqli_insert_id" value="<div id='mysqli.insert-id' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.insert-id.php'>mysqli-&amp;gt;insert_id</a></h1> <h1 class='refname'>mysqli_insert_id</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;insert_id</span> -- <span class='refname'>mysqli_insert_id</span> &amp;mdash; <span class='dc-title'>Returns the auto generated id used in the last query</span></p> </div> <a name='mysqli.insert-id.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <var class='varname'>$insert_id</var>;</div> </div> <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>mysqli_insert_id</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> The <b>mysqli_insert_id()</b> function returns the ID generated by a query on a table with a column having the AUTO_INCREMENT attribute. If the last query wasn&amp;#039;t an INSERT or UPDATE statement or if the modified table does not have a column with the AUTO_INCREMENT attribute, this function will return zero. </p> <blockquote><p><b class='note'>Note</b>: Performing an INSERT or UPDATE statement using the LAST_INSERT_ID() function will also modify the value returned by the <b>mysqli_insert_id()</b> function. <br /> </p></blockquote> </div> <a name='mysqli.insert-id.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.insert-id.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The value of the <i>AUTO_INCREMENT</i> field that was updated by the previous query. Returns zero if there was no previous query on the connection or if the query did not update an <i>AUTO_INCREMENT</i> value. </p> <blockquote><p><b class='note'>Note</b>: If the number is greater than maximal int value, <b>mysqli_insert_id()</b> will return a string. <br /> </p></blockquote> </div> <a name='mysqli.insert-id.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCity&amp;nbsp;VALUES&amp;nbsp;(NULL,&amp;nbsp;'Stuttgart',&amp;nbsp;'DEU',&amp;nbsp;'Stuttgart',&amp;nbsp;617000)'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'New&amp;nbsp;Record&amp;nbsp;has&amp;nbsp;id&amp;nbsp;%d.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>insert_id</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;drop&amp;nbsp;table&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCity'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;myCity&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;myCity&amp;nbsp;VALUES&amp;nbsp;(NULL,&amp;nbsp;'Stuttgart',&amp;nbsp;'DEU',&amp;nbsp;'Stuttgart',&amp;nbsp;617000)'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'New&amp;nbsp;Record&amp;nbsp;has&amp;nbsp;id&amp;nbsp;%d.\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_insert_id</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;drop&amp;nbsp;table&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;myCity'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> New Record has id 1. </pre></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="mysqli_init" value="<div id='mysqli.init' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.init.php'>mysqli::init</a></h1> <h1 class='refname'>mysqli_init</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::init</span> -- <span class='refname'>mysqli_init</span> &amp;mdash; <span class='dc-title'>Initializes MySQLi and returns a resource for use with mysqli_real_connect()</span></p> </div> <a name='mysqli.init.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <span class='methodname'><b>mysqli::init</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <span class='methodname'><b>mysqli_init</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Allocates or initializes a MYSQL object suitable for <a href='http://www.php.net/manual/en/mysqli.options.php' class='function'>mysqli_options()</a> and <a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function'>mysqli_real_connect()</a>. </p> <blockquote><p><b class='note'>Note</b>: Any subsequent calls to any mysqli function (except <a href='http://www.php.net/manual/en/mysqli.options.php' class='function'>mysqli_options()</a>) will fail until <a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function'>mysqli_real_connect()</a> was called. <br /> </p></blockquote> </div> <a name='mysqli.init.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object. </p> </div> <a name='mysqli.init.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> See <a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function'>mysqli_real_connect()</a>. </p> </div> <a name='mysqli.init.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/mysqli.options.php' class='function' rel='rdfs-seeAlso'>mysqli_options()</a> - Set options</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.close.php' class='function' rel='rdfs-seeAlso'>mysqli_close()</a> - Closes a previously opened database connection</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function' rel='rdfs-seeAlso'>mysqli_real_connect()</a> - Opens a connection to a mysql server</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.connect.php' class='function' rel='rdfs-seeAlso'>mysqli_connect()</a> - Open a new connection to the MySQL 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="mysqli_info" value="<div id='mysqli.info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.info.php'>mysqli-&amp;gt;info</a></h1> <h1 class='refname'>mysqli_info</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;info</span> -- <span class='refname'>mysqli_info</span> &amp;mdash; <span class='dc-title'>Retrieves information about the most recently executed query</span></p> </div> <a name='mysqli.info.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property)</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$info</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_info</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> The <b>mysqli_info()</b> function returns a string providing information about the last query executed. The nature of this string is provided below: </p> <p class='para'> </p><table class='doctable table'> <caption><b>Possible mysqli_info return values</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Query type</th> <th>Example result string</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>INSERT INTO...SELECT...</td> <td align='left'>Records: 100 Duplicates: 0 Warnings: 0</td> </tr> <tr valign='middle'> <td align='left'>INSERT INTO...VALUES (...),(...),(...)</td> <td align='left'>Records: 3 Duplicates: 0 Warnings: 0</td> </tr> <tr valign='middle'> <td align='left'>LOAD DATA INFILE ...</td> <td align='left'>Records: 1 Deleted: 0 Skipped: 0 Warnings: 0</td> </tr> <tr valign='middle'> <td align='left'>ALTER TABLE ...</td> <td align='left'>Records: 3 Duplicates: 0 Warnings: 0</td> </tr> <tr valign='middle'> <td align='left'>UPDATE ...</td> <td align='left'>Rows matched: 40 Changed: 40 Warnings: 0</td> </tr> </tbody> </table> <p> </p> <blockquote><p><b class='note'>Note</b>: Queries which do not fall into one of the above formats are not supported. In these situations, <b>mysqli_info()</b> will return an empty string. <br /> </p></blockquote> </div> <a name='mysqli.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A character string representing additional information about the most recently executed query. </p> </div> <a name='mysqli.info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TEMPORARY&amp;nbsp;TABLE&amp;nbsp;t1&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;INSERT&amp;nbsp;INTO&amp;nbsp;..&amp;nbsp;SELECT&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;t1&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;ID&amp;nbsp;LIMIT&amp;nbsp;150'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>info</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TEMPORARY&amp;nbsp;TABLE&amp;nbsp;t1&amp;nbsp;LIKE&amp;nbsp;City'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;INSERT&amp;nbsp;INTO&amp;nbsp;..&amp;nbsp;SELECT&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;t1&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;ID&amp;nbsp;LIMIT&amp;nbsp;150'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_info</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Records: 150 Duplicates: 0 Warnings: 0 </pre></div> </div> </div> <a name='mysqli.info.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/mysqli.affected-rows.php' class='function' rel='rdfs-seeAlso'>mysqli_affected_rows()</a> - Gets the number of affected rows in a previous MySQL operation</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.warning-count.php' class='function' rel='rdfs-seeAlso'>mysqli_warning_count()</a> - Returns the number of warnings from the last query for the given link</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.num-rows.php' class='function' rel='rdfs-seeAlso'>mysqli_num_rows()</a> - Gets the number of rows in a result</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="mysqli_get_warnings" value="<div id='mysqli.get-warnings' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.get-warnings.php'>mysqli::get_warnings</a></h1> <h1 class='refname'>mysqli_get_warnings</h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>mysqli::get_warnings</span> -- <span class='refname'>mysqli_get_warnings</span> &amp;mdash; <span class='dc-title'>Get result of SHOW WARNINGS</span></p> </div> <a name='mysqli.get-warnings.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>mysqli::get_warnings</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mysqli_get_warnings</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mysqli_get_server_version" value="<div id='mysqli.get-server-version' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.get-server-version.php'>mysqli-&amp;gt;server_version</a></h1> <h1 class='refname'>mysqli_get_server_version</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;server_version</span> -- <span class='refname'>mysqli_get_server_version</span> &amp;mdash; <span class='dc-title'>Returns the version of the MySQL server as an integer</span></p> </div> <a name='mysqli.get-server-version.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$server_version</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_get_server_version</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> The <b>mysqli_get_server_version()</b> function returns the version of the server connected to (represented by the <i><tt class='parameter'>link</tt></i> parameter) as an integer. </p> </div> <a name='mysqli.get-server-version.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.get-server-version.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An integer representing the server version. </p> <p class='para'> The form of this version number is <i>main_version * 10000 + minor_version * 100 + sub_version</i> (i.e. version 4.1.0 is 40100). </p> </div> <a name='mysqli.get-server-version.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;server&amp;nbsp;version&amp;nbsp;*/<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Server&amp;nbsp;version:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>server_version</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;server&amp;nbsp;version&amp;nbsp;*/<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Server&amp;nbsp;version:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_get_server_version</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Server version: 40102 </pre></div> </div> </div> <a name='mysqli.get-server-version.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/mysqli.get-client-info.php' class='function' rel='rdfs-seeAlso'>mysqli_get_client_info()</a> - Returns the MySQL client version as a string</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.get-client-version.php' class='function' rel='rdfs-seeAlso'>mysqli_get_client_version()</a> - Get MySQL client info</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.get-server-info.php' class='function' rel='rdfs-seeAlso'>mysqli_get_server_info()</a> - Returns the version of the MySQL 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="mysqli_get_server_info" value="<div id='mysqli.get-server-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.get-server-info.php'>mysqli-&amp;gt;server_info</a></h1> <h1 class='refname'>mysqli_get_server_info</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;server_info</span> -- <span class='refname'>mysqli_get_server_info</span> &amp;mdash; <span class='dc-title'>Returns the version of the MySQL server</span></p> </div> <a name='mysqli.get-server-info.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$server_info</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_get_server_info</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns a string representing the version of the MySQL server that the MySQLi extension is connected to. </p> </div> <a name='mysqli.get-server-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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.get-server-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A character string representing the server version. </p> </div> <a name='mysqli.get-server-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;server&amp;nbsp;version&amp;nbsp;*/<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Server&amp;nbsp;version:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>server_info</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;server&amp;nbsp;version&amp;nbsp;*/<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Server&amp;nbsp;version:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_get_server_info</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Server version: 4.1.2-alpha-debug </pre></div> </div> </div> <a name='mysqli.get-server-info.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/mysqli.get-client-info.php' class='function' rel='rdfs-seeAlso'>mysqli_get_client_info()</a> - Returns the MySQL client version as a string</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.get-client-version.php' class='function' rel='rdfs-seeAlso'>mysqli_get_client_version()</a> - Get MySQL client info</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.get-server-version.php' class='function' rel='rdfs-seeAlso'>mysqli_get_server_version()</a> - Returns the version of the MySQL server as an integer</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="mysqli_get_proto_info" value="<div id='mysqli.get-proto-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.get-proto-info.php'>mysqli-&amp;gt;protocol_version</a></h1> <h1 class='refname'>mysqli_get_proto_info</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;protocol_version</span> -- <span class='refname'>mysqli_get_proto_info</span> &amp;mdash; <span class='dc-title'>Returns the version of the MySQL protocol used</span></p> </div> <a name='mysqli.get-proto-info.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$protocol_version</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_get_proto_info</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns an integer representing the MySQL protocol version used by the connection represented by the <i><tt class='parameter'>link</tt></i> parameter. </p> </div> <a name='mysqli.get-proto-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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.get-proto-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an integer representing the protocol version. </p> </div> <a name='mysqli.get-proto-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;protocol&amp;nbsp;version&amp;nbsp;*/<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Protocol&amp;nbsp;version:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>protocol_version</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;protocol&amp;nbsp;version&amp;nbsp;*/<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Protocol&amp;nbsp;version:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_get_proto_info</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Protocol version: 10 </pre></div> </div> </div> <a name='mysqli.get-proto-info.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/mysqli.get-host-info.php' class='function' rel='rdfs-seeAlso'>mysqli_get_host_info()</a> - Returns a string representing the type of connection used</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="mysqli_get_metadata" value="<div id='function.mysqli-get-metadata' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-get-metadata.php'>mysqli_get_metadata</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_get_metadata</span> &amp;mdash; <span class='dc-title'>Alias for <a href='http://www.php.net/manual/en/mysqli-stmt.result-metadata.php' class='function'>mysqli_stmt_result_metadata()</a></span></p> </div> <a name='function.mysqli-get-metadata.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of <a href='http://www.php.net/manual/en/mysqli-stmt.result-metadata.php' class='function'>mysqli_stmt_result_metadata()</a>. </p> </div> <a name='function.mysqli-get-metadata.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>mysqli_get_metadata()</b> is deprecated and will be removed. <br /> </p></blockquote> </div> <a name='function.mysqli-get-metadata.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/mysqli-stmt.result-metadata.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_result_metadata()</a> - Returns result set metadata from a prepared statement</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="mysqli_get_host_info" value="<div id='mysqli.get-host-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.get-host-info.php'>mysqli-&amp;gt;host_info</a></h1> <h1 class='refname'>mysqli_get_host_info</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;host_info</span> -- <span class='refname'>mysqli_get_host_info</span> &amp;mdash; <span class='dc-title'>Returns a string representing the type of connection used</span></p> </div> <a name='mysqli.get-host-info.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$host_info</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_get_host_info</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns a string describing the connection represented by the <i><tt class='parameter'>link</tt></i> parameter (including the server host name). </p> </div> <a name='mysqli.get-host-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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.get-host-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A character string representing the server hostname and the connection type. </p> </div> <a name='mysqli.get-host-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;host&amp;nbsp;information&amp;nbsp;*/<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Host&amp;nbsp;info:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>host_info</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;print&amp;nbsp;host&amp;nbsp;information&amp;nbsp;*/<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Host&amp;nbsp;info:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_get_host_info</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Host info: Localhost via UNIX socket </pre></div> </div> </div> <a name='mysqli.get-host-info.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/mysqli.get-proto-info.php' class='function' rel='rdfs-seeAlso'>mysqli_get_proto_info()</a> - Returns the version of the MySQL protocol used</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="mysqli_get_client_version" value="<div id='mysqli.get-client-version' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.get-client-version.php'>mysqli::get_client_version</a></h1> <h1 class='refname'>mysqli_get_client_version</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::get_client_version</span> -- <span class='refname'>mysqli_get_client_version</span> &amp;mdash; <span class='dc-title'>Get MySQL client info</span></p> </div> <a name='mysqli.get-client-version.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>mysqli::get_client_version</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_get_client_version</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns client version number as an integer. </p> </div> <a name='mysqli.get-client-version.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A number that represents the MySQL client library version in format: <i>main_version*10000 + minor_version *100 + sub_version</i>. For example, 4.1.0 is returned as 40100. </p> <p class='para'> This is useful to quickly determine the version of the client library to know if some capability exits. </p> </div> <a name='mysqli.get-client-version.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 mysqli_get_client_version</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;We&amp;nbsp;don't&amp;nbsp;need&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;to&amp;nbsp;determine<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;the&amp;nbsp;version&amp;nbsp;of&amp;nbsp;mysql&amp;nbsp;client&amp;nbsp;library&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Client&amp;nbsp;library&amp;nbsp;version:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_get_client_version</span><span style='color: #007700'>());<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='mysqli.get-client-version.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/mysqli.get-client-info.php' class='function' rel='rdfs-seeAlso'>mysqli_get_client_info()</a> - Returns the MySQL client version as a string</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.get-server-info.php' class='function' rel='rdfs-seeAlso'>mysqli_get_server_info()</a> - Returns the version of the MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.get-server-version.php' class='function' rel='rdfs-seeAlso'>mysqli_get_server_version()</a> - Returns the version of the MySQL server as an integer</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="mysqli_get_client_info" value="<div id='mysqli.get-client-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.get-client-info.php'>mysqli::get_client_info</a></h1> <h1 class='refname'>mysqli_get_client_info</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::get_client_info</span> -- <span class='refname'>mysqli_get_client_info</span> &amp;mdash; <span class='dc-title'>Returns the MySQL client version as a string</span></p> </div> <a name='mysqli.get-client-info.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>mysqli::get_client_info</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_get_client_info</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> The <b>mysqli_get_client_info()</b> function is used to return a string representing the client version being used in the MySQLi extension. </p> </div> <a name='mysqli.get-client-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A string that represents the MySQL client library version </p> </div> <a name='mysqli.get-client-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 mysqli_get_client_info</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;We&amp;nbsp;don't&amp;nbsp;need&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;to&amp;nbsp;determine<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;the&amp;nbsp;version&amp;nbsp;of&amp;nbsp;mysql&amp;nbsp;client&amp;nbsp;library&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Client&amp;nbsp;library&amp;nbsp;version:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_get_client_info</span><span style='color: #007700'>());<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='mysqli.get-client-info.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/mysqli.get-client-version.php' class='function' rel='rdfs-seeAlso'>mysqli_get_client_version()</a> - Get MySQL client info</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.get-server-info.php' class='function' rel='rdfs-seeAlso'>mysqli_get_server_info()</a> - Returns the version of the MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.get-server-version.php' class='function' rel='rdfs-seeAlso'>mysqli_get_server_version()</a> - Returns the version of the MySQL server as an integer</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="mysqli_get_charset" value="<div id='mysqli.get-charset' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.get-charset.php'>mysqli::get_charset</a></h1> <h1 class='refname'>mysqli_get_charset</h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>mysqli::get_charset</span> -- <span class='refname'>mysqli_get_charset</span> &amp;mdash; <span class='dc-title'>Returns a character set object</span></p> </div> <a name='mysqli.get-charset.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>mysqli::get_charset</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mysqli_get_charset</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns a character set object providing several properties of the current active character set. </p> </div> <a name='mysqli.get-charset.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.get-charset.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The function returns a character set object with the following properties: </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Character set name</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>collation</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Collation name</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dir</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Directory the charset description was fetched from (?) or &amp;quot;&amp;quot; for built-in character sets</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>min_length</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Minimum character length in bytes</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>max_length</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Maximum character length in bytes</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>number</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Internal character set number</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>state</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Character set status (?)</p></dd> </dl> <p> </p> </div> <a name='mysqli.get-charset.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_init</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>real_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'root'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>get_charset</span><span style='color: #007700'>());<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_init</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_real_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'root'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>get_charset</span><span style='color: #007700'>());<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> object(stdClass)#2 (7) { [&amp;quot;charset&amp;quot;]=&amp;gt; string(6) &amp;quot;latin1&amp;quot; [&amp;quot;collation&amp;quot;]=&amp;gt; string(17) &amp;quot;latin1_swedish_ci&amp;quot; [&amp;quot;dir&amp;quot;]=&amp;gt; string(0) &amp;quot;&amp;quot; [&amp;quot;min_length&amp;quot;]=&amp;gt; int(1) [&amp;quot;max_length&amp;quot;]=&amp;gt; int(1) [&amp;quot;number&amp;quot;]=&amp;gt; int(8) [&amp;quot;state&amp;quot;]=&amp;gt; int(801) } </pre></div> </div> </div> <a name='mysqli.get-charset.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/mysqli.character-set-name.php' class='function' rel='rdfs-seeAlso'>mysqli_character_set_name()</a> - Returns the default character set for the database connection</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.set-charset.php' class='function' rel='rdfs-seeAlso'>mysqli_set_charset()</a> - Sets the default client character 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="mysqli_free_result" value="<div id='mysqli-result.free' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.free.php'>mysqli_result::free</a></h1> <h1 class='refname'>mysqli_free_result</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result::free</span> -- <span class='refname'>mysqli_free_result</span> &amp;mdash; <span class='dc-title'>Frees the memory associated with a result</span></p> </div> <a name='mysqli-result.free.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (all methods are equivalent):</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mysqli_result::free</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mysqli_result::close</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mysqli_result::free_result</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mysqli_free_result</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Frees the memory associated with the result. </p> <blockquote><p><b class='note'>Note</b>: You should always free your result with <b>mysqli_free_result()</b>, when your result object is not needed anymore. <br /> </p></blockquote> </div> <a name='mysqli-result.free.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-result.free.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='mysqli-result.free.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/mysqli.query.php' class='function' rel='rdfs-seeAlso'>mysqli_query()</a> - Performs a query on the database</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-stmt.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_store_result()</a> - Transfers a result set from a prepared statement</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_store_result()</a> - Transfers a result set from the last query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function' rel='rdfs-seeAlso'>mysqli_use_result()</a> - Initiate a result set retrieval</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="mysqli_field_tell" value="<div id='mysqli-result.current-field' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.current-field.php'>mysqli_result-&amp;gt;current_field</a></h1> <h1 class='refname'>mysqli_field_tell</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result-&amp;gt;current_field</span> -- <span class='refname'>mysqli_field_tell</span> &amp;mdash; <span class='dc-title'>Get current field offset of a result pointer</span></p> </div> <a name='mysqli-result.current-field.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-result.php' class='classname'>mysqli_result</a></div> <div class='fieldsynopsis'> <span class='type'>int</span> <var class='varname'>$current_field</var> ;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_field_tell</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Returns the position of the field cursor used for the last <a href='http://www.php.net/manual/en/mysqli-result.fetch-field.php' class='function'>mysqli_fetch_field()</a> call. This value can be used as an argument to <a href='http://www.php.net/manual/en/mysqli-result.field-seek.php' class='function'>mysqli_field_seek()</a>. </p> </div> <a name='mysqli-result.current-field.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-result.current-field.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns current offset of field cursor. </p> </div> <a name='mysqli-result.current-field.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;SurfaceArea&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Code&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;field&amp;nbsp;information&amp;nbsp;for&amp;nbsp;all&amp;nbsp;columns&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$finfo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_field</span><span style='color: #007700'>())&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;get&amp;nbsp;fieldpointer&amp;nbsp;offset&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$currentfield&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>current_field</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Column&amp;nbsp;%d:\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$currentfield</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>table</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'max.&amp;nbsp;Len:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Flags:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>flags</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</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'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;SurfaceArea&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Code&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;field&amp;nbsp;information&amp;nbsp;for&amp;nbsp;all&amp;nbsp;fields&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$finfo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_field</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;get&amp;nbsp;fieldpointer&amp;nbsp;offset&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$currentfield&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_field_tell</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Column&amp;nbsp;%d:\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$currentfield</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>table</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'max.&amp;nbsp;Len:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Flags:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>flags</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</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'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Column 1: Name: Name Table: Country max. Len: 11 Flags: 1 Type: 254 Column 2: Name: SurfaceArea Table: Country max. Len: 10 Flags: 32769 Type: 4 </pre></div> </div> </div> <a name='mysqli-result.current-field.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/mysqli-result.fetch-field.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_field()</a> - Returns the next field in the result set</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.field-seek.php' class='function' rel='rdfs-seeAlso'>mysqli_field_seek()</a> - Set result pointer to a specified field offset</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="mysqli_field_seek" value="<div id='mysqli-result.field-seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.field-seek.php'>mysqli_result::field_seek</a></h1> <h1 class='refname'>mysqli_field_seek</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result::field_seek</span> -- <span class='refname'>mysqli_field_seek</span> &amp;mdash; <span class='dc-title'>Set result pointer to a specified field offset</span></p> </div> <a name='mysqli-result.field-seek.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_result::field_seek</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$fieldnr</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_field_seek</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$fieldnr</tt></span> )</div> <p class='para rdfs-comment'> Sets the field cursor to the given offset. The next call to <a href='http://www.php.net/manual/en/mysqli-result.fetch-field.php' class='function'>mysqli_fetch_field()</a> will retrieve the field definition of the column associated with that offset. </p> <blockquote><p><b class='note'>Note</b>: To seek to the beginning of a row, pass an offset value of zero. <br /> </p></blockquote> </div> <a name='mysqli-result.field-seek.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fieldnr</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field number. This value must be in the range from <i>0</i> to <i>number of fields - 1</i>. </p> </dd> </dl> <p> </p> </div> <a name='mysqli-result.field-seek.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='mysqli-result.field-seek.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;SurfaceArea&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Code&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;field&amp;nbsp;information&amp;nbsp;for&amp;nbsp;2nd&amp;nbsp;column&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>field_seek</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;</span><span style='color: #0000BB'>$finfo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_field</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</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: #DD0000'>'Table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>table</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: #DD0000'>'max.&amp;nbsp;Len:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length</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: #DD0000'>'Flags:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>flags</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: #DD0000'>'Type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;SurfaceArea&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Code&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;field&amp;nbsp;information&amp;nbsp;for&amp;nbsp;2nd&amp;nbsp;column&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_field_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$finfo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_field</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</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: #DD0000'>'Table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>table</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: #DD0000'>'max.&amp;nbsp;Len:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length</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: #DD0000'>'Flags:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>flags</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: #DD0000'>'Type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Name: SurfaceArea Table: Country max. Len: 10 Flags: 32769 Type: 4 </pre></div> </div> </div> <a name='mysqli-result.field-seek.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/mysqli-result.fetch-field.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_field()</a> - Returns the next field in the result 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="mysqli_field_count" value="<div id='mysqli.field-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.field-count.php'>mysqli-&amp;gt;field_count</a></h1> <h1 class='refname'>mysqli_field_count</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;field_count</span> -- <span class='refname'>mysqli_field_count</span> &amp;mdash; <span class='dc-title'>Returns the number of columns for the most recent query</span></p> </div> <a name='mysqli.field-count.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-result.php' class='classname'>mysqli_result</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$field_count</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_field_count</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of columns for the most recent query on the connection represented by the <i><tt class='parameter'>link</tt></i> parameter. This function can be useful when using the <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> function to determine if the query should have produced a non-empty result set or not without knowing the nature of the query. </p> </div> <a name='mysqli.field-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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.field-count.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An integer representing the number of fields in a result set. </p> </div> <a name='mysqli.field-count.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;IF&amp;nbsp;EXISTS&amp;nbsp;friends'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;friends&amp;nbsp;(id&amp;nbsp;int,&amp;nbsp;name&amp;nbsp;varchar(20))'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;friends&amp;nbsp;VALUES&amp;nbsp;(1,'Hartmut'),&amp;nbsp;(2,&amp;nbsp;'Ulf')'</span><span style='color: #007700'>);<br /><br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>real_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;friends'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>field_count</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;this&amp;nbsp;was&amp;nbsp;a&amp;nbsp;select/show&amp;nbsp;or&amp;nbsp;describe&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>store_result</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;process&amp;nbsp;resultset&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;resultset&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;IF&amp;nbsp;EXISTS&amp;nbsp;friends'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;friends&amp;nbsp;(id&amp;nbsp;int,&amp;nbsp;name&amp;nbsp;varchar(20))'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;friends&amp;nbsp;VALUES&amp;nbsp;(1,'Hartmut'),&amp;nbsp;(2,&amp;nbsp;'Ulf')'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysqli_real_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;friends'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_field_count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;this&amp;nbsp;was&amp;nbsp;a&amp;nbsp;select/show&amp;nbsp;or&amp;nbsp;describe&amp;nbsp;query&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_store_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;process&amp;nbsp;resultset&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;resultset&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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="mysqli_fetch_row" value="<div id='mysqli-result.fetch-row' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.fetch-row.php'>mysqli_result::fetch_row</a></h1> <h1 class='refname'>mysqli_fetch_row</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result::fetch_row</span> -- <span class='refname'>mysqli_fetch_row</span> &amp;mdash; <span class='dc-title'>Get a result row as an enumerated array</span></p> </div> <a name='mysqli-result.fetch-row.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</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>mysqli_result::fetch_row</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>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>mysqli_fetch_row</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Fetches one row of data from the result set and returns it as an enumerated array, where each column is stored in an array offset starting from 0 (zero). Each subsequent call to this function will return the next row within the result set, or <b><tt class='constant'>NULL</tt></b> if there are no more rows. </p> </div> <a name='mysqli-result.fetch-row.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-result.fetch-row.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>mysqli_fetch_row()</b> returns an array of strings that corresponds to the fetched row or <b><tt class='constant'>NULL</tt></b> if there are no more rows in result set. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='mysqli-result.fetch-row.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;by&amp;nbsp;ID&amp;nbsp;DESC&amp;nbsp;LIMIT&amp;nbsp;50,5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;object&amp;nbsp;array&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</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;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;by&amp;nbsp;ID&amp;nbsp;DESC&amp;nbsp;LIMIT&amp;nbsp;50,5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;associative&amp;nbsp;array&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</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;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Pueblo (USA) Arvada (USA) Cape Coral (USA) Green Bay (USA) Santa Clara (USA) </pre></div> </div> </div> <a name='mysqli-result.fetch-row.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/mysqli-result.fetch-array.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_array()</a> - Fetch a result row as an associative, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_assoc()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-object.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_object()</a> - Returns the current row of a result set as an object</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.query.php' class='function' rel='rdfs-seeAlso'>mysqli_query()</a> - Performs a query on the database</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.data-seek.php' class='function' rel='rdfs-seeAlso'>mysqli_data_seek()</a> - Adjusts the result pointer to an arbitary row in the result</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="mysqli_fetch_object" value="<div id='mysqli-result.fetch-object' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.fetch-object.php'>mysqli_result::fetch_object</a></h1> <h1 class='refname'>mysqli_fetch_object</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result::fetch_object</span> -- <span class='refname'>mysqli_fetch_object</span> &amp;mdash; <span class='dc-title'>Returns the current row of a result set as an object</span></p> </div> <a name='mysqli-result.fetch-object.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mysqli_result::fetch_object</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$class_name</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$params</tt></span> ]] )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mysqli_fetch_object</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$class_name</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$params</tt></span> ]] )</div> <p class='para rdfs-comment'> The <b>mysqli_fetch_object()</b> will return the current row result set as an object where the attributes of the object represent the names of the fields found within the result set. </p> </div> <a name='mysqli-result.fetch-object.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>class_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the class to instantiate, set the properties of and return. If not specified, a <b class='classname'>stdClass</b> object is returned. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>params</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> of parameters to pass to the constructor for <i><tt class='parameter'>class_name</tt></i> objects. </p> </dd> </dl> <p> </p> </div> <a name='mysqli-result.fetch-object.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object with string properties that corresponds to the fetched row or <b><tt class='constant'>NULL</tt></b> if there are no more rows in resultset. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Field names returned by this function are <em class='emphasis'>case-sensitive</em>.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='mysqli-result.fetch-object.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'> Added the ability to return as a different object. </td> </tr> </tbody> </table> <p> </p> </div> <a name='mysqli-result.fetch-object.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br />&amp;nbsp;<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;by&amp;nbsp;ID&amp;nbsp;DESC&amp;nbsp;LIMIT&amp;nbsp;50,5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;object&amp;nbsp;array&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_object</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CountryCode</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;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;by&amp;nbsp;ID&amp;nbsp;DESC&amp;nbsp;LIMIT&amp;nbsp;50,5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;associative&amp;nbsp;array&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CountryCode</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;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Pueblo (USA) Arvada (USA) Cape Coral (USA) Green Bay (USA) Santa Clara (USA) </pre></div> </div> </div> <a name='mysqli-result.fetch-object.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/mysqli-result.fetch-array.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_array()</a> - Fetch a result row as an associative, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_assoc()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-row.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_row()</a> - Get a result row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.query.php' class='function' rel='rdfs-seeAlso'>mysqli_query()</a> - Performs a query on the database</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.data-seek.php' class='function' rel='rdfs-seeAlso'>mysqli_data_seek()</a> - Adjusts the result pointer to an arbitary row in the result</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="mysqli_fetch_lengths" value="<div id='mysqli-result.lengths' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.lengths.php'>mysqli_result-&amp;gt;lengths</a></h1> <h1 class='refname'>mysqli_fetch_lengths</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result-&amp;gt;lengths</span> -- <span class='refname'>mysqli_fetch_lengths</span> &amp;mdash; <span class='dc-title'>Returns the lengths of the columns of the current row in the result set</span></p> </div> <a name='mysqli-result.lengths.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli-result.php' class='classname'>mysqli_result</a></div> <div class='fieldsynopsis'><span class='type'>array</span> <var class='varname'>$lengths</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>mysqli_fetch_lengths</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> The <b>mysqli_fetch_lengths()</b> function returns an array containing the lengths of every column of the current row within the result set. </p> </div> <a name='mysqli-result.lengths.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-result.lengths.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An array of integers representing the size of each column (not including any terminating null characters). <b><tt class='constant'>FALSE</tt></b> if an error occurred. </p> <p class='para'> <b>mysqli_fetch_lengths()</b> is valid only for the current row of the result set. It returns <b><tt class='constant'>FALSE</tt></b> if you call it before calling mysqli_fetch_row/array/object or after retrieving all rows in the result. </p> </div> <a name='mysqli-result.lengths.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Code&amp;nbsp;LIMIT&amp;nbsp;1'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;display&amp;nbsp;column&amp;nbsp;lengths&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>foreach&amp;nbsp;(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>lengths&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$i&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;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Field&amp;nbsp;%2d&amp;nbsp;has&amp;nbsp;Length&amp;nbsp;%2d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>+</span><span style='color: #0000BB'>1</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;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Code&amp;nbsp;LIMIT&amp;nbsp;1'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;display&amp;nbsp;column&amp;nbsp;lengths&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>foreach&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_fetch_lengths</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;as&amp;nbsp;</span><span style='color: #0000BB'>$i&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;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Field&amp;nbsp;%2d&amp;nbsp;has&amp;nbsp;Length&amp;nbsp;%2d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>+</span><span style='color: #0000BB'>1</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;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Field 1 has Length 3 Field 2 has Length 5 Field 3 has Length 13 Field 4 has Length 9 Field 5 has Length 6 Field 6 has Length 1 Field 7 has Length 6 Field 8 has Length 4 Field 9 has Length 6 Field 10 has Length 6 Field 11 has Length 5 Field 12 has Length 44 Field 13 has Length 7 Field 14 has Length 3 Field 15 has Length 2 </pre></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="mysqli_fetch_field_direct" value="<div id='mysqli-result.fetch-field-direct' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.fetch-field-direct.php'>mysqli_result::fetch_field_direct</a></h1> <h1 class='refname'>mysqli_fetch_field_direct</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result::fetch_field_direct</span> -- <span class='refname'>mysqli_fetch_field_direct</span> &amp;mdash; <span class='dc-title'>Fetch meta-data for a single field</span></p> </div> <a name='mysqli-result.fetch-field-direct.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mysqli_result::fetch_field_direct</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$fieldnr</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mysqli_fetch_field_direct</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$fieldnr</tt></span> )</div> <p class='para rdfs-comment'> Returns an object which contains field definition information from the specified result set. </p> </div> <a name='mysqli-result.fetch-field-direct.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fieldnr</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field number. This value must be in the range from <i>0</i> to <i>number of fields - 1</i>. </p> </dd> </dl> <p> </p> </div> <a name='mysqli-result.fetch-field-direct.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object which contains field definition information or <b><tt class='constant'>FALSE</tt></b> if no field information for specified <i>fieldnr</i> is available. </p> <p class='para'> </p><table class='doctable table'> <caption><b>Object attributes</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Attribute</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>name</td> <td align='left'>The name of the column</td> </tr> <tr valign='middle'> <td align='left'>orgname</td> <td align='left'>Original column name if an alias was specified</td> </tr> <tr valign='middle'> <td align='left'>table</td> <td align='left'>The name of the table this field belongs to (if not calculated)</td> </tr> <tr valign='middle'> <td align='left'>orgtable</td> <td align='left'>Original table name if an alias was specified</td> </tr> <tr valign='middle'> <td align='left'>def</td> <td align='left'>The default value for this field, represented as a string</td> </tr> <tr valign='middle'> <td align='left'>max_length</td> <td align='left'>The maximum width of the field for the result set.</td> </tr> <tr valign='middle'> <td align='left'>length</td> <td align='left'>The width of the field, as specified in the table definition.</td> </tr> <tr valign='middle'> <td align='left'>charsetnr</td> <td align='left'>The character set number for the field.</td> </tr> <tr valign='middle'> <td align='left'>flags</td> <td align='left'>An integer representing the bit-flags for the field.</td> </tr> <tr valign='middle'> <td align='left'>type</td> <td align='left'>The data type used for this field</td> </tr> <tr valign='middle'> <td align='left'>decimals</td> <td align='left'>The number of decimals used (for integer fields)</td> </tr> </tbody> </table> <p> </p> </div> <a name='mysqli-result.fetch-field-direct.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;SurfaceArea&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;field&amp;nbsp;information&amp;nbsp;for&amp;nbsp;column&amp;nbsp;'SurfaceArea'&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$finfo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_field_direct</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</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: #DD0000'>'Table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>table</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: #DD0000'>'max.&amp;nbsp;Len:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length</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: #DD0000'>'Flags:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>flags</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: #DD0000'>'Type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;SurfaceArea&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;field&amp;nbsp;information&amp;nbsp;for&amp;nbsp;column&amp;nbsp;'SurfaceArea'&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$finfo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_field_direct</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</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: #DD0000'>'Table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>table</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: #DD0000'>'max.&amp;nbsp;Len:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length</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: #DD0000'>'Flags:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>flags</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: #DD0000'>'Type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Name: SurfaceArea Table: Country max. Len: 10 Flags: 32769 Type: 4 </pre></div> </div> </div> <a name='mysqli-result.fetch-field-direct.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/mysqli-result.field-count.php' class='function' rel='rdfs-seeAlso'>mysqli_num_fields()</a> - Get the number of fields in a result</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-field.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_field()</a> - Returns the next field in the result set</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-fields.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_fields()</a> - Returns an array of objects representing the fields in a result 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="mysqli_fetch_fields" value="<div id='mysqli-result.fetch-fields' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.fetch-fields.php'>mysqli_result::fetch_fields</a></h1> <h1 class='refname'>mysqli_fetch_fields</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result::fetch_fields</span> -- <span class='refname'>mysqli_fetch_fields</span> &amp;mdash; <span class='dc-title'>Returns an array of objects representing the fields in a result set</span></p> </div> <a name='mysqli-result.fetch-fields.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>mysqli_result::fetch_fields</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural Style:</p> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>mysqli_fetch_fields</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> This function serves an identical purpose to the <a href='http://www.php.net/manual/en/mysqli-result.fetch-field.php' class='function'>mysqli_fetch_field()</a> function with the single difference that, instead of returning one object at a time for each field, the columns are returned as an array of objects. </p> </div> <a name='mysqli-result.fetch-fields.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-result.fetch-fields.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of objects which contains field definition information or <b><tt class='constant'>FALSE</tt></b> if no field information is available. </p> <p class='para'> </p><table class='doctable table'> <caption><b>Object properties</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Property</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>name</td> <td align='left'>The name of the column</td> </tr> <tr valign='middle'> <td align='left'>orgname</td> <td align='left'>Original column name if an alias was specified</td> </tr> <tr valign='middle'> <td align='left'>table</td> <td align='left'>The name of the table this field belongs to (if not calculated)</td> </tr> <tr valign='middle'> <td align='left'>orgtable</td> <td align='left'>Original table name if an alias was specified</td> </tr> <tr valign='middle'> <td align='left'>def</td> <td align='left'>The default value for this field, represented as a string</td> </tr> <tr valign='middle'> <td align='left'>max_length</td> <td align='left'>The maximum width of the field for the result set.</td> </tr> <tr valign='middle'> <td align='left'>length</td> <td align='left'>The width of the field, as specified in the table definition.</td> </tr> <tr valign='middle'> <td align='left'>charsetnr</td> <td align='left'>The character set number for the field.</td> </tr> <tr valign='middle'> <td align='left'>flags</td> <td align='left'>An integer representing the bit-flags for the field.</td> </tr> <tr valign='middle'> <td align='left'>type</td> <td align='left'>The data type used for this field</td> </tr> <tr valign='middle'> <td align='left'>decimals</td> <td align='left'>The number of decimals used (for integer fields)</td> </tr> </tbody> </table> <p> </p> </div> <a name='mysqli-result.fetch-fields.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;SurfaceArea&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Code&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;field&amp;nbsp;information&amp;nbsp;for&amp;nbsp;all&amp;nbsp;columns&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$finfo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_fields</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach&amp;nbsp;(</span><span style='color: #0000BB'>$finfo&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;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</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'>name</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</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'>table</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'max.&amp;nbsp;Len:&amp;nbsp;%d\n'</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'>max_length</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Flags:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</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'>flags</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n\n'</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'>type</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'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;SurfaceArea&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Code&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;field&amp;nbsp;information&amp;nbsp;for&amp;nbsp;all&amp;nbsp;columns&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$finfo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach&amp;nbsp;(</span><span style='color: #0000BB'>$finfo&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;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</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'>name</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</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'>table</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'max.&amp;nbsp;Len:&amp;nbsp;%d\n'</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'>max_length</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Flags:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</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'>flags</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n\n'</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'>type</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'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Name: Name Table: Country max. Len: 11 Flags: 1 Type: 254 Name: SurfaceArea Table: Country max. Len: 10 Flags: 32769 Type: 4 </pre></div> </div> </div> <a name='mysqli-result.fetch-fields.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/mysqli-result.field-count.php' class='function' rel='rdfs-seeAlso'>mysqli_num_fields()</a> - Get the number of fields in a result</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-field-direct.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_field_direct()</a> - Fetch meta-data for a single field</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-field.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_field()</a> - Returns the next field in the result 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="mysqli_fetch_field" value="<div id='mysqli-result.fetch-field' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.fetch-field.php'>mysqli_result::fetch_field</a></h1> <h1 class='refname'>mysqli_fetch_field</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result::fetch_field</span> -- <span class='refname'>mysqli_fetch_field</span> &amp;mdash; <span class='dc-title'>Returns the next field in the result set</span></p> </div> <a name='mysqli-result.fetch-field.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mysqli_result::fetch_field</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mysqli_fetch_field</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Returns the definition of one column of a result set as an object. Call this function repeatedly to retrieve information about all columns in the result set. </p> </div> <a name='mysqli-result.fetch-field.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-result.fetch-field.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object which contains field definition information or <b><tt class='constant'>FALSE</tt></b> if no field information is available. </p> <p class='para'> </p><table class='doctable table'> <caption><b>Object properties</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Property</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>name</td> <td align='left'>The name of the column</td> </tr> <tr valign='middle'> <td align='left'>orgname</td> <td align='left'>Original column name if an alias was specified</td> </tr> <tr valign='middle'> <td align='left'>table</td> <td align='left'>The name of the table this field belongs to (if not calculated)</td> </tr> <tr valign='middle'> <td align='left'>orgtable</td> <td align='left'>Original table name if an alias was specified</td> </tr> <tr valign='middle'> <td align='left'>def</td> <td align='left'>The default value for this field, represented as a string</td> </tr> <tr valign='middle'> <td align='left'>max_length</td> <td align='left'>The maximum width of the field for the result set.</td> </tr> <tr valign='middle'> <td align='left'>length</td> <td align='left'>The width of the field, as specified in the table definition.</td> </tr> <tr valign='middle'> <td align='left'>charsetnr</td> <td align='left'>The character set number for the field.</td> </tr> <tr valign='middle'> <td align='left'>flags</td> <td align='left'>An integer representing the bit-flags for the field.</td> </tr> <tr valign='middle'> <td align='left'>type</td> <td align='left'>The data type used for this field</td> </tr> <tr valign='middle'> <td align='left'>decimals</td> <td align='left'>The number of decimals used (for integer fields)</td> </tr> </tbody> </table> <p> </p> </div> <a name='mysqli-result.fetch-field.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;SurfaceArea&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Code&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;field&amp;nbsp;information&amp;nbsp;for&amp;nbsp;all&amp;nbsp;columns&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$finfo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_field</span><span style='color: #007700'>())&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>table</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'max.&amp;nbsp;Len:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Flags:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>flags</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</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'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;SurfaceArea&amp;nbsp;from&amp;nbsp;Country&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Code&amp;nbsp;LIMIT&amp;nbsp;5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;field&amp;nbsp;information&amp;nbsp;for&amp;nbsp;all&amp;nbsp;fields&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$finfo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_field</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Name:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Table:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>table</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'max.&amp;nbsp;Len:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Flags:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>flags</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'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Type:&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%d\n\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$finfo</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</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'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Name: Name Table: Country max. Len: 11 Flags: 1 Type: 254 Name: SurfaceArea Table: Country max. Len: 10 Flags: 32769 Type: 4 </pre></div> </div> </div> <a name='mysqli-result.fetch-field.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/mysqli-result.field-count.php' class='function' rel='rdfs-seeAlso'>mysqli_num_fields()</a> - Get the number of fields in a result</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-field-direct.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_field_direct()</a> - Fetch meta-data for a single field</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-fields.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_fields()</a> - Returns an array of objects representing the fields in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.field-seek.php' class='function' rel='rdfs-seeAlso'>mysqli_field_seek()</a> - Set result pointer to a specified field offset</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="mysqli_fetch_assoc" value="<div id='mysqli-result.fetch-assoc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.fetch-assoc.php'>mysqli_result::fetch_assoc</a></h1> <h1 class='refname'>mysqli_fetch_assoc</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result::fetch_assoc</span> -- <span class='refname'>mysqli_fetch_assoc</span> &amp;mdash; <span class='dc-title'>Fetch a result row as an associative array</span></p> </div> <a name='mysqli-result.fetch-assoc.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>mysqli_result::fetch_assoc</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>mysqli_fetch_assoc</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Returns an associative array that corresponds to the fetched row or <b><tt class='constant'>NULL</tt></b> if there are no more rows. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Field names returned by this function are <em class='emphasis'>case-sensitive</em>.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='mysqli-result.fetch-assoc.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> </dl> <p> </p> </div> <a name='mysqli-result.fetch-assoc.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array of strings representing the fetched row in the result set, where each key in the array represents the name of one of the result set&amp;#039;s columns or <b><tt class='constant'>NULL</tt></b> if there are no more rows in resultset. </p> <p class='para'> If two or more columns of the result have the same field names, the last column will take precedence. To access the other column(s) of the same name, you either need to access the result with numeric indices by using <a href='http://www.php.net/manual/en/mysqli-result.fetch-row.php' class='function'>mysqli_fetch_row()</a> or add alias names. </p> </div> <a name='mysqli-result.fetch-assoc.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;by&amp;nbsp;ID&amp;nbsp;DESC&amp;nbsp;LIMIT&amp;nbsp;50,5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;associative&amp;nbsp;array&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_assoc</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'Name'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'CountryCode'</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;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;by&amp;nbsp;ID&amp;nbsp;DESC&amp;nbsp;LIMIT&amp;nbsp;50,5'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;associative&amp;nbsp;array&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'Name'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'CountryCode'</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;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Pueblo (USA) Arvada (USA) Cape Coral (USA) Green Bay (USA) Santa Clara (USA) </pre></div> </div> </div> <a name='mysqli-result.fetch-assoc.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/mysqli-result.fetch-array.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_array()</a> - Fetch a result row as an associative, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-row.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_row()</a> - Get a result row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-object.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_object()</a> - Returns the current row of a result set as an object</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.query.php' class='function' rel='rdfs-seeAlso'>mysqli_query()</a> - Performs a query on the database</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.data-seek.php' class='function' rel='rdfs-seeAlso'>mysqli_data_seek()</a> - Adjusts the result pointer to an arbitary row in the result</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="mysqli_fetch_array" value="<div id='mysqli-result.fetch-array' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.fetch-array.php'>mysqli_result::fetch_array</a></h1> <h1 class='refname'>mysqli_fetch_array</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result::fetch_array</span> -- <span class='refname'>mysqli_fetch_array</span> &amp;mdash; <span class='dc-title'>Fetch a result row as an associative, a numeric array, or both</span></p> </div> <a name='mysqli-result.fetch-array.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</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>mysqli_result::fetch_array</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resulttype</tt></span> ] )</div> <p class='para rdfs-comment'>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>mysqli_fetch_array</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resulttype</tt></span> ] )</div> <p class='para rdfs-comment'> Returns an array that corresponds to the fetched row or <b><tt class='constant'>NULL</tt></b> if there are no more rows for the resultset represented by the <i><tt class='parameter'>result</tt></i> parameter. </p> <p class='para'> <b>mysqli_fetch_array()</b> is an extended version of the <a href='http://www.php.net/manual/en/mysqli-result.fetch-row.php' class='function'>mysqli_fetch_row()</a> function. In addition to storing the data in the numeric indices of the result array, the <b>mysqli_fetch_array()</b> function can also store the data in associative indices, using the field names of the result set as keys. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Field names returned by this function are <em class='emphasis'>case-sensitive</em>.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> <p class='para'> If two or more columns of the result have the same field names, the last column will take precedence and overwrite the earlier data. In order to access multiple columns with the same name, the numerically indexed version of the row must be used. </p> </div> <a name='mysqli-result.fetch-array.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>resulttype</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This optional parameter is a constant indicating what type of array should be produced from the current row data. The possible values for this parameter are the constants <b><tt class='constant'>MYSQLI_ASSOC</tt></b>, <b><tt class='constant'>MYSQLI_NUM</tt></b>, or <b><tt class='constant'>MYSQLI_BOTH</tt></b>. Defaults to <b><tt class='constant'>MYSQLI_BOTH</tt></b>. </p> <p class='para'> By using the <b><tt class='constant'>MYSQLI_ASSOC</tt></b> constant this function will behave identically to the <a href='http://www.php.net/manual/en/mysqli-result.fetch-assoc.php' class='function'>mysqli_fetch_assoc()</a>, while <b><tt class='constant'>MYSQLI_NUM</tt></b> will behave identically to the <a href='http://www.php.net/manual/en/mysqli-result.fetch-row.php' class='function'>mysqli_fetch_row()</a> function. The final option <b><tt class='constant'>MYSQLI_BOTH</tt></b> will create a single array with the attributes of both. </p> </dd> </dl> <p> </p> </div> <a name='mysqli-result.fetch-array.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of strings that corresponds to the fetched row or <b><tt class='constant'>NULL</tt></b> if there are no more rows in resultset. </p> </div> <a name='mysqli-result.fetch-array.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;by&amp;nbsp;ID&amp;nbsp;LIMIT&amp;nbsp;3'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;numeric&amp;nbsp;array&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>MYSQLI_NUM</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;associative&amp;nbsp;array&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>MYSQLI_ASSOC</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'Name'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'CountryCode'</span><span style='color: #007700'>]);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;associative&amp;nbsp;and&amp;nbsp;numeric&amp;nbsp;array&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>MYSQLI_BOTH</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'CountryCode'</span><span style='color: #007700'>]);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;by&amp;nbsp;ID&amp;nbsp;LIMIT&amp;nbsp;3'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;numeric&amp;nbsp;array&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MYSQLI_NUM</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;associative&amp;nbsp;array&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MYSQLI_ASSOC</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'Name'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'CountryCode'</span><span style='color: #007700'>]);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;associative&amp;nbsp;and&amp;nbsp;numeric&amp;nbsp;array&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MYSQLI_BOTH</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%s&amp;nbsp;(%s)\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'CountryCode'</span><span style='color: #007700'>]);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;set&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Kabul (AFG) Qandahar (AFG) Herat (AFG) </pre></div> </div> </div> <a name='mysqli-result.fetch-array.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/mysqli-result.fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_assoc()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-row.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_row()</a> - Get a result row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-object.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_object()</a> - Returns the current row of a result set as an object</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.query.php' class='function' rel='rdfs-seeAlso'>mysqli_query()</a> - Performs a query on the database</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.data-seek.php' class='function' rel='rdfs-seeAlso'>mysqli_data_seek()</a> - Adjusts the result pointer to an arbitary row in the result</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="mysqli_fetch" value="<div id='function.mysqli-fetch' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-fetch.php'>mysqli_fetch</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_fetch</span> &amp;mdash; <span class='dc-title'>Alias for <a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function'>mysqli_stmt_fetch()</a></span></p> </div> <a name='function.mysqli-fetch.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of <a href='http://www.php.net/manual/en/mysqli-stmt.fetch.php' class='function'>mysqli_stmt_fetch()</a>. </p> </div> <a name='function.mysqli-fetch.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>mysqli_fetch()</b> is deprecated and will be removed. <br /> </p></blockquote> </div> <a name='function.mysqli-fetch.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/mysqli-stmt.fetch.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_fetch()</a> - Fetch results from a prepared statement into the bound variables</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="mysqli_execute" value="<div id='function.mysqli-execute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-execute.php'>mysqli_execute</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_execute</span> &amp;mdash; <span class='dc-title'>Alias for <a href='http://www.php.net/manual/en/mysqli-stmt.execute.php' class='function'>mysqli_stmt_execute()</a></span></p> </div> <a name='function.mysqli-execute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of <a href='http://www.php.net/manual/en/mysqli-stmt.execute.php' class='function'>mysqli_stmt_execute()</a>. </p> </div> <a name='function.mysqli-execute.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>mysqli_execute()</b> is deprecated and will be removed. <br /> </p></blockquote> </div> <a name='function.mysqli-execute.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/mysqli-stmt.execute.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_execute()</a> - Executes a prepared Query</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="mysqli_escape_string" value="<div id='function.mysqli-escape-string' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-escape-string.php'>mysqli_escape_string</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_escape_string</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/mysqli.real-escape-string.php' class='function'>mysqli_real_escape_string()</a></span></p> </div> <a name='function.mysqli-escape-string.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of <a href='http://www.php.net/manual/en/mysqli.real-escape-string.php' class='function'>mysqli_real_escape_string()</a>. </p> </div> <a name='function.mysqli-escape-string.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/mysqli.real-escape-string.php' class='function' rel='rdfs-seeAlso'>mysqli_real_escape_string()</a> - Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the 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="mysqli_error" value="<div id='mysqli.error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.error.php'>mysqli-&amp;gt;error</a></h1> <h1 class='refname'>mysqli_error</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;error</span> -- <span class='refname'>mysqli_error</span> &amp;mdash; <span class='dc-title'>Returns a string description of the last error</span></p> </div> <a name='mysqli.error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$error</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_error</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns the last error message for the most recent MySQLi function call that can succeed or fail. </p> </div> <a name='mysqli.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A string that describes the error. An empty string if no error occurred. </p> </div> <a name='mysqli.error.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SET&amp;nbsp;a=1'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Errormessage:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>error</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SET&amp;nbsp;a=1'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Errormessage:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Errormessage: Unknown system variable &amp;#039;a&amp;#039; </pre></div> </div> </div> <a name='mysqli.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/mysqli.connect-errno.php' class='function' rel='rdfs-seeAlso'>mysqli_connect_errno()</a> - Returns the error code from last connect call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.connect-error.php' class='function' rel='rdfs-seeAlso'>mysqli_connect_error()</a> - Returns a string description of the last connect error</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.errno.php' class='function' rel='rdfs-seeAlso'>mysqli_errno()</a> - Returns the error code for the most recent function call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.sqlstate.php' class='function' rel='rdfs-seeAlso'>mysqli_sqlstate()</a> - Returns the SQLSTATE error from previous MySQL operation</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="mysqli_errno" value="<div id='mysqli.errno' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.errno.php'>mysqli-&amp;gt;errno</a></h1> <h1 class='refname'>mysqli_errno</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;errno</span> -- <span class='refname'>mysqli_errno</span> &amp;mdash; <span class='dc-title'>Returns the error code for the most recent function call</span></p> </div> <a name='mysqli.errno.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$errno</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_errno</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns the last error code for the most recent MySQLi function call that can succeed or fail. </p> <p class='para'> Client error message numbers are listed in the MySQL <var class='filename'>errmsg.h</var> header file, server error message numbers are listed in <var class='filename'>mysqld_error.h</var>. In the MySQL source distribution you can find a complete list of error messages and error numbers in the file <var class='filename'>Docs/mysqld_error.txt</var>. </p> </div> <a name='mysqli.errno.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.errno.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An error code value for the last call, if it failed. zero means no error occurred. </p> </div> <a name='mysqli.errno.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SET&amp;nbsp;a=1'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Errorcode:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>errno</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SET&amp;nbsp;a=1'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Errorcode:&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_errno</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Errorcode: 1193 </pre></div> </div> </div> <a name='mysqli.errno.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/mysqli.connect-errno.php' class='function' rel='rdfs-seeAlso'>mysqli_connect_errno()</a> - Returns the error code from last connect call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.connect-error.php' class='function' rel='rdfs-seeAlso'>mysqli_connect_error()</a> - Returns a string description of the last connect error</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.error.php' class='function' rel='rdfs-seeAlso'>mysqli_error()</a> - Returns a string description of the last error</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.sqlstate.php' class='function' rel='rdfs-seeAlso'>mysqli_sqlstate()</a> - Returns the SQLSTATE error from previous MySQL operation</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="mysqli_enable_rpl_parse" value="<div id='function.mysqli-enable-rpl-parse' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-enable-rpl-parse.php'>mysqli_enable_rpl_parse</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_enable_rpl_parse</span> &amp;mdash; <span class='dc-title'>Enable RPL parse</span></p> </div> <a name='function.mysqli-enable-rpl-parse.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>mysqli_enable_rpl_parse</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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 class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> and <em class='emphasis'>REMOVED</em> as of PHP 5.3.0.</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="mysqli_enable_reads_from_master" value="<div id='function.mysqli-enable-reads-from-master' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-enable-reads-from-master.php'>mysqli_enable_reads_from_master</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_enable_reads_from_master</span> &amp;mdash; <span class='dc-title'>Enable reads from master</span></p> </div> <a name='function.mysqli-enable-reads-from-master.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>mysqli_enable_reads_from_master</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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 class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> and <em class='emphasis'>REMOVED</em> as of PHP 5.3.0.</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="mysqli_embedded_server_start" value="<div id='mysqli-driver.embedded-server-start' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-driver.embedded-server-start.php'>mysqli_driver::embedded_server_start</a></h1> <h1 class='refname'>mysqli_embedded_server_start</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_driver::embedded_server_start</span> -- <span class='refname'>mysqli_embedded_server_start</span> &amp;mdash; <span class='dc-title'>Initialize and start embedded server</span></p> </div> <a name='mysqli-driver.embedded-server-start.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>mysqli_driver::embedded_server_start</b></span> ( <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$start</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$arguments</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$groups</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_embedded_server_start</b></span> ( <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$start</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$arguments</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$groups</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> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mysqli_embedded_server_end" value="<div id='mysqli-driver.embedded-server-end' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-driver.embedded-server-end.php'>mysqli_driver::embedded_server_end</a></h1> <h1 class='refname'>mysqli_embedded_server_end</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_driver::embedded_server_end</span> -- <span class='refname'>mysqli_embedded_server_end</span> &amp;mdash; <span class='dc-title'>Stop embedded server</span></p> </div> <a name='mysqli-driver.embedded-server-end.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>mysqli_driver::embedded_server_end</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mysqli_embedded_server_end</b></span> ( <span class='methodparam'>void</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> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mysqli_dump_debug_info" value="<div id='mysqli.dump-debug-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.dump-debug-info.php'>mysqli::dump_debug_info</a></h1> <h1 class='refname'>mysqli_dump_debug_info</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::dump_debug_info</span> -- <span class='refname'>mysqli_dump_debug_info</span> &amp;mdash; <span class='dc-title'>Dump debugging information into the log</span></p> </div> <a name='mysqli.dump-debug-info.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::dump_debug_info</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_dump_debug_info</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> This function is designed to be executed by an user with the SUPER privilege and is used to dump debugging information into the log for the MySQL Server relating to the connection. </p> </div> <a name='mysqli.dump-debug-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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.dump-debug-info.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='mysqli.dump-debug-info.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/mysqli.debug.php' class='function' rel='rdfs-seeAlso'>mysqli_debug()</a> - Performs debugging operations</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="MySQLi_Driver" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.mysqli-driver.php'>The MySQLi_Driver class</a></h1> <div class='partintro'> <div id='mysqli-driver.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> MySQLi Driver. </p> </div> <div id='mysqli-driver.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>MySQLi_Driver</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>MySQLi_Driver</b> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Properties */</div> <div class='fieldsynopsis'> <span class='modifier'>public</span> <span class='modifier'>readonly</span> <span class='type'>string</span> <var class='varname'><a href='http://www.php.net/manual/en/class.mysqli-driver.php#mysqli-driver.props.client-info'>$client_info</a></var> ;</div> <div class='fieldsynopsis'> <span class='modifier'>public</span> <span class='modifier'>readonly</span> <span class='type'>string</span> <var class='varname'><a href='http://www.php.net/manual/en/class.mysqli-driver.php#mysqli-driver.props.client-version'>$client_version</a></var> ;</div> <div class='fieldsynopsis'> <span class='modifier'>public</span> <span class='modifier'>readonly</span> <span class='type'>string</span> <var class='varname'><a href='http://www.php.net/manual/en/class.mysqli-driver.php#mysqli-driver.props.driver-version'>$driver_version</a></var> ;</div> <div class='fieldsynopsis'> <span class='modifier'>public</span> <span class='modifier'>readonly</span> <span class='type'>string</span> <var class='varname'><a href='http://www.php.net/manual/en/class.mysqli-driver.php#mysqli-driver.props.embedded'>$embedded</a></var> ;</div> <div class='fieldsynopsis'> <span class='modifier'>public</span> <span class='type'>bool</span> <var class='varname'><a href='http://www.php.net/manual/en/class.mysqli-driver.php#mysqli-driver.props.reconnect'>$reconnect</a></var> ;</div> <div class='fieldsynopsis'> <span class='modifier'>public</span> <span class='type'>int</span> <var class='varname'><a href='http://www.php.net/manual/en/class.mysqli-driver.php#mysqli-driver.props.report-mode'>$report_mode</a></var> ;</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli-driver.embedded-server-end.php' class='function'>mysqli_driver::embedded_server_end</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/mysqli-driver.embedded-server-start.php' class='function'>mysqli_driver::embedded_server_start</a></span> ( <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$start</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$arguments</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$groups</tt></span> )</div> }</div> </div> <div id='mysqli-driver.props' class='section'> <h2 class='title'>Properties</h2> <dl> <dt id='mysqli-driver.props.client-info' class='varlistentry'> <span class='term'><var class='varname'>client_info</var></span> </dt><dd class='listitem'> <p class='para'>The Client API header version</p> </dd> <dt id='mysqli-driver.props.client-version' class='varlistentry'> <span class='term'><var class='varname'>client_version</var></span> </dt><dd class='listitem'> <p class='para'>The Client version</p> </dd> <dt id='mysqli-driver.props.driver-version' class='varlistentry'> <span class='term'><var class='varname'>driver_version</var></span> </dt><dd class='listitem'> <p class='para'>The MySQLi Driver version</p> </dd> <dt id='mysqli-driver.props.embedded' class='varlistentry'> <span class='term'><var class='varname'>embedded</var></span> </dt><dd class='listitem'> <p class='para'>Wether MySQLi Embedded support is enabled</p> </dd> <dt id='mysqli-driver.props.reconnect' class='varlistentry'> <span class='term'><var class='varname'>reconnect</var></span> </dt><dd class='listitem'> <p class='para'>Allow or prevent reconnect (see the mysqli.reconnect INI directive)</p> </dd> <dt id='mysqli-driver.props.report-mode' class='varlistentry'> <span class='term'><var class='varname'>report_mode</var></span> </dt><dd class='listitem'> <p class='para'> Set to <b><tt class='constant'>MYSQLI_REPORT_OFF</tt></b>, <b><tt class='constant'>MYSQLI_REPORT_ALL</tt></b> or any combination of <b><tt class='constant'>MYSQLI_REPORT_STRICT</tt></b> (throw Exceptions for errors), <b><tt class='constant'>MYSQLI_REPORT_ERROR</tt></b> (report errors) and <b><tt class='constant'>MYSQLI_REPORT_INDEX</tt></b> (errors regarding indexes). </p> </dd> </dl> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/mysqli-driver.embedded-server-end.php'>mysqli_driver::embedded_server_end</a> &amp;acirc;&amp;#128;&amp;#148; Stop embedded server</li><li><a href='http://www.php.net/manual/en/mysqli-driver.embedded-server-start.php'>mysqli_driver::embedded_server_start</a> &amp;acirc;&amp;#128;&amp;#148; Initialize and start embedded server</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="mysqli_disable_rpl_parse" value="<div id='function.mysqli-disable-rpl-parse' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-disable-rpl-parse.php'>mysqli_disable_rpl_parse</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_disable_rpl_parse</span> &amp;mdash; <span class='dc-title'>Disable RPL parse</span></p> </div> <a name='function.mysqli-disable-rpl-parse.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>mysqli_disable_rpl_parse</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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 class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> and <em class='emphasis'>REMOVED</em> as of PHP 5.3.0.</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="mysqli_disable_reads_from_master" value="<div id='function.mysqli-disable-reads-from-master' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-disable-reads-from-master.php'>mysqli_disable_reads_from_master</a></h1> <h1 class='refname'>mysqli-&amp;gt;disable_reads_from_master</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_disable_reads_from_master</span> -- <span class='refname'>mysqli-&amp;gt;disable_reads_from_master</span> &amp;mdash; <span class='dc-title'>Disable reads from master</span></p> </div> <a name='function.mysqli-disable-reads-from-master.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>mysqli_disable_reads_from_master</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'>Object oriented style (method):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='methodsynopsis dc-description'> <span class='type'>void</span> <span class='methodname'><b>disable_reads_from_master</b></span> ( <span class='methodparam'>void</span> )</div> </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 class='warning'><b class='warning'>Warning</b><p class='simpara'>This function has been <em class='emphasis'>DEPRECATED</em> and <em class='emphasis'>REMOVED</em> as of PHP 5.3.0.</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="mysqli_debug" value="<div id='mysqli.debug' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.debug.php'>mysqli::debug</a></h1> <h1 class='refname'>mysqli_debug</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::debug</span> -- <span class='refname'>mysqli_debug</span> &amp;mdash; <span class='dc-title'>Performs debugging operations</span></p> </div> <a name='mysqli.debug.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::debug</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$message</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_debug</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$message</tt></span> )</div> <p class='para rdfs-comment'> Performs debugging operations using the Fred Fish debugging library. </p> </div> <a name='mysqli.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'>message</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A string representing the debugging operation to perform </p> </dd> </dl> <p> </p> </div> <a name='mysqli.debug.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='mysqli.debug.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: To use the <b>mysqli_debug()</b> function you must compile the MySQL client library to support debugging. <br /> </p></blockquote> </div> <a name='mysqli.debug.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Generating a Trace File</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;Create&amp;nbsp;a&amp;nbsp;trace&amp;nbsp;file&amp;nbsp;in&amp;nbsp;'/tmp/client.trace'&amp;nbsp;on&amp;nbsp;the&amp;nbsp;local&amp;nbsp;(client)&amp;nbsp;machine:&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_debug</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'d:t:0,/tmp/client.trace'</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='mysqli.debug.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/mysqli.dump-debug-info.php' class='function' rel='rdfs-seeAlso'>mysqli_dump_debug_info()</a> - Dump debugging information into the log</li> <li class='member'><a href='http://www.php.net/manual/en/function.mysqli-report.php' class='function' rel='rdfs-seeAlso'>mysqli_report()</a> - Enables or disables internal report functions</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="mysqli_data_seek" value="<div id='mysqli-result.data-seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli-result.data-seek.php'>mysqli_result::data_seek</a></h1> <h1 class='refname'>mysqli_data_seek</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_result::data_seek</span> -- <span class='refname'>mysqli_data_seek</span> &amp;mdash; <span class='dc-title'>Adjusts the result pointer to an arbitary row in the result</span></p> </div> <a name='mysqli-result.data-seek.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_result::data_seek</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_data_seek</b></span> ( <span class='methodparam'><span class='type'><span class='type mysqli_result'>mysqli_result</span></span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> )</div> <p class='para rdfs-comment'> The <b>mysqli_data_seek()</b> function seeks to an arbitrary result pointer specified by the <i><tt class='parameter'>offset</tt></i> in the result set. </p> </div> <a name='mysqli-result.data-seek.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'> result</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A result set identifier returned by <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a>, <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli_use_result()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field offset. Must be between zero and the total number of rows minus one (0..<a href='http://www.php.net/manual/en/mysqli-result.num-rows.php' class='function'>mysqli_num_rows()</a> - 1). </p> </dd> </dl> <p> </p> </div> <a name='mysqli-result.data-seek.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='mysqli-result.data-seek.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function can only be used with buffered results attained from the use of the <a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli_store_result()</a> or <a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli_query()</a> functions. <br /> </p></blockquote> </div> <a name='mysqli-result.data-seek.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;seek&amp;nbsp;to&amp;nbsp;row&amp;nbsp;no.&amp;nbsp;400&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>data_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>399</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;row&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</span><span style='color: #007700'>();<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'City:&amp;nbsp;%s&amp;nbsp;&amp;nbsp;Countrycode:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;set*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;Name,&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;City&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;Name'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;seek&amp;nbsp;to&amp;nbsp;row&amp;nbsp;no.&amp;nbsp;400&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_data_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>399</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;fetch&amp;nbsp;row&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'City:&amp;nbsp;%s&amp;nbsp;&amp;nbsp;Countrycode:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;free&amp;nbsp;result&amp;nbsp;set*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> City: Benin City Countrycode: NGA </pre></div> </div> </div> <a name='mysqli-result.data-seek.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/mysqli.store-result.php' class='function' rel='rdfs-seeAlso'>mysqli_store_result()</a> - Transfers a result set from the last query</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-row.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_row()</a> - Get a result row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-array.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_array()</a> - Fetch a result row as an associative, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_assoc()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.fetch-object.php' class='function' rel='rdfs-seeAlso'>mysqli_fetch_object()</a> - Returns the current row of a result set as an object</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.query.php' class='function' rel='rdfs-seeAlso'>mysqli_query()</a> - Performs a query on the database</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli-result.num-rows.php' class='function' rel='rdfs-seeAlso'>mysqli_num_rows()</a> - Gets the number of rows in a result</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="mysqli_connect_error" value="<div id='mysqli.connect-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.connect-error.php'>mysqli-&amp;gt;connect_error</a></h1> <h1 class='refname'>mysqli_connect_error</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;connect_error</span> -- <span class='refname'>mysqli_connect_error</span> &amp;mdash; <span class='dc-title'>Returns a string description of the last connect error</span></p> </div> <a name='mysqli.connect-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$connect_error</var>;</div> </div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_connect_error</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns the last error message string from the last call to <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a>. </p> </div> <a name='mysqli.connect-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A string that describes the error. An empty string if no error occurred. </p> </div> <a name='mysqli.connect-error.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'fake_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_db'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Works&amp;nbsp;as&amp;nbsp;of&amp;nbsp;PHP&amp;nbsp;5.2.9&amp;nbsp;and&amp;nbsp;5.3.0.<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect_error</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect_error</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'fake_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_db'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Connect Error: Access denied for user &amp;#039;fake_user&amp;#039;@&amp;#039;localhost&amp;#039; (using password: YES) </pre></div> </div> </div> <a name='mysqli.connect-error.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='warning'><b class='warning'>Warning</b> <p class='para'> The mysqli-&amp;gt;connect_error property only works properly as of PHP versions 5.2.9 and 5.3.0. Use the <b>mysqli_connect_error()</b> function if compatibility with earlier PHP versions is required. </p> </div> </div> <a name='mysqli.connect-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/mysqli.connect.php' class='function' rel='rdfs-seeAlso'>mysqli_connect()</a> - Open a new connection to the MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.connect-errno.php' class='function' rel='rdfs-seeAlso'>mysqli_connect_errno()</a> - Returns the error code from last connect call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.errno.php' class='function' rel='rdfs-seeAlso'>mysqli_errno()</a> - Returns the error code for the most recent function call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.error.php' class='function' rel='rdfs-seeAlso'>mysqli_error()</a> - Returns a string description of the last error</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.sqlstate.php' class='function' rel='rdfs-seeAlso'>mysqli_sqlstate()</a> - Returns the SQLSTATE error from previous MySQL operation</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="mysqli_connect_errno" value="<div id='mysqli.connect-errno' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.connect-errno.php'>mysqli-&amp;gt;connect_errno</a></h1> <h1 class='refname'>mysqli_connect_errno</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;connect_errno</span> -- <span class='refname'>mysqli_connect_errno</span> &amp;mdash; <span class='dc-title'>Returns the error code from last connect call</span></p> </div> <a name='mysqli.connect-errno.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$connect_errno</var>;</div> </div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_connect_errno</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns the last error code number from the last call to <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a>. </p> <blockquote><p><b class='note'>Note</b>: Client error message numbers are listed in the MySQL <var class='filename'>errmsg.h</var> header file, server error message numbers are listed in <var class='filename'>mysqld_error.h</var>. In the MySQL source distribution you can find a complete list of error messages and error numbers in the file <var class='filename'>Docs/mysqld_error.txt</var>. <br /> </p></blockquote> </div> <a name='mysqli.connect-errno.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An error code value for the last call to <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a>, if it failed. zero means no error occurred. </p> </div> <a name='mysqli.connect-errno.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'fake_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_db'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect_errno</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect_errno</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'fake_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_db'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Connect Error: 1045 </pre></div> </div> </div> <a name='mysqli.connect-errno.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/mysqli.connect.php' class='function' rel='rdfs-seeAlso'>mysqli_connect()</a> - Open a new connection to the MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.connect-error.php' class='function' rel='rdfs-seeAlso'>mysqli_connect_error()</a> - Returns a string description of the last connect error</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.errno.php' class='function' rel='rdfs-seeAlso'>mysqli_errno()</a> - Returns the error code for the most recent function call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.error.php' class='function' rel='rdfs-seeAlso'>mysqli_error()</a> - Returns a string description of the last error</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.sqlstate.php' class='function' rel='rdfs-seeAlso'>mysqli_sqlstate()</a> - Returns the SQLSTATE error from previous MySQL operation</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="mysqli_connect" value="<div id='mysqli.connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.connect.php'>mysqli::__construct</a></h1> <h1 class='refname'>mysqli_connect</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::__construct</span> -- <span class='refname'>mysqli_connect</span> &amp;mdash; <span class='dc-title'>Open a new connection to the MySQL server</span></p> </div> <a name='mysqli.connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (constructor):</p> <div class='constructorsynopsis dc-description'> <span class='methodname'><b>mysqli::__construct</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$host</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_host&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_user&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$passwd</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_pw&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dbname</tt><span class='initializer'> = &amp;quot;&amp;quot;</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_port&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$socket</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_socket&amp;quot;)</span></span> ]]]]]] )</div> <p class='para rdfs-comment'>Procedural style</p> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <span class='methodname'><b>mysqli_connect</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$host</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_host&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_user&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$passwd</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_pw&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dbname</tt><span class='initializer'> = &amp;quot;&amp;quot;</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_port&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$socket</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_socket&amp;quot;)</span></span> ]]]]]] )</div> <p class='para rdfs-comment'> Opens a connection to the MySQL Server running on. </p> </div> <a name='mysqli.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'> Can be either a host name or an IP address. Passing the <b><tt class='constant'>NULL</tt></b> value or the string &amp;quot;localhost&amp;quot; to this parameter, the local host is assumed. When possible, pipes will be used instead of the TCP/IP protocol. </p> <p class='para'> Prepending host by <i>p:</i> opens a persistent connection. <a href='http://www.php.net/manual/en/mysqli.change-user.php' class='function'>mysqli_change_user()</a> is automatically called on connections opened from the connection pool. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The MySQL user name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>passwd</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If not provided or <b><tt class='constant'>NULL</tt></b>, the MySQL server will attempt to authenticate the user against those user records which have no password only. This allows one username to be used with different permissions (depending on if a password as provided or not). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dbname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If provided will specify the default database to be used when performing queries. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the port number to attempt to connect to the MySQL server. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>socket</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the socket or named pipe that should be used. </p> <blockquote><p><b class='note'>Note</b>: Specifying the <i><tt class='parameter'>socket</tt></i> parameter will not explicitly determine the type of connection to be used when connecting to the MySQL server. How the connection is made to the MySQL database is determined by the <i><tt class='parameter'>host</tt></i> parameter. <br /> </p></blockquote> </dd> </dl> <p> </p> </div> <a name='mysqli.connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object which represents the connection to a MySQL Server. </p> </div> <a name='mysqli.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'>5.3.0</td> <td align='left'> Added the ability of persistent connections. </td> </tr> </tbody> </table> <p> </p> </div> <a name='mysqli.connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_db'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*<br />&amp;nbsp;*&amp;nbsp;This&amp;nbsp;is&amp;nbsp;the&amp;nbsp;'official'&amp;nbsp;OO&amp;nbsp;way&amp;nbsp;to&amp;nbsp;do&amp;nbsp;it,<br />&amp;nbsp;*&amp;nbsp;BUT&amp;nbsp;$connect_error&amp;nbsp;was&amp;nbsp;broken&amp;nbsp;until&amp;nbsp;PHP&amp;nbsp;5.2.9&amp;nbsp;and&amp;nbsp;5.3.0.<br />&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect_error</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error&amp;nbsp;('&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect_errno&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>')&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: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>connect_error</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*<br />&amp;nbsp;*&amp;nbsp;Use&amp;nbsp;this&amp;nbsp;instead&amp;nbsp;of&amp;nbsp;$connect_error&amp;nbsp;if&amp;nbsp;you&amp;nbsp;need&amp;nbsp;to&amp;nbsp;ensure<br />&amp;nbsp;*&amp;nbsp;compatibility&amp;nbsp;with&amp;nbsp;PHP&amp;nbsp;versions&amp;nbsp;prior&amp;nbsp;to&amp;nbsp;5.2.9&amp;nbsp;and&amp;nbsp;5.3.0.<br />&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error&amp;nbsp;('&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>')&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: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Success...&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>host_info&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'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Object oriented style when extending mysqli class</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'>class&amp;nbsp;</span><span style='color: #0000BB'>foo_mysqli&amp;nbsp;</span><span style='color: #007700'>extends&amp;nbsp;</span><span style='color: #0000BB'>mysqli&amp;nbsp;</span><span style='color: #007700'>{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;public&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>__construct</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$host</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$pass</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>parent</span><span style='color: #007700'>::</span><span style='color: #0000BB'>__construct</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$host</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$pass</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$db</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'>mysqli_connect_error</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;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error&amp;nbsp;('&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>')&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;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</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'>$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>foo_mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_db'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Success...&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>host_info&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'>$db</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #3 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_db'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Connect&amp;nbsp;Error&amp;nbsp;('&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>')&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: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Success...&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysqli_get_host_info</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</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'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Success... MySQL host info: localhost via TCP/IP </pre></div> </div> </div> <a name='mysqli.connect.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: OO syntax only: If a connection fails an object is still returned. To check if the connection failed then use either the <a href='http://www.php.net/manual/en/mysqli.connect-error.php' class='function'>mysqli_connect_error()</a> function or the <a href='http://www.php.net/manual/en/mysqli.connect-error.php' class='link'>mysqli-&amp;gt;connect_error</a> property like in the examples above. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: If it is necessary to set options, such as the connection timeout, <a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function'>mysqli_real_connect()</a> must be used instead. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: Calling the constructor with no parameters is the same as calling <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a>. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: Error &amp;quot;Can&amp;#039;t create TCP/IP socket (10106)&amp;quot; usually means that the <a href='http://www.php.net/manual/en/ini.core.php#ini.variables-order' class='link'>variables_order</a> configure directive doesn&amp;#039;t contain character <i>E</i>. On Windows, if the environment is not copied the <i>SYSTEMROOT</i> environment variable won&amp;#039;t be available and PHP will have problems loading Winsock. <br /> </p></blockquote> </div> <a name='mysqli.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/mysqli.real-connect.php' class='function' rel='rdfs-seeAlso'>mysqli_real_connect()</a> - Opens a connection to a mysql server</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.options.php' class='function' rel='rdfs-seeAlso'>mysqli_options()</a> - Set options</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.connect-errno.php' class='function' rel='rdfs-seeAlso'>mysqli_connect_errno()</a> - Returns the error code from last connect call</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.connect-error.php' class='function' rel='rdfs-seeAlso'>mysqli_connect_error()</a> - Returns a string description of the last connect error</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.close.php' class='function' rel='rdfs-seeAlso'>mysqli_close()</a> - Closes a previously opened database 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="mysqli_commit" value="<div id='mysqli.commit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.commit.php'>mysqli::commit</a></h1> <h1 class='refname'>mysqli_commit</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::commit</span> -- <span class='refname'>mysqli_commit</span> &amp;mdash; <span class='dc-title'>Commits the current transaction</span></p> </div> <a name='mysqli.commit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method)</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::commit</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_commit</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Commits the current transaction for the database connection. </p> </div> <a name='mysqli.commit.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.commit.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='mysqli.commit.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;Language&amp;nbsp;LIKE&amp;nbsp;CountryLanguage&amp;nbsp;Type=InnoDB'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;set&amp;nbsp;autocommit&amp;nbsp;to&amp;nbsp;off&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>FALSE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Insert&amp;nbsp;some&amp;nbsp;values&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;Language&amp;nbsp;VALUES&amp;nbsp;('DEU',&amp;nbsp;'Bavarian',&amp;nbsp;'F',&amp;nbsp;11.2)'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;Language&amp;nbsp;VALUES&amp;nbsp;('DEU',&amp;nbsp;'Swabian',&amp;nbsp;'F',&amp;nbsp;9.4)'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;commit&amp;nbsp;transaction&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>commit</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;drop&amp;nbsp;table&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;Language'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;set&amp;nbsp;autocommit&amp;nbsp;to&amp;nbsp;off&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>FALSE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;Language&amp;nbsp;LIKE&amp;nbsp;CountryLanguage&amp;nbsp;Type=InnoDB'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Insert&amp;nbsp;some&amp;nbsp;values&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;Language&amp;nbsp;VALUES&amp;nbsp;('DEU',&amp;nbsp;'Bavarian',&amp;nbsp;'F',&amp;nbsp;11.2)'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;Language&amp;nbsp;VALUES&amp;nbsp;('DEU',&amp;nbsp;'Swabian',&amp;nbsp;'F',&amp;nbsp;9.4)'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;commit&amp;nbsp;transaction&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='mysqli.commit.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/mysqli.autocommit.php' class='function' rel='rdfs-seeAlso'>mysqli_autocommit()</a> - Turns on or off auto-commiting database modifications</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.rollback.php' class='function' rel='rdfs-seeAlso'>mysqli_rollback()</a> - Rolls back current transaction</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="mysqli_close" value="<div id='mysqli.close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.close.php'>mysqli::close</a></h1> <h1 class='refname'>mysqli_close</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::close</span> -- <span class='refname'>mysqli_close</span> &amp;mdash; <span class='dc-title'>Closes a previously opened database connection</span></p> </div> <a name='mysqli.close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::close</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_close</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Closes a previously opened database connection. </p> </div> <a name='mysqli.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.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='mysqli.close.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> See <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a>. </p> </div> <a name='mysqli.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/mysqli.connect.php' class='function' rel='rdfs-seeAlso'>mysqli_connect()</a> - Open a new connection to the MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.init.php' class='function' rel='rdfs-seeAlso'>mysqli_init()</a> - Initializes MySQLi and returns a resource for use with mysqli_real_connect()</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function' rel='rdfs-seeAlso'>mysqli_real_connect()</a> - Opens a connection to a mysql 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="mysqli_client_encoding" value="<div id='function.mysqli-client-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-client-encoding.php'>mysqli_client_encoding</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_client_encoding</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/mysqli.character-set-name.php' class='function'>mysqli_character_set_name()</a></span></p> </div> <a name='function.mysqli-client-encoding.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of <a href='http://www.php.net/manual/en/mysqli.character-set-name.php' class='function'>mysqli_character_set_name()</a>. </p> </div> <a name='function.mysqli-client-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/mysqli.real-escape-string.php' class='function' rel='rdfs-seeAlso'>mysqli_real_escape_string()</a> - Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the 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="mysqli_character_set_name" value="<div id='mysqli.character-set-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.character-set-name.php'>mysqli::character_set_name</a></h1> <h1 class='refname'>mysqli_character_set_name</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::character_set_name</span> -- <span class='refname'>mysqli_character_set_name</span> &amp;mdash; <span class='dc-title'>Returns the default character set for the database connection</span></p> </div> <a name='mysqli.character-set-name.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli::character_set_name</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mysqli_character_set_name</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns the current character set for the database connection. </p> </div> <a name='mysqli.character-set-name.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.character-set-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'>The default character set for the current connection</p> </div> <a name='mysqli.character-set-name.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Print&amp;nbsp;current&amp;nbsp;character&amp;nbsp;set&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$charset&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>character_set_name</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Current&amp;nbsp;character&amp;nbsp;set&amp;nbsp;is&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$charset</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;Open&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Print&amp;nbsp;current&amp;nbsp;character&amp;nbsp;set&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$charset&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_character_set_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Current&amp;nbsp;character&amp;nbsp;set&amp;nbsp;is&amp;nbsp;%s\n'</span><span style='color: #007700'>,</span><span style='color: #0000BB'>$charset</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Current character set is latin1_swedish_ci </pre></div> </div> </div> <a name='mysqli.character-set-name.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.mysqli-client-encoding.php' class='function' rel='rdfs-seeAlso'>mysqli_client_encoding()</a> - Alias of mysqli_character_set_name</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.real-escape-string.php' class='function' rel='rdfs-seeAlso'>mysqli_real_escape_string()</a> - Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the 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="mysqli_change_user" value="<div id='mysqli.change-user' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.change-user.php'>mysqli::change_user</a></h1> <h1 class='refname'>mysqli_change_user</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::change_user</span> -- <span class='refname'>mysqli_change_user</span> &amp;mdash; <span class='dc-title'>Changes the user of the specified database connection</span></p> </div> <a name='mysqli.change-user.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method):</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::change_user</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$user</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$database</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_change_user</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$user</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$database</tt></span> )</div> <p class='para rdfs-comment'> Changes the user of the specified database connection and sets the current database. </p> <p class='para'> In order to successfully change users a valid <i><tt class='parameter'>username</tt></i> and <i><tt class='parameter'>password</tt></i> parameters must be provided and that user must have sufficient permissions to access the desired database. If for any reason authorization fails, the current user authentication will remain. </p> </div> <a name='mysqli.change-user.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>user</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The MySQL 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 MySQL password. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>database</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The database to change to. </p> <p class='para'> If desired, the <b><tt class='constant'>NULL</tt></b> value may be passed resulting in only changing the user and not selecting a database. To select a database in this case use the <a href='http://www.php.net/manual/en/mysqli.select-db.php' class='function'>mysqli_select_db()</a> function. </p> </dd> </dl> <p> </p> </div> <a name='mysqli.change-user.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='mysqli.change-user.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Using this command will always cause the current database connection to behave as if was a completely new database connection, regardless of if the operation was completed successfully. This reset includes performing a rollback on any active transactions, closing all temporary tables, and unlocking all locked tables. <br /> </p></blockquote> </div> <a name='mysqli.change-user.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</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;connect&amp;nbsp;database&amp;nbsp;test&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Set&amp;nbsp;Variable&amp;nbsp;a&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SET&amp;nbsp;@a:=1'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;reset&amp;nbsp;all&amp;nbsp;and&amp;nbsp;select&amp;nbsp;a&amp;nbsp;new&amp;nbsp;database&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>change_user</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;DATABASE()'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</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: #DD0000'>'Default&amp;nbsp;database:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;@a'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</span><span style='color: #007700'>();<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;===&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Value&amp;nbsp;of&amp;nbsp;variable&amp;nbsp;a&amp;nbsp;is&amp;nbsp;NULL\n'</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'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</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;database&amp;nbsp;test&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Set&amp;nbsp;Variable&amp;nbsp;a&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SET&amp;nbsp;@a:=1'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;reset&amp;nbsp;all&amp;nbsp;and&amp;nbsp;select&amp;nbsp;a&amp;nbsp;new&amp;nbsp;database&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_change_user</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;DATABASE()'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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: #DD0000'>'Default&amp;nbsp;database:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;@a'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;===&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Value&amp;nbsp;of&amp;nbsp;variable&amp;nbsp;a&amp;nbsp;is&amp;nbsp;NULL\n'</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'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Default database: world Value of variable a is NULL </pre></div> </div> </div> <a name='mysqli.change-user.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/mysqli.connect.php' class='function' rel='rdfs-seeAlso'>mysqli_connect()</a> - Open a new connection to the MySQL server</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.select-db.php' class='function' rel='rdfs-seeAlso'>mysqli_select_db()</a> - Selects the default database for database queries</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="mysqli_bind_result" value="<div id='function.mysqli-bind-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-bind-result.php'>mysqli_bind_result</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_bind_result</span> &amp;mdash; <span class='dc-title'>Alias for <a href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php' class='function'>mysqli_stmt_bind_result()</a></span></p> </div> <a name='function.mysqli-bind-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of <a href='http://www.php.net/manual/en/mysqli-stmt.bind-result.php' class='function'>mysqli_stmt_bind_result()</a>. </p> </div> <a name='function.mysqli-bind-result.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>mysqli_bind_result()</b> is deprecated and will be removed. <br /> </p></blockquote> </div> <a name='function.mysqli-bind-result.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/mysqli-stmt.bind-result.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_result()</a> - Binds variables to a prepared statement for result storage</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="mysqli_bind_param" value="<div id='function.mysqli-bind-param' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mysqli-bind-param.php'>mysqli_bind_param</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli_bind_param</span> &amp;mdash; <span class='dc-title'>Alias for <a href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php' class='function'>mysqli_stmt_bind_param()</a></span></p> </div> <a name='function.mysqli-bind-param.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of <a href='http://www.php.net/manual/en/mysqli-stmt.bind-param.php' class='function'>mysqli_stmt_bind_param()</a>. </p> </div> <a name='function.mysqli-bind-param.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>mysqli_bind_param()</b> is deprecated and will be removed. <br /> </p></blockquote> </div> <a name='function.mysqli-bind-param.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/mysqli-stmt.bind-param.php' class='function' rel='rdfs-seeAlso'>mysqli_stmt_bind_param()</a> - Binds variables to a prepared statement as parameters</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="mysqli_autocommit" value="<div id='mysqli.autocommit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.autocommit.php'>mysqli::autocommit</a></h1> <h1 class='refname'>mysqli_autocommit</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli::autocommit</span> -- <span class='refname'>mysqli_autocommit</span> &amp;mdash; <span class='dc-title'>Turns on or off auto-commiting database modifications</span></p> </div> <a name='mysqli.autocommit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (method)</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli::autocommit</b></span> ( <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$mode</tt></span> )</div> <p class='para rdfs-comment'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mysqli_autocommit</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$mode</tt></span> )</div> <p class='para rdfs-comment'> Turns on or off auto-commit mode on queries for the database connection. </p> <p class='para'> To determine the current state of autocommit use the SQL command <i>SELECT @@autocommit</i>. </p> </div> <a name='mysqli.autocommit.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whether to turn on auto-commit or not. </p> </dd> </dl> <p> </p> </div> <a name='mysqli.autocommit.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='mysqli.autocommit.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function doesn&amp;#039;t work with non transactional table types (like MyISAM or ISAM). <br /> </p></blockquote> </div> <a name='mysqli.autocommit.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;turn&amp;nbsp;autocommit&amp;nbsp;on&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>TRUE</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;@@autocommit'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>fetch_row</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: #DD0000'>'Autocommit&amp;nbsp;is&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>free</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Can't&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;localhost.&amp;nbsp;Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;turn&amp;nbsp;autocommit&amp;nbsp;on&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>TRUE</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;@@autocommit'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</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: #DD0000'>'Autocommit&amp;nbsp;is&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Autocommit is 1 </pre></div> </div> </div> <a name='mysqli.autocommit.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/mysqli.commit.php' class='function' rel='rdfs-seeAlso'>mysqli_commit()</a> - Commits the current transaction</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.rollback.php' class='function' rel='rdfs-seeAlso'>mysqli_rollback()</a> - Rolls back current transaction</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="mysqli_affected_rows" value="<div id='mysqli.affected-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/mysqli.affected-rows.php'>mysqli-&amp;gt;affected_rows</a></h1> <h1 class='refname'>mysqli_affected_rows</h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mysqli-&amp;gt;affected_rows</span> -- <span class='refname'>mysqli_affected_rows</span> &amp;mdash; <span class='dc-title'>Gets the number of affected rows in a previous MySQL operation</span></p> </div> <a name='mysqli.affected-rows.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'>Object oriented style (property):</p> <div class='classsynopsis'> <div class='ooclass'><a href='http://www.php.net/manual/en/class.mysqli.php' class='classname'>mysqli</a></div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$affected_rows</var>;</div> </div> <p class='para'>Procedural style:</p> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mysqli_affected_rows</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of rows affected by the last <i>INSERT</i>, <i>UPDATE</i>, <i>REPLACE</i> or <i>DELETE</i> query. </p> <p class='para'> For SELECT statements <b>mysqli_affected_rows()</b> works like <a href='http://www.php.net/manual/en/mysqli-result.num-rows.php' class='function'>mysqli_num_rows()</a>. </p> </div> <a name='mysqli.affected-rows.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'> link</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Procedural style only: A link identifier returned by <a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect()</a> or <a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli_init()</a> </p></dd> </dl> <p> </p> </div> <a name='mysqli.affected-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An integer greater than zero indicates the number of rows affected or retrieved. Zero indicates that no records where updated for an UPDATE statement, no rows matched the <i>WHERE</i> clause in the query or that no query has yet been executed. -1 indicates that the query returned an error. </p> <blockquote><p><b class='note'>Note</b>: If the number of affected rows is greater than maximal int value, the number of affected rows will be returned as a string. <br /> </p></blockquote> </div> <a name='mysqli.affected-rows.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Object oriented style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$mysqli&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>mysqli</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;check&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>mysqli_connect_errno</span><span style='color: #007700'>())&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Connect&amp;nbsp;failed:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Insert&amp;nbsp;rows&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;Language&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;from&amp;nbsp;CountryLanguage'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Affected&amp;nbsp;rows&amp;nbsp;(INSERT):&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>affected_rows</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ALTER&amp;nbsp;TABLE&amp;nbsp;Language&amp;nbsp;ADD&amp;nbsp;Status&amp;nbsp;int&amp;nbsp;default&amp;nbsp;0'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;update&amp;nbsp;rows&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'UPDATE&amp;nbsp;Language&amp;nbsp;SET&amp;nbsp;Status=1&amp;nbsp;WHERE&amp;nbsp;Percentage&amp;nbsp;&amp;gt;&amp;nbsp;50'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Affected&amp;nbsp;rows&amp;nbsp;(UPDATE):&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>affected_rows</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;delete&amp;nbsp;rows&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;Language&amp;nbsp;WHERE&amp;nbsp;Percentage&amp;nbsp;&amp;lt;&amp;nbsp;50'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Affected&amp;nbsp;rows&amp;nbsp;(DELETE):&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>affected_rows</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;select&amp;nbsp;all&amp;nbsp;rows&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;Language'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Affected&amp;nbsp;rows&amp;nbsp;(SELECT):&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>affected_rows</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$result</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Delete&amp;nbsp;table&amp;nbsp;Language&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;Language'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$mysqli</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>close</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 Procedural style</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_password'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'world'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Can't&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;localhost.&amp;nbsp;Error:&amp;nbsp;%s\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_connect_error</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit();<br />}<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Insert&amp;nbsp;rows&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;Language&amp;nbsp;SELECT&amp;nbsp;*&amp;nbsp;from&amp;nbsp;CountryLanguage'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Affected&amp;nbsp;rows&amp;nbsp;(INSERT):&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_affected_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ALTER&amp;nbsp;TABLE&amp;nbsp;Language&amp;nbsp;ADD&amp;nbsp;Status&amp;nbsp;int&amp;nbsp;default&amp;nbsp;0'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;update&amp;nbsp;rows&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UPDATE&amp;nbsp;Language&amp;nbsp;SET&amp;nbsp;Status=1&amp;nbsp;WHERE&amp;nbsp;Percentage&amp;nbsp;&amp;gt;&amp;nbsp;50'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Affected&amp;nbsp;rows&amp;nbsp;(UPDATE):&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_affected_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;delete&amp;nbsp;rows&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;Language&amp;nbsp;WHERE&amp;nbsp;Percentage&amp;nbsp;&amp;lt;&amp;nbsp;50'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Affected&amp;nbsp;rows&amp;nbsp;(DELETE):&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_affected_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;select&amp;nbsp;all&amp;nbsp;rows&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;CountryCode&amp;nbsp;FROM&amp;nbsp;Language'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Affected&amp;nbsp;rows&amp;nbsp;(SELECT):&amp;nbsp;%d\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mysqli_affected_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>mysqli_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Delete&amp;nbsp;table&amp;nbsp;Language&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;Language'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;close&amp;nbsp;connection&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mysqli_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <p class='para'>The above example will output:</p> <div class='example-contents screen'> <div class='cdata'><pre> Affected rows (INSERT): 984 Affected rows (UPDATE): 168 Affected rows (DELETE): 815 Affected rows (SELECT): 169 </pre></div> </div> </div> <a name='mysqli.affected-rows.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/mysqli-result.num-rows.php' class='function' rel='rdfs-seeAlso'>mysqli_num_rows()</a> - Gets the number of rows in a result</li> <li class='member'><a href='http://www.php.net/manual/en/mysqli.info.php' class='function' rel='rdfs-seeAlso'>mysqli_info()</a> - Retrieves information about the most recently executed query</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="MySQLi" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.mysqli.php'>The MySQLi class</a></h1> <div class='partintro'> <div id='mysqli.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> Represents a connection between PHP and a MySQL database. </p> </div> <div id='mysqli.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>MySQLi</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>MySQLi</b> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Properties */</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$affected_rows</var>;</div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$connect_errno</var>;</div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$connect_error</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$errno</var>;</div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$error</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$field_count</var>;</div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$host_info</var>;</div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$protocol_version</var>;</div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$server_info</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$server_version</var>;</div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$info</var>;</div> <div class='fieldsynopsis'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <var class='varname'>$insert_id</var>;</div> <div class='fieldsynopsis'><span class='type'>string</span> <var class='varname'>$sqlstate</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$thread_id</var>;</div> <div class='fieldsynopsis'><span class='type'>int</span> <var class='varname'>$warning_count</var>;</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.affected-rows.php' class='function'>mysqli_affected_rows</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.autocommit.php' class='function'>mysqli::autocommit</a></span> ( <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$mode</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.change-user.php' class='function'>mysqli::change_user</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$user</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$database</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.character-set-name.php' class='function'>mysqli::character_set_name</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/mysqli.close.php' class='function'>mysqli::close</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/mysqli.commit.php' class='function'>mysqli::commit</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/mysqli.connect-errno.php' class='function'>mysqli_connect_errno</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.connect-error.php' class='function'>mysqli_connect_error</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mysqli</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.connect.php' class='function'>mysqli_connect</a></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$host</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_host&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_user&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$passwd</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_pw&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dbname</tt><span class='initializer'> = &amp;quot;&amp;quot;</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_port&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$socket</tt><span class='initializer'> = ini_get(&amp;quot;mysqli.default_socket&amp;quot;)</span></span> ]]]]]] )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.debug.php' class='function'>mysqli::debug</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$message</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.dump-debug-info.php' class='function'>mysqli::dump_debug_info</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/mysqli.errno.php' class='function'>mysqli_errno</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.error.php' class='function'>mysqli_error</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.field-count.php' class='function'>mysqli_field_count</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.get-cache-stats.php' class='function'>mysqli::get_cache_stats</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.get-charset.php' class='function'>mysqli::get_charset</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.get-client-info.php' class='function'>mysqli::get_client_info</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/mysqli.get-client-stats.php' class='function'>mysqli::get_client_stats</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/mysqli.get-client-version.php' class='function'>mysqli::get_client_version</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/mysqli.get-connection-stats.php' class='function'>mysqli::get_connection_stats</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.get-host-info.php' class='function'>mysqli_get_host_info</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.get-proto-info.php' class='function'>mysqli_get_proto_info</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.get-server-info.php' class='function'>mysqli_get_server_info</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.get-server-version.php' class='function'>mysqli_get_server_version</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.get-warnings.php' class='function'>mysqli::get_warnings</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.info.php' class='function'>mysqli_info</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mysqli</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.init.php' class='function'>mysqli::init</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mixed</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.insert-id.php' class='function'>mysqli_insert_id</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.kill.php' class='function'>mysqli::kill</a></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$processid</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.more-results.php' class='function'>mysqli::more_results</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/mysqli.multi-query.php' class='function'>mysqli::multi_query</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.next-result.php' class='function'>mysqli::next_result</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/mysqli.options.php' class='function'>mysqli::options</a></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> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.ping.php' class='function'>mysqli::ping</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.poll.php' class='function'>mysqli::poll</a></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;$error</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$reject</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$sec</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$usec</tt></span> ] )</div> <div class='methodsynopsis dc-description'> <span class='type'>mysqli_stmt</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.prepare.php' class='function'>mysqli::prepare</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mixed</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.query.php' class='function'>mysqli::query</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$resultmode</tt></span> ] )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.real-connect.php' class='function'>mysqli::real_connect</a></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'>$username</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$passwd</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dbname</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$socket</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt></span> ]]]]]]] )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/function.mysqli-escape-string.php' class='function'>mysqli::escape_string</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$escapestr</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.real-query.php' class='function'>mysqli::real_query</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>mysqli_result</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.reap-async-query.php' class='function'>mysqli::reap_async_query</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/mysqli.rollback.php' class='function'>mysqli::rollback</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/mysqli.select-db.php' class='function'>mysqli::select_db</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dbname</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.set-charset.php' class='function'>mysqli::set_charset</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.set-local-infile-default.php' class='function'>mysqli_set_local_infile_default</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.set-local-infile-handler.php' class='function'>mysqli_set_local_infile_handler</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</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'>$read_func</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.sqlstate.php' class='function'>mysqli_sqlstate</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.ssl-set.php' class='function'>mysqli::ssl_set</a></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$key</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$cert</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$ca</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$capath</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$cipher</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.stat.php' class='function'>mysqli::stat</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mysqli_stmt</span> <span class='methodname'><b>stmt_init</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mysqli_result</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.store-result.php' class='function'>mysqli::store_result</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/mysqli.thread-id.php' class='function'>mysqli_thread_id</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.thread-safe.php' class='function'>mysqli_thread_safe</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>mysqli_result</span> <span class='methodname'><a href='http://www.php.net/manual/en/mysqli.use-result.php' class='function'>mysqli::use_result</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/mysqli.warning-count.php' class='function'>mysqli_warning_count</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.mysqli.php' class='type mysqli'>mysqli</a></span> <tt class='parameter'>$link</tt></span> )</div> }</div> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/mysqli.affected-rows.php'>mysqli->affected_rows</a> &amp;acirc;&amp;#128;&amp;#148; Gets the number of affected rows in a previous MySQL operation</li><li><a href='http://www.php.net/manual/en/mysqli.autocommit.php'>mysqli::autocommit</a> &amp;acirc;&amp;#128;&amp;#148; Turns on or off auto-commiting database modifications</li><li><a href='http://www.php.net/manual/en/mysqli.change-user.php'>mysqli::change_user</a> &amp;acirc;&amp;#128;&amp;#148; Changes the user of the specified database connection</li><li><a href='http://www.php.net/manual/en/mysqli.character-set-name.php'>mysqli::character_set_name</a> &amp;acirc;&amp;#128;&amp;#148; Returns the default character set for the database connection</li><li><a href='http://www.php.net/manual/en/mysqli.close.php'>mysqli::close</a> &amp;acirc;&amp;#128;&amp;#148; Closes a previously opened database connection</li><li><a href='http://www.php.net/manual/en/mysqli.commit.php'>mysqli::commit</a> &amp;acirc;&amp;#128;&amp;#148; Commits the current transaction</li><li><a href='http://www.php.net/manual/en/mysqli.connect-errno.php'>mysqli->connect_errno</a> &amp;acirc;&amp;#128;&amp;#148; Returns the error code from last connect call</li><li><a href='http://www.php.net/manual/en/mysqli.connect-error.php'>mysqli->connect_error</a> &amp;acirc;&amp;#128;&amp;#148; Returns a string description of the last connect error</li><li><a href='http://www.php.net/manual/en/mysqli.connect.php'>mysqli::__construct</a> &amp;acirc;&amp;#128;&amp;#148; Open a new connection to the MySQL server</li><li><a href='http://www.php.net/manual/en/mysqli.debug.php'>mysqli::debug</a> &amp;acirc;&amp;#128;&amp;#148; Performs debugging operations</li><li><a href='http://www.php.net/manual/en/mysqli.dump-debug-info.php'>mysqli::dump_debug_info</a> &amp;acirc;&amp;#128;&amp;#148; Dump debugging information into the log</li><li><a href='http://www.php.net/manual/en/mysqli.errno.php'>mysqli->errno</a> &amp;acirc;&amp;#128;&amp;#148; Returns the error code for the most recent function call</li><li><a href='http://www.php.net/manual/en/mysqli.error.php'>mysqli->error</a> &amp;acirc;&amp;#128;&amp;#148; Returns a string description of the last error</li><li><a href='http://www.php.net/manual/en/mysqli.field-count.php'>mysqli->field_count</a> &amp;acirc;&amp;#128;&amp;#148; Returns the number of columns for the most recent query</li><li><a href='http://www.php.net/manual/en/mysqli.get-cache-stats.php'>mysqli::get_cache_stats</a> &amp;acirc;&amp;#128;&amp;#148; Returns client Zval cache statistics</li><li><a href='http://www.php.net/manual/en/mysqli.get-charset.php'>mysqli::get_charset</a> &amp;acirc;&amp;#128;&amp;#148; Returns a character set object</li><li><a href='http://www.php.net/manual/en/mysqli.get-client-info.php'>mysqli::get_client_info</a> &amp;acirc;&amp;#128;&amp;#148; Returns the MySQL client version as a string</li><li><a href='http://www.php.net/manual/en/mysqli.get-client-stats.php'>mysqli::get_client_stats</a> &amp;acirc;&amp;#128;&amp;#148; Returns client per-process statistics</li><li><a href='http://www.php.net/manual/en/mysqli.get-client-version.php'>mysqli::get_client_version</a> &amp;acirc;&amp;#128;&amp;#148; Get MySQL client info</li><li><a href='http://www.php.net/manual/en/mysqli.get-connection-stats.php'>mysqli::get_connection_stats</a> &amp;acirc;&amp;#128;&amp;#148; Returns statistics about the client connection</li><li><a href='http://www.php.net/manual/en/mysqli.get-host-info.php'>mysqli->host_info</a> &amp;acirc;&amp;#128;&amp;#148; Returns a string representing the type of connection used</li><li><a href='http://www.php.net/manual/en/mysqli.get-proto-info.php'>mysqli->protocol_version</a> &amp;acirc;&amp;#128;&amp;#148; Returns the version of the MySQL protocol used</li><li><a href='http://www.php.net/manual/en/mysqli.get-server-info.php'>mysqli->server_info</a> &amp;acirc;&amp;#128;&amp;#148; Returns the version of the MySQL server</li><li><a href='http://www.php.net/manual/en/mysqli.get-server-version.php'>mysqli->server_version</a> &amp;acirc;&amp;#128;&amp;#148; Returns the version of the MySQL server as an integer</li><li><a href='http://www.php.net/manual/en/mysqli.get-warnings.php'>mysqli::get_warnings</a> &amp;acirc;&amp;#128;&amp;#148; Get result of SHOW WARNINGS</li><li><a href='http://www.php.net/manual/en/mysqli.info.php'>mysqli->info</a> &amp;acirc;&amp;#128;&amp;#148; Retrieves information about the most recently executed query</li><li><a href='http://www.php.net/manual/en/mysqli.init.php'>mysqli::init</a> &amp;acirc;&amp;#128;&amp;#148; Initializes MySQLi and returns a resource for use with mysqli_real_connect()</li><li><a href='http://www.php.net/manual/en/mysqli.insert-id.php'>mysqli->insert_id</a> &amp;acirc;&amp;#128;&amp;#148; Returns the auto generated id used in the last query</li><li><a href='http://www.php.net/manual/en/mysqli.kill.php'>mysqli::kill</a> &amp;acirc;&amp;#128;&amp;#148; Asks the server to kill a MySQL thread</li><li><a href='http://www.php.net/manual/en/mysqli.more-results.php'>mysqli::more_results</a> &amp;acirc;&amp;#128;&amp;#148; Check if there are any more query results from a multi query</li><li><a href='http://www.php.net/manual/en/mysqli.multi-query.php'>mysqli::multi_query</a> &amp;acirc;&amp;#128;&amp;#148; Performs a query on the database</li><li><a href='http://www.php.net/manual/en/mysqli.next-result.php'>mysqli::next_result</a> &amp;acirc;&amp;#128;&amp;#148; Prepare next result from multi_query</li><li><a href='http://www.php.net/manual/en/mysqli.options.php'>mysqli::options</a> &amp;acirc;&amp;#128;&amp;#148; Set options</li><li><a href='http://www.php.net/manual/en/mysqli.ping.php'>mysqli::ping</a> &amp;acirc;&amp;#128;&amp;#148; Pings a server connection, or tries to reconnect if the connection has gone down</li><li><a href='http://www.php.net/manual/en/mysqli.poll.php'>mysqli::poll</a> &amp;acirc;&amp;#128;&amp;#148; Poll connections</li><li><a href='http://www.php.net/manual/en/mysqli.prepare.php'>mysqli::prepare</a> &amp;acirc;&amp;#128;&amp;#148; Prepare a SQL statement for execution</li><li><a href='http://www.php.net/manual/en/mysqli.query.php'>mysqli::query</a> &amp;acirc;&amp;#128;&amp;#148; Performs a query on the database</li><li><a href='http://www.php.net/manual/en/mysqli.real-connect.php'>mysqli::real_connect</a> &amp;acirc;&amp;#128;&amp;#148; Opens a connection to a mysql server</li><li><a href='http://www.php.net/manual/en/mysqli.real-escape-string.php'>mysqli::real_escape_string</a> &amp;acirc;&amp;#128;&amp;#148; Escapes special characters in a string for use in a SQL statement, taking into account the current charset of the connection</li><li><a href='http://www.php.net/manual/en/mysqli.real-query.php'>mysqli::real_query</a> &amp;acirc;&amp;#128;&amp;#148; Execute an SQL query</li><li><a href='http://www.php.net/manual/en/mysqli.reap-async-query.php'>mysqli::reap_async_query</a> &amp;acirc;&amp;#128;&amp;#148; Get result from async query</li><li><a href='http://www.php.net/manual/en/mysqli.rollback.php'>mysqli::rollback</a> &amp;acirc;&amp;#128;&amp;#148; Rolls back current transaction</li><li><a href='http://www.php.net/manual/en/mysqli.select-db.php'>mysqli::select_db</a> &amp;acirc;&amp;#128;&amp;#148; Selects the default database for database queries</li><li><a href='http://www.php.net/manual/en/mysqli.set-charset.php'>mysqli::set_charset</a> &amp;acirc;&amp;#128;&amp;#148; Sets the default client character set</li><li><a href='http://www.php.net/manual/en/mysqli.set-local-infile-default.php'>mysqli::set_local_infile_default</a> &amp;acirc;&amp;#128;&amp;#148; Unsets user defined handler for load local infile command</li><li><a href='http://www.php.net/manual/en/mysqli.set-local-infile-handler.php'>mysqli::set_local_infile_handler</a> &amp;acirc;&amp;#128;&amp;#148; Set callback function for LOAD DATA LOCAL INFILE command</li><li><a href='http://www.php.net/manual/en/mysqli.sqlstate.php'>mysqli->sqlstate</a> &amp;acirc;&amp;#128;&amp;#148; Returns the SQLSTATE error from previous MySQL operation</li><li><a href='http://www.php.net/manual/en/mysqli.ssl-set.php'>mysqli::ssl_set</a> &amp;acirc;&amp;#128;&amp;#148; Used for establishing secure connections using SSL</li><li><a href='http://www.php.net/manual/en/mysqli.stat.php'>mysqli::stat</a> &amp;acirc;&amp;#128;&amp;#148; Gets the current system status</li><li><a href='http://www.php.net/manual/en/mysqli.stmt-init.php'>mysqli::stmt_init</a> &amp;acirc;&amp;#128;&amp;#148; Initializes a statement and returns an object for use with mysqli_stmt_prepare</li><li><a href='http://www.php.net/manual/en/mysqli.store-result.php'>mysqli::store_result</a> &amp;acirc;&amp;#128;&amp;#148; Transfers a result set from the last query</li><li><a href='http://www.php.net/manual/en/mysqli.thread-id.php'>mysqli::thread_id</a> &amp;acirc;&amp;#128;&amp;#148; Returns the thread ID for the current connection</li><li><a href='http://www.php.net/manual/en/mysqli.thread-safe.php'>mysqli::thread_safe</a> &amp;acirc;&amp;#128;&amp;#148; Returns whether thread safety is given or not</li><li><a href='http://www.php.net/manual/en/mysqli.use-result.php'>mysqli::use_result</a> &amp;acirc;&amp;#128;&amp;#148; Initiate a result set retrieval</li><li><a href='http://www.php.net/manual/en/mysqli.warning-count.php'>mysqli::warning_count</a> &amp;acirc;&amp;#128;&amp;#148; Returns the number of warnings from the last query for the given link</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="mt_srand" value="<div id='function.mt-srand' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mt-srand.php'>mt_srand</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mt_srand</span> &amp;mdash; <span class='dc-title'>Seed the better random number generator</span></p> </div> <a name='function.mt-srand.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>mt_srand</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$seed</tt></span> ] )</div> <p class='para rdfs-comment'> Seeds the random number generator with <i><tt class='parameter'>seed</tt></i> or with a random value if no <i><tt class='parameter'>seed</tt></i> is given. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>As of PHP 4.2.0, there is no need to seed the random number generator with <a href='http://www.php.net/manual/en/function.srand.php' class='function'>srand()</a> or <b>mt_srand()</b> as this is now done automatically. </span></p></blockquote> </div> <a name='function.mt-srand.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'>seed</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional seed value </p> </dd> </dl> <p> </p> </div> <a name='function.mt-srand.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.mt-srand.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.2.0</td> <td align='left'> The <i><tt class='parameter'>seed</tt></i> becomes optional and defaults to a random value if omitted. </td> </tr> <tr valign='middle'> <td align='left'>Since 5.2.1</td> <td align='left'> The Mersenne Twister implementation in PHP now uses a new seeding algorithm by Richard Wagner. Identical seeds no longer produce the same sequence of values they did in previous versions. This behavior is not expected to change again, but it is considered unsafe to rely upon it nonetheless. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mt-srand.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mt_srand()</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;seed&amp;nbsp;with&amp;nbsp;microseconds<br /></span><span style='color: #007700'>function&amp;nbsp;</span><span style='color: #0000BB'>make_seed</span><span style='color: #007700'>()<br />{<br />&amp;nbsp;&amp;nbsp;list(</span><span style='color: #0000BB'>$usec</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sec</span><span style='color: #007700'>)&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>explode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>microtime</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;return&amp;nbsp;(float)&amp;nbsp;</span><span style='color: #0000BB'>$sec&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;((float)&amp;nbsp;</span><span style='color: #0000BB'>$usec&amp;nbsp;</span><span style='color: #007700'>*&amp;nbsp;</span><span style='color: #0000BB'>100000</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>mt_srand</span><span style='color: #007700'>(</span><span style='color: #0000BB'>make_seed</span><span style='color: #007700'>());<br /></span><span style='color: #0000BB'>$randval&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mt_rand</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.mt-srand.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.mt-rand.php' class='function' rel='rdfs-seeAlso'>mt_rand()</a> - Generate a better random value</li> <li class='member'><a href='http://www.php.net/manual/en/function.mt-getrandmax.php' class='function' rel='rdfs-seeAlso'>mt_getrandmax()</a> - Show largest possible random value</li> <li class='member'><a href='http://www.php.net/manual/en/function.srand.php' class='function' rel='rdfs-seeAlso'>srand()</a> - Seed the random number generator</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="mt_rand" value="<div id='function.mt-rand' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mt-rand.php'>mt_rand</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mt_rand</span> &amp;mdash; <span class='dc-title'>Generate a better random value</span></p> </div> <a name='function.mt-rand.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>mt_rand</b></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>mt_rand</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$min</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$max</tt></span> )</div> <p class='simpara'> Many random number generators of older libcs have dubious or unknown characteristics and are slow. By default, PHP uses the libc random number generator with the <a href='http://www.php.net/manual/en/function.rand.php' class='function'>rand()</a> function. The <b>mt_rand()</b> function is a drop-in replacement for this. It uses a random number generator with known characteristics using the <a href='http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html' class='link external'>&amp;raquo; Mersenne Twister</a>, which will produce random numbers four times faster than what the average libc rand() provides. </p> <p class='simpara'> If called without the optional <i><tt class='parameter'>min</tt></i> , <i><tt class='parameter'>max</tt></i> arguments <b>mt_rand()</b> returns a pseudo-random value between 0 and <a href='http://www.php.net/manual/en/function.mt-getrandmax.php' class='function'>mt_getrandmax()</a>. If you want a random number between 5 and 15 (inclusive), for example, use <i>mt_rand(5, 15)</i>. </p> </div> <a name='function.mt-rand.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'>min</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Optional lowest value to be returned (default: 0) </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>max</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Optional highest value to be returned (default: <a href='http://www.php.net/manual/en/function.mt-getrandmax.php' class='function'>mt_getrandmax()</a>) </p> </dd> </dl> <p> </p> </div> <a name='function.mt-rand.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A random integer value between <i><tt class='parameter'>min</tt></i> (or 0) and <i><tt class='parameter'>max</tt></i> (or <a href='http://www.php.net/manual/en/function.mt-getrandmax.php' class='function'>mt_getrandmax()</a>, inclusive) </p> </div> <a name='function.mt-rand.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'>The random number generator is seeded automatically.</td></tr> </tbody> </table> <p> </p> </div> <a name='function.mt-rand.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mt_rand()</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'>mt_rand</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'>mt_rand</span><span style='color: #007700'>()&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>mt_rand</span><span style='color: #007700'>(</span><span style='color: #0000BB'>5</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>15</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> 1604716014 1478613278 6 </pre></div> </div> </div><p> </p> </div> <a name='function.mt-rand.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.mt-srand.php' class='function' rel='rdfs-seeAlso'>mt_srand()</a> - Seed the better random number generator</li> <li class='member'><a href='http://www.php.net/manual/en/function.mt-getrandmax.php' class='function' rel='rdfs-seeAlso'>mt_getrandmax()</a> - Show largest possible random value</li> <li class='member'><a href='http://www.php.net/manual/en/function.rand.php' class='function' rel='rdfs-seeAlso'>rand()</a> - Generate a random integer</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="mt_getrandmax" value="<div id='function.mt-getrandmax' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mt-getrandmax.php'>mt_getrandmax</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mt_getrandmax</span> &amp;mdash; <span class='dc-title'>Show largest possible random value</span></p> </div> <a name='function.mt-getrandmax.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>mt_getrandmax</b></span> ( <span class='methodparam'>void</span> )</div> <p class='simpara'> Returns the maximum value that can be returned by a call to <a href='http://www.php.net/manual/en/function.mt-rand.php' class='function'>mt_rand()</a>. </p> </div> <a name='function.mt-getrandmax.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the maximum random value returned by <a href='http://www.php.net/manual/en/function.mt-rand.php' class='function'>mt_rand()</a> </p> </div> <a name='function.mt-getrandmax.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.mt-rand.php' class='function' rel='rdfs-seeAlso'>mt_rand()</a> - Generate a better random value</li> <li class='member'><a href='http://www.php.net/manual/en/function.mt-srand.php' class='function' rel='rdfs-seeAlso'>mt_srand()</a> - Seed the better random number generator</li> <li class='member'><a href='http://www.php.net/manual/en/function.getrandmax.php' class='function' rel='rdfs-seeAlso'>getrandmax()</a> - Show largest possible random value</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="move_uploaded_file" value="<div id='function.move-uploaded-file' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.move-uploaded-file.php'>move_uploaded_file</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.3, PHP 5)</p><p class='refpurpose'><span class='refname'>move_uploaded_file</span> &amp;mdash; <span class='dc-title'>Moves an uploaded file to a new location</span></p> </div> <a name='function.move-uploaded-file.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>move_uploaded_file</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'>$destination</tt></span> )</div> <p class='para rdfs-comment'> This function checks to ensure that the file designated by <i><tt class='parameter'>filename</tt></i> is a valid upload file (meaning that it was uploaded via PHP&amp;#039;s HTTP POST upload mechanism). If the file is valid, it will be moved to the filename given by <i><tt class='parameter'>destination</tt></i> . </p> <p class='para'> This sort of check is especially important if there is any chance that anything done with uploaded files could reveal their contents to the user, or even to other users on the same system. </p> </div> <a name='function.move-uploaded-file.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 filename of the uploaded file. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>destination</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The destination of the moved file. </p> </dd> </dl> <p> </p> </div> <a name='function.move-uploaded-file.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If <i><tt class='parameter'>filename</tt></i> is not a valid upload file, then no action will occur, and <b>move_uploaded_file()</b> will return <b><tt class='constant'>FALSE</tt></b>. </p> <p class='para'> If <i><tt class='parameter'>filename</tt></i> is a valid upload file, but cannot be moved for some reason, no action will occur, and <b>move_uploaded_file()</b> will return <b><tt class='constant'>FALSE</tt></b>. Additionally, a warning will be issued. </p> </div> <a name='function.move-uploaded-file.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Uploading multiple files</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$uploads_dir&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'/uploads'</span><span style='color: #007700'>;<br />foreach&amp;nbsp;(</span><span style='color: #0000BB'>$_FILES</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'pictures'</span><span style='color: #007700'>][</span><span style='color: #DD0000'>'error'</span><span style='color: #007700'>]&amp;nbsp;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'>$error</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$error&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>UPLOAD_ERR_OK</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$tmp_name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$_FILES</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'pictures'</span><span style='color: #007700'>][</span><span style='color: #DD0000'>'tmp_name'</span><span style='color: #007700'>][</span><span style='color: #0000BB'>$key</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'>$name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$_FILES</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'pictures'</span><span style='color: #007700'>][</span><span style='color: #DD0000'>'name'</span><span style='color: #007700'>][</span><span style='color: #0000BB'>$key</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'>move_uploaded_file</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tmp_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$uploads_dir</span><span style='color: #DD0000'>/</span><span style='color: #0000BB'>$name</span><span style='color: #DD0000'>'</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><p> </p> </div> <a name='function.move-uploaded-file.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>move_uploaded_file()</b> is both <a href='http://www.php.net/manual/en/ini.sect.safe-mode.php#ini.safe-mode' class='link'>safe mode</a> and <a href='http://www.php.net/manual/en/ini.sect.safe-mode.php#ini.open-basedir' class='link'>open_basedir</a> aware. However, restrictions are placed only on the <i><tt class='parameter'>destination</tt></i> path as to allow the moving of uploaded files in which <i><tt class='parameter'>filename</tt></i> may conflict with such restrictions. <b>move_uploaded_file()</b> ensures the safety of this operation by allowing only those files uploaded through PHP to be moved. <br /> </p></blockquote> <div class='warning'><b class='warning'>Warning</b> <p class='para'> If the destination file already exists, it will be overwritten. </p> </div> </div> <a name='function.move-uploaded-file.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.is-uploaded-file.php' class='function' rel='rdfs-seeAlso'>is_uploaded_file()</a> - Tells whether the file was uploaded via HTTP POST</li> <li class='member'>See <a href='http://www.php.net/manual/en/features.file-upload.php' class='link'>Handling file uploads</a> for a simple usage example</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="mktime" value="<div id='function.mktime' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mktime.php'>mktime</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mktime</span> &amp;mdash; <span class='dc-title'>Get Unix timestamp for a date</span></p> </div> <a name='function.mktime.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>mktime</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$hour</tt><span class='initializer'> = date(&amp;quot;H&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$minute</tt><span class='initializer'> = date(&amp;quot;i&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$second</tt><span class='initializer'> = date(&amp;quot;s&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$month</tt><span class='initializer'> = date(&amp;quot;n&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$day</tt><span class='initializer'> = date(&amp;quot;j&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$year</tt><span class='initializer'> = date(&amp;quot;Y&amp;quot;)</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$is_dst</tt><span class='initializer'> = -1</span></span> ]]]]]]] )</div> <p class='para rdfs-comment'> Returns the Unix timestamp corresponding to the arguments given. This timestamp is a long integer containing the number of seconds between the Unix Epoch (January 1 1970 00:00:00 GMT) and the time specified. </p> <p class='para'> Arguments may be left out in order from right to left; any arguments thus omitted will be set to the current value according to the local date and time. </p> </div> <a name='function.mktime.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: As of PHP 5.1, when called with no arguments, <b>mktime()</b> throws an <b><tt class='constant'>E_STRICT</tt></b> notice: use the <a href='http://www.php.net/manual/en/function.time.php' class='function'>time()</a> function instead. <br /> </p></blockquote> </div> <a name='function.mktime.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'>hour</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of the hour. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>minute</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of the minute. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>second</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of seconds past the minute. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>month</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of the month. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>day</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of the day. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>year</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of the year, may be a two or four digit value, with values between 0-69 mapping to 2000-2069 and 70-100 to 1970-2000. On systems where time_t is a 32bit signed integer, as most common today, the valid range for <i><tt class='parameter'>year</tt></i> is somewhere between 1901 and 2038. However, before PHP 5.1.0 this range was limited from 1970 to 2038 on some systems (e.g. Windows). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>is_dst</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This parameter can be set to 1 if the time is during daylight savings time (DST), 0 if it is not, or -1 (the default) if it is unknown whether the time is within daylight savings time or not. If it&amp;#039;s unknown, PHP tries to figure it out itself. This can cause unexpected (but not incorrect) results. Some times are invalid if DST is enabled on the system PHP is running on or <i><tt class='parameter'>is_dst</tt></i> is set to 1. If DST is enabled in e.g. 2:00, all times between 2:00 and 3:00 are invalid and <b>mktime()</b> returns an undefined (usually negative) value. Some systems (e.g. Solaris 8) enable DST at midnight so time 0:30 of the day when DST is enabled is evaluated as 23:30 of the previous day. </p> <blockquote><p><b class='note'>Note</b>: As of PHP 5.1.0, this parameter became deprecated. As a result, the new timezone handling features should be used instead. <br /> </p></blockquote> </dd> </dl> <p> </p> </div> <a name='function.mktime.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>mktime()</b> returns the Unix timestamp of the arguments given. If the arguments are invalid, the function returns <b><tt class='constant'>FALSE</tt></b> (before PHP 5.1 it returned <i>-1</i>). </p> </div> <a name='function.mktime.errors'></a><div class='refsect1 errors'> <h3 class='title'>Errors/Exceptions</h3> <p class='para'> Every call to a date/time function will generate a <b><tt class='constant'>E_NOTICE</tt></b> if the time zone is not valid, and/or a <b><tt class='constant'>E_STRICT</tt></b> or <b><tt class='constant'>E_WARNING</tt></b> message if using the system settings or the <var class='varname'>TZ</var> environment variable. See also <a href='http://www.php.net/manual/en/function.date-default-timezone-set.php' class='function'>date_default_timezone_set()</a></p> </div> <a name='function.mktime.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.3.0</td> <td align='left'> <b>mktime()</b> now throws <b><tt class='constant'>E_DEPRECATED</tt></b> notice if the <i><tt class='parameter'>is_dst</tt></i> parameter is used. </td> </tr> <tr valign='middle'> <td align='left'>5.1.0</td> <td align='left'> The <i><tt class='parameter'>is_dst</tt></i> parameter became deprecated. Made the function return <b><tt class='constant'>FALSE</tt></b> on error, instead of <i>-1</i>. Fixed the function to accept the year, month and day to be all passed as zero. </td> </tr> <tr valign='middle'> <td align='left'>5.1.0</td> <td align='left'> When called with no arguments, <b>mktime()</b> throws <b><tt class='constant'>E_STRICT</tt></b> notice. Use the <a href='http://www.php.net/manual/en/function.time.php' class='function'>time()</a> function instead. </td> </tr> <tr valign='middle'><td align='left'>5.1.0</td><td align='left'><p class='para'> Now issues the <b><tt class='constant'>E_STRICT</tt></b> and <b><tt class='constant'>E_NOTICE</tt></b> time zone errors.</p></td></tr> </tbody> </table> <p> </p> </div> <a name='function.mktime.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mktime()</b> basic 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;default&amp;nbsp;timezone&amp;nbsp;to&amp;nbsp;use.&amp;nbsp;Available&amp;nbsp;as&amp;nbsp;of&amp;nbsp;PHP&amp;nbsp;5.1<br /></span><span style='color: #0000BB'>date_default_timezone_set</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'UTC'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Prints:&amp;nbsp;July&amp;nbsp;1,&amp;nbsp;2000&amp;nbsp;is&amp;nbsp;on&amp;nbsp;a&amp;nbsp;Saturday<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'July&amp;nbsp;1,&amp;nbsp;2000&amp;nbsp;is&amp;nbsp;on&amp;nbsp;a&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'>'l'</span><span style='color: #007700'>,&amp;nbsp;</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'>7</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'>2000</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Prints&amp;nbsp;something&amp;nbsp;like:&amp;nbsp;2006-04-05T01:02:03+00:00<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'>'c'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>mktime</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1</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'>3</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</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'>2006</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>mktime()</b> example</b></p> <div class='example-contents para'><p> <b>mktime()</b> is useful for doing date arithmetic and validation, as it will automatically calculate the correct value for out-of-range input. For example, each of the following lines produces the string &amp;quot;Jan-01-1998&amp;quot;. </p></div> <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'>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'>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'>12</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>32</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1997</span><span style='color: #007700'>));<br />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'>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'>13</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'>1997</span><span style='color: #007700'>));<br />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'>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'>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'>1998</span><span style='color: #007700'>));<br />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'>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'>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'>98</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 #3 Last day of next month</b></p> <div class='example-contents para'><p> The last day of any given month can be expressed as the &amp;quot;0&amp;quot; day of the next month, not the -1 day. Both of the following examples will produce the string &amp;quot;The last day in Feb 2000 is: 29&amp;quot;. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$lastday&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</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'>3</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'>2000</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>strftime</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Last&amp;nbsp;day&amp;nbsp;in&amp;nbsp;Feb&amp;nbsp;2000&amp;nbsp;is:&amp;nbsp;%d'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$lastday</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$lastday&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</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'>4</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>31</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2000</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>strftime</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Last&amp;nbsp;day&amp;nbsp;in&amp;nbsp;Feb&amp;nbsp;2000&amp;nbsp;is:&amp;nbsp;%d'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$lastday</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.mktime.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='caution'><b class='caution'>Caution</b> <p class='para'> Before PHP 5.1.0, negative timestamps were not supported under any known version of Windows and some other systems as well. Therefore the range of valid years was limited to 1970 through 2038. </p> </div> </div> <a name='function.mktime.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.gmmktime.php' class='function' rel='rdfs-seeAlso'>gmmktime()</a> - Get Unix timestamp for a GMT date</li> <li class='member'><a href='http://www.php.net/manual/en/function.date.php' class='function' rel='rdfs-seeAlso'>date()</a> - Format a local time/date</li> <li class='member'><a href='http://www.php.net/manual/en/function.time.php' class='function' rel='rdfs-seeAlso'>time()</a> - Return current 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="mkdir" value="<div id='function.mkdir' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mkdir.php'>mkdir</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mkdir</span> &amp;mdash; <span class='dc-title'>Makes directory</span></p> </div> <a name='function.mkdir.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>mkdir</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pathname</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt><span class='initializer'> = 0777</span></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$recursive</tt><span class='initializer'> = false</span></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$context</tt></span> ]]] )</div> <p class='para rdfs-comment'> Attempts to create the directory specified by pathname. </p> </div> <a name='function.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'>pathname</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'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mode is 0777 by default, which means the widest possible access. For more information on modes, read the details on the <a href='http://www.php.net/manual/en/function.chmod.php' class='function'>chmod()</a> page. </p> <blockquote><p><b class='note'>Note</b>: <i><tt class='parameter'>mode</tt></i> is ignored on Windows. <br /> </p></blockquote> <p class='para'> Note that you probably want to specify the mode as an octal number, which means it should have a leading zero. The mode is also modified by the current umask, which you can change using <a href='http://www.php.net/manual/en/function.umask.php' class='function'>umask()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>recursive</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Default to <b><tt class='constant'>FALSE</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>context</tt></i> </span> </dt><dd class='listitem'> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Context support was added with PHP 5.0.0. For a description of <i>contexts</i>, refer to <a href='http://www.php.net/manual/en/ref.stream.php' class='xref'>Stream Functions</a>.</span></p></blockquote> </dd> </dl> <p> </p> </div> <a name='function.mkdir.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.mkdir.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'>recursive</tt></i> parameter was added </td> </tr> <tr valign='middle'> <td align='left'>5.0.0</td> <td align='left'> As of PHP 5.0.0 <b>mkdir()</b> can also be used with <em class='emphasis'>some</em> URL wrappers. Refer to <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for a listing of which wrappers support <b>mkdir()</b> </td> </tr> <tr valign='middle'> <td align='left'>4.2.0</td> <td align='left'> The <i><tt class='parameter'>mode</tt></i> parameter became optional. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mkdir.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>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 />mkdir</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'/path/to/my/dir'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0700</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.mkdir.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>When <a href='http://www.php.net/manual/en/features.safe-mode.php' class='link'>safe mode</a> is enabled, PHP checks whether the directory in which the script is operating has the same UID (owner) as the script that is being executed.</span></p></blockquote> </div> <a name='function.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.rmdir.php' class='function' rel='rdfs-seeAlso'>rmdir()</a> - Removes 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="min" value="<div id='function.min' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.min.php'>min</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>min</span> &amp;mdash; <span class='dc-title'>Find lowest value</span></p> </div> <a name='function.min.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>min</b></span> ( <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$values</tt></span> )</div> <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>min</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'>$value1</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'>$value2</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'>$value3...</tt></span> ] )</div> <p class='para rdfs-comment'> If the first and only parameter is an array, <b>min()</b> returns the lowest value in that array. If at least two parameters are provided, <b>min()</b> returns the smallest of these values. </p> <blockquote><p><b class='note'>Note</b>: PHP will evaluate a non-numeric <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> as <i>0</i> if compared to <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a>, but still return the string if it&amp;#039;s seen as the numerically lowest value. If multiple arguments evaluate to <i>0</i>, <b>min()</b> will return the lowest alphanumerical string value if any strings are given, else a numeric <i>0</i> is returned. <br /> </p></blockquote> </div> <a name='function.min.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'>values</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array containing the values. </p> </dd> </dl> <p> </p> </div> <a name='function.min.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>min()</b> returns the numerically lowest of the parameter values. </p> </div> <a name='function.min.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Example uses of <b>min()</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: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>min</span><span style='color: #007700'>(</span><span style='color: #0000BB'>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: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>6</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>7</span><span style='color: #007700'>);&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'>min</span><span style='color: #007700'>(array(</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</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;2<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>min</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'hello'</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;0<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>min</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'hello'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;hello<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>min</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'hello'</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;-1<br /><br />//&amp;nbsp;With&amp;nbsp;multiple&amp;nbsp;arrays,&amp;nbsp;min&amp;nbsp;compares&amp;nbsp;from&amp;nbsp;left&amp;nbsp;to&amp;nbsp;right<br />//&amp;nbsp;so&amp;nbsp;in&amp;nbsp;our&amp;nbsp;example:&amp;nbsp;2&amp;nbsp;==&amp;nbsp;2,&amp;nbsp;but&amp;nbsp;4&amp;nbsp;&amp;lt;&amp;nbsp;5<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>min</span><span style='color: #007700'>(array(</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>8</span><span style='color: #007700'>),&amp;nbsp;array(</span><span style='color: #0000BB'>2</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'>1</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;array(2,&amp;nbsp;4,&amp;nbsp;8)<br /><br />//&amp;nbsp;If&amp;nbsp;both&amp;nbsp;an&amp;nbsp;array&amp;nbsp;and&amp;nbsp;non-array&amp;nbsp;are&amp;nbsp;given,&amp;nbsp;the&amp;nbsp;array<br />//&amp;nbsp;is&amp;nbsp;never&amp;nbsp;returned&amp;nbsp;as&amp;nbsp;it's&amp;nbsp;considered&amp;nbsp;the&amp;nbsp;largest<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>min</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'string'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #0000BB'>2</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'>7</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>42</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;string<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.min.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.max.php' class='function' rel='rdfs-seeAlso'>max()</a> - Find highest value</li> <li class='member'><a href='http://www.php.net/manual/en/function.count.php' class='function' rel='rdfs-seeAlso'>count()</a> - Count all elements in an array, or properties in an object</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="microtime" value="<div id='function.microtime' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.microtime.php'>microtime</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>microtime</span> &amp;mdash; <span class='dc-title'>Return current Unix timestamp with microseconds</span></p> </div> <a name='function.microtime.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>microtime</b></span> ([ <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$get_as_float</tt></span> ] )</div> <p class='para rdfs-comment'> <b>microtime()</b> returns the current Unix timestamp with microseconds. This function is only available on operating systems that support the gettimeofday() system call. </p> </div> <a name='function.microtime.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'>get_as_float</tt></i> </span> </dt><dd class='listitem'> <p class='para'> When called without the optional argument, this function returns the string &amp;quot;msec sec&amp;quot; where sec is the current time measured in the number of seconds since the Unix Epoch (0:00:00 January 1, 1970 GMT), and msec is the microseconds part. Both portions of the string are returned in units of seconds. </p> <p class='para'> If the optional <i><tt class='parameter'>get_as_float</tt></i> is set to <b><tt class='constant'>TRUE</tt></b> then a <a href='http://www.php.net/manual/en/language.types.float.php' class='type float'>float</a> (in seconds) is returned. </p> </dd> </dl> <p> </p> </div> <a name='function.microtime.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'>get_as_float</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.microtime.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Timing script execution with <b>microtime()</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'>/**<br />&amp;nbsp;*&amp;nbsp;Simple&amp;nbsp;function&amp;nbsp;to&amp;nbsp;replicate&amp;nbsp;PHP&amp;nbsp;5&amp;nbsp;behaviour<br />&amp;nbsp;*/<br /></span><span style='color: #007700'>function&amp;nbsp;</span><span style='color: #0000BB'>microtime_float</span><span style='color: #007700'>()<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;list(</span><span style='color: #0000BB'>$usec</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sec</span><span style='color: #007700'>)&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>explode</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>microtime</span><span style='color: #007700'>());<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;((float)</span><span style='color: #0000BB'>$usec&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;(float)</span><span style='color: #0000BB'>$sec</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>$time_start&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>microtime_float</span><span style='color: #007700'>();<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Sleep&amp;nbsp;for&amp;nbsp;a&amp;nbsp;while<br /></span><span style='color: #0000BB'>usleep</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$time_end&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>microtime_float</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$time&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$time_end&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;</span><span style='color: #0000BB'>$time_start</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Did&amp;nbsp;nothing&amp;nbsp;in&amp;nbsp;</span><span style='color: #0000BB'>$time</span><span style='color: #DD0000'>&amp;nbsp;seconds\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Timing script execution in PHP 5</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$time_start&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>microtime</span><span style='color: #007700'>(</span><span style='color: #0000BB'>true</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Sleep&amp;nbsp;for&amp;nbsp;a&amp;nbsp;while<br /></span><span style='color: #0000BB'>usleep</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$time_end&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>microtime</span><span style='color: #007700'>(</span><span style='color: #0000BB'>true</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$time&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$time_end&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;</span><span style='color: #0000BB'>$time_start</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Did&amp;nbsp;nothing&amp;nbsp;in&amp;nbsp;</span><span style='color: #0000BB'>$time</span><span style='color: #DD0000'>&amp;nbsp;seconds\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.microtime.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.time.php' class='function' rel='rdfs-seeAlso'>time()</a> - Return current 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="method_exists" value="<div id='function.method-exists' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.method-exists.php'>method_exists</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>method_exists</span> &amp;mdash; <span class='dc-title'>Checks if the class method exists</span></p> </div> <a name='function.method-exists.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>method_exists</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'>$object</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$method_name</tt></span> )</div> <p class='para rdfs-comment'> Checks if the class method exists in the given <i><tt class='parameter'>object</tt></i> . </p> </div> <a name='function.method-exists.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'> An object instance or a class name </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>method_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The method name </p> </dd> </dl> <p> </p> </div> <a name='function.method-exists.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 method given by <i><tt class='parameter'>method_name</tt></i> has been defined for the given <i><tt class='parameter'>object</tt></i> , <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.method-exists.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>method_exists()</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 />$directory&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>Directory</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>method_exists</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$directory</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'read'</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) </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Static <b>method_exists()</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 />var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>method_exists</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Directory'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'read'</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) </pre></div> </div> </div><p> </p> </div> <a name='function.method-exists.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.function-exists.php' class='function' rel='rdfs-seeAlso'>function_exists()</a> - Return TRUE if the given function has been defined</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-callable.php' class='function' rel='rdfs-seeAlso'>is_callable()</a> - Verify that the contents of a variable can be called as a function</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="metaphone" value="<div id='function.metaphone' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.metaphone.php'>metaphone</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>metaphone</span> &amp;mdash; <span class='dc-title'>Calculate the metaphone key of a string</span></p> </div> <a name='function.metaphone.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>metaphone</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'>$phones</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Calculates the metaphone key of <i><tt class='parameter'>str</tt></i> . </p> <p class='para'> Similar to <a href='http://www.php.net/manual/en/function.soundex.php' class='function'>soundex()</a> metaphone creates the same key for similar sounding words. It&amp;#039;s more accurate than <a href='http://www.php.net/manual/en/function.soundex.php' class='function'>soundex()</a> as it knows the basic rules of English pronunciation. The metaphone generated keys are of variable length. </p> <p class='para'> Metaphone was developed by Lawrence Philips &amp;lt;lphilips at verity dot com&amp;gt;. It is described in [&amp;quot;Practical Algorithms for Programmers&amp;quot;, Binstock &amp;amp; Rex, Addison Wesley, 1995]. </p> </div> <a name='function.metaphone.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 input string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>phones</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.metaphone.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the metaphone key 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="memory_get_usage" value="<div id='function.memory-get-usage' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memory-get-usage.php'>memory_get_usage</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.2, PHP 5)</p><p class='refpurpose'><span class='refname'>memory_get_usage</span> &amp;mdash; <span class='dc-title'>Returns the amount of memory allocated to PHP</span></p> </div> <a name='function.memory-get-usage.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>memory_get_usage</b></span> ([ <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$real_usage</tt><span class='initializer'> = false</span></span> ] )</div> <p class='para rdfs-comment'> Returns the amount of memory, in bytes, that&amp;#039;s currently being allocated to your PHP script. </p> </div> <a name='function.memory-get-usage.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'>real_usage</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Set this to <b><tt class='constant'>TRUE</tt></b> to get the real size of memory allocated from system. If not set or <b><tt class='constant'>FALSE</tt></b> only the memory used by <i>emalloc()</i> is reported. </p> </dd> </dl> <p> </p> </div> <a name='function.memory-get-usage.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the memory amount in bytes. </p> </div> <a name='function.memory-get-usage.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.1</td> <td align='left'> Compiling with <a href='http://www.php.net/manual/en/ini.core.php#ini.memory-limit' class='link'>--enable-memory-limit</a> is no longer required for this function to exist. </td> </tr> <tr valign='middle'> <td align='left'>5.2.0</td> <td align='left'> <i><tt class='parameter'>real_usage</tt></i> was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.memory-get-usage.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>memory_get_usage()</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;is&amp;nbsp;only&amp;nbsp;an&amp;nbsp;example,&amp;nbsp;the&amp;nbsp;numbers&amp;nbsp;below&amp;nbsp;will<br />//&amp;nbsp;differ&amp;nbsp;depending&amp;nbsp;on&amp;nbsp;your&amp;nbsp;system<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>memory_get_usage</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'>//&amp;nbsp;36640<br /><br /></span><span style='color: #0000BB'>$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>str_repeat</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Hello'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4242</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>memory_get_usage</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'>//&amp;nbsp;57960<br /><br /></span><span style='color: #007700'>unset(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>memory_get_usage</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'>//&amp;nbsp;36744<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.memory-get-usage.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.memory-get-peak-usage.php' class='function' rel='rdfs-seeAlso'>memory_get_peak_usage()</a> - Returns the peak of memory allocated by PHP</li> <li class='member'><a href='http://www.php.net/manual/en/ini.core.php#ini.memory-limit' class='link'>memory_limit</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="memory_get_peak_usage" value="<div id='function.memory-get-peak-usage' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.memory-get-peak-usage.php'>memory_get_peak_usage</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0)</p><p class='refpurpose'><span class='refname'>memory_get_peak_usage</span> &amp;mdash; <span class='dc-title'>Returns the peak of memory allocated by PHP</span></p> </div> <a name='function.memory-get-peak-usage.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>memory_get_peak_usage</b></span> ([ <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$real_usage</tt><span class='initializer'> = false</span></span> ] )</div> <p class='para rdfs-comment'> Returns the peak of memory, in bytes, that&amp;#039;s been allocated to your PHP script. </p> </div> <a name='function.memory-get-peak-usage.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'>real_usage</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Set this to <b><tt class='constant'>TRUE</tt></b> to get the real size of memory allocated from system. If not set or <b><tt class='constant'>FALSE</tt></b> only the memory used by <i>emalloc()</i> is reported. </p> </dd> </dl> <p> </p> </div> <a name='function.memory-get-peak-usage.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the memory peak in bytes. </p> </div> <a name='function.memory-get-peak-usage.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.1</td> <td align='left'> Compiling with <a href='http://www.php.net/manual/en/ini.core.php#ini.memory-limit' class='link'>--enable-memory-limit</a> is no longer required for this function to exist. </td> </tr> <tr valign='middle'> <td align='left'>5.2.0</td> <td align='left'> <i><tt class='parameter'>real_usage</tt></i> was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.memory-get-peak-usage.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.memory-get-usage.php' class='function' rel='rdfs-seeAlso'>memory_get_usage()</a> - Returns the amount of memory allocated to PHP</li> <li class='member'><a href='http://www.php.net/manual/en/ini.core.php#ini.memory-limit' class='link'>memory_limit</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="md5_file" value="<div id='function.md5-file' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.md5-file.php'>md5_file</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>md5_file</span> &amp;mdash; <span class='dc-title'>Calculates the md5 hash of a given file</span></p> </div> <a name='function.md5-file.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>md5_file</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$raw_output</tt><span class='initializer'> = false</span></span> ] )</div> <p class='para rdfs-comment'> Calculates the MD5 hash of the file specified by the <i><tt class='parameter'>filename</tt></i> parameter using the <a href='http://www.faqs.org/rfcs/rfc1321' class='link external'>&amp;raquo; RSA Data Security, Inc. MD5 Message-Digest Algorithm</a>, and returns that hash. The hash is a 32-character hexadecimal number. </p> </div> <a name='function.md5-file.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 filename </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>raw_output</tt></i> </span> </dt><dd class='listitem'> <p class='para'> When <b><tt class='constant'>TRUE</tt></b>, returns the digest in raw binary format with a length of 16. Defaults to <b><tt class='constant'>FALSE</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.md5-file.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string on success, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.md5-file.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'> Added the <i><tt class='parameter'>raw_output</tt></i> parameter </td> </tr> <tr valign='middle'> <td align='left'>5.1.0</td> <td align='left'> Changed the function to use the streams API. It means that you can use it with wrappers, like <i>md5_file(&amp;#039;http://example.com/..&amp;#039;)</i> </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.md5-file.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Usage example of <b>md5_file()</b></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'>'php-5.3.0alpha2-Win32-VC9-x64.zip'</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'MD5&amp;nbsp;file&amp;nbsp;hash&amp;nbsp;of&amp;nbsp;'&amp;nbsp;</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'>':&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>md5_file</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$file</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.md5-file.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.md5.php' class='function' rel='rdfs-seeAlso'>md5()</a> - Calculate the md5 hash of a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.sha1-file.php' class='function' rel='rdfs-seeAlso'>sha1_file()</a> - Calculate the sha1 hash of a file</li> <li class='member'><a href='http://www.php.net/manual/en/function.crc32.php' class='function' rel='rdfs-seeAlso'>crc32()</a> - Calculates the crc32 polynomial of 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="md5" value="<div id='function.md5' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.md5.php'>md5</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>md5</span> &amp;mdash; <span class='dc-title'>Calculate the md5 hash of a string</span></p> </div> <a name='function.md5.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>md5</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$raw_output</tt><span class='initializer'> = false</span></span> ] )</div> <p class='para rdfs-comment'> Calculates the MD5 hash of <i><tt class='parameter'>str</tt></i> using the <a href='http://www.faqs.org/rfcs/rfc1321' class='link external'>&amp;raquo; RSA Data Security, Inc. MD5 Message-Digest Algorithm</a>, and returns that hash. </p> </div> <a name='function.md5.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'>raw_output</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If the optional <i><tt class='parameter'>raw_output</tt></i> is set to <b><tt class='constant'>TRUE</tt></b>, then the md5 digest is instead returned in raw binary format with a length of 16. Defaults to <b><tt class='constant'>FALSE</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.md5.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the hash as a 32-character hexadecimal number. </p> </div> <a name='function.md5.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'>raw_output</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.md5.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>md5()</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 />$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'apple'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>md5</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>)&amp;nbsp;===&amp;nbsp;</span><span style='color: #DD0000'>'1f3870be274f6c49b3e31a0c6728957f'</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Would&amp;nbsp;you&amp;nbsp;like&amp;nbsp;a&amp;nbsp;green&amp;nbsp;or&amp;nbsp;red&amp;nbsp;apple?'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.md5.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.md5-file.php' class='function' rel='rdfs-seeAlso'>md5_file()</a> - Calculates the md5 hash of a given file</li> <li class='member'><a href='http://www.php.net/manual/en/function.sha1-file.php' class='function' rel='rdfs-seeAlso'>sha1_file()</a> - Calculate the sha1 hash of a file</li> <li class='member'><a href='http://www.php.net/manual/en/function.crc32.php' class='function' rel='rdfs-seeAlso'>crc32()</a> - Calculates the crc32 polynomial of a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.sha1.php' class='function' rel='rdfs-seeAlso'>sha1()</a> - Calculate the sha1 hash of a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.hash.php' class='function' rel='rdfs-seeAlso'>hash()</a> - Generate a hash value (message digest)</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="mb_substr_count" value="<div id='function.mb-substr-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-substr-count.php'>mb_substr_count</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_substr_count</span> &amp;mdash; <span class='dc-title'>Count the number of substring occurrences</span></p> </div> <a name='function.mb-substr-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>mb_substr_count</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'>$encoding</tt></span> ] )</div> <p class='para rdfs-comment'> Counts the number of times the <i><tt class='parameter'>needle</tt></i> substring occurs in the <i><tt class='parameter'>haystack</tt></i> <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.mb-substr-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'>haystack</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being checked. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being found. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-substr-count.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The number of times the <i><tt class='parameter'>needle</tt></i> substring occurs in the <i><tt class='parameter'>haystack</tt></i> <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.mb-substr-count.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_substr_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 /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>mb_substr_count</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'This&amp;nbsp;is&amp;nbsp;a&amp;nbsp;test'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'is'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;prints&amp;nbsp;out&amp;nbsp;2<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mb-substr-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.mb-strpos.php' class='function' rel='rdfs-seeAlso'>mb_strpos()</a> - Find position of first occurrence of string in 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.substr-count.php' class='function' rel='rdfs-seeAlso'>substr_count()</a> - Count the number of substring occurrences</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="mb_substr" value="<div id='function.mb-substr' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-substr.php'>mb_substr</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_substr</span> &amp;mdash; <span class='dc-title'>Get part of string</span></p> </div> <a name='function.mb-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>mb_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'>$start</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> Performs a multi-byte safe <a href='http://www.php.net/manual/en/function.substr.php' class='function'>substr()</a> operation based on number of characters. Position is counted from the beginning of <i><tt class='parameter'>str</tt></i> . First character&amp;#039;s position is 0. Second character position is 1, and so on. </p> </div> <a name='function.mb-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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being checked. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>start</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The first position used in <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'> The maximum length of the returned <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-substr.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>mb_substr()</b> returns the portion of <i><tt class='parameter'>str</tt></i> specified by the <i><tt class='parameter'>start</tt></i> and <i><tt class='parameter'>length</tt></i> parameters. </p> </div> <a name='function.mb-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.mb-strcut.php' class='function' rel='rdfs-seeAlso'>mb_strcut()</a> - Get part of string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</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="mb_substitute_character" value="<div id='function.mb-substitute-character' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-substitute-character.php'>mb_substitute_character</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_substitute_character</span> &amp;mdash; <span class='dc-title'>Set/Get substitution character</span></p> </div> <a name='function.mb-substitute-character.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>mb_substitute_character</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'>$substrchar</tt></span> ] )</div> <p class='para rdfs-comment'> Specifies a substitution character when input character encoding is invalid or character code does not exist in output character encoding. Invalid characters may be substituted <b><tt class='constant'>NULL</tt></b> (no output), <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> or <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> value (Unicode character code value). </p> <p class='para'> This setting affects <a href='http://www.php.net/manual/en/function.mb-convert-encoding.php' class='function'>mb_convert_encoding()</a>, <a href='http://www.php.net/manual/en/function.mb-convert-variables.php' class='function'>mb_convert_variables()</a>, <a href='http://www.php.net/manual/en/function.mb-output-handler.php' class='function'>mb_output_handler()</a>, and <a href='http://www.php.net/manual/en/function.mb-send-mail.php' class='function'>mb_send_mail()</a>. </p> </div> <a name='function.mb-substitute-character.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'>substrchar</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specify the Unicode value as an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a>, or as one of the following <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>s: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> &amp;quot;none&amp;quot; : no output </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;long&amp;quot; : Output character code value (Example: U+3000,JIS+7E7E) </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.mb-substitute-character.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If <i><tt class='parameter'>substchar</tt></i> is set, it returns <b><tt class='constant'>TRUE</tt></b> for success, otherwise returns <b><tt class='constant'>FALSE</tt></b>. If <i><tt class='parameter'>substchar</tt></i> is not set, it returns the Unicode value, or &amp;quot;<i>none</i>&amp;quot; or &amp;quot;<i>long</i>&amp;quot;. </p> </div> <a name='function.mb-substitute-character.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_substitute_character()</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;with&amp;nbsp;Unicode&amp;nbsp;U+3013&amp;nbsp;(GETA&amp;nbsp;MARK)&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mb_substitute_character</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0x3013</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Set&amp;nbsp;hex&amp;nbsp;format&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mb_substitute_character</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'long'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Display&amp;nbsp;current&amp;nbsp;setting&amp;nbsp;*/<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>mb_substitute_character</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="mb_strwidth" value="<div id='function.mb-strwidth' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strwidth.php'>mb_strwidth</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_strwidth</span> &amp;mdash; <span class='dc-title'>Return width of string</span></p> </div> <a name='function.mb-strwidth.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>mb_strwidth</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'>$encoding</tt></span> ] )</div> <p class='para rdfs-comment'> Returns the width of <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> . </p> <p class='para'> Multi-byte characters are usually twice the width of single byte characters. </p> <p class='para'> </p><table class='doctable table'> <caption><b>Characters width</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Chars</th> <th>Width</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>U+0000 - U+0019</td> <td align='left'>0</td> </tr> <tr valign='middle'> <td align='left'>U+0020 - U+1FFF</td> <td align='left'>1</td> </tr> <tr valign='middle'> <td align='left'>U+2000 - U+FF60</td> <td align='left'>2</td> </tr> <tr valign='middle'> <td align='left'>U+FF61 - U+FF9F</td> <td align='left'>1</td> </tr> <tr valign='middle'> <td align='left'>U+FFA0 - </td> <td align='left'>2</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mb-strwidth.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being decoded. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-strwidth.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The width of <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> . </p> </div> <a name='function.mb-strwidth.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.mb-strimwidth.php' class='function' rel='rdfs-seeAlso'>mb_strimwidth()</a> - Get truncated string with specified width</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</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="mb_strtoupper" value="<div id='function.mb-strtoupper' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strtoupper.php'>mb_strtoupper</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_strtoupper</span> &amp;mdash; <span class='dc-title'>Make a string uppercase</span></p> </div> <a name='function.mb-strtoupper.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>mb_strtoupper</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'>$encoding</tt><span class='initializer'> = mb_internal_encoding()</span></span> ] )</div> <p class='para rdfs-comment'> Returns <i><tt class='parameter'>str</tt></i> with all alphabetic characters converted to uppercase. </p> </div> <a name='function.mb-strtoupper.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being uppercased. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-strtoupper.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <i><tt class='parameter'>str</tt></i> with all alphabetic characters converted to uppercase. </p> </div> <a name='function.mb-strtoupper.unicode'></a><div class='refsect1 unicode'> <h3 class='title'>Unicode</h3> <p class='para'> For more information about the Unicode properties, please see <a href='http://www.unicode.org/unicode/reports/tr21/' class='link external'>&amp;raquo; http://www.unicode.org/unicode/reports/tr21/</a>. </p> <p class='para'> By contrast to <a href='http://www.php.net/manual/en/function.strtoupper.php' class='function'>strtoupper()</a>, &amp;#039;alphabetic&amp;#039; is determined by the Unicode character properties. Thus the behaviour of this function is not affected by locale settings and it can convert any characters that have &amp;#039;alphabetic&amp;#039; property, such as a-umlaut (&amp;Atilde;&amp;curren;). </p> </div> <a name='function.mb-strtoupper.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_strtoupper()</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 />$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Mary&amp;nbsp;Had&amp;nbsp;A&amp;nbsp;Little&amp;nbsp;Lamb&amp;nbsp;and&amp;nbsp;She&amp;nbsp;LOVED&amp;nbsp;It&amp;nbsp;So'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_strtoupper</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Prints&amp;nbsp;MARY&amp;nbsp;HAD&amp;nbsp;A&amp;nbsp;LITTLE&amp;nbsp;LAMB&amp;nbsp;AND&amp;nbsp;SHE&amp;nbsp;LOVED&amp;nbsp;IT&amp;nbsp;SO<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mb-strtoupper.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.mb-strtolower.php' class='function' rel='rdfs-seeAlso'>mb_strtolower()</a> - Make a string lowercase</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-convert-case.php' class='function' rel='rdfs-seeAlso'>mb_convert_case()</a> - Perform case folding on a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.strtoupper.php' class='function' rel='rdfs-seeAlso'>strtoupper()</a> - Make a string uppercase</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="mb_strtolower" value="<div id='function.mb-strtolower' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strtolower.php'>mb_strtolower</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_strtolower</span> &amp;mdash; <span class='dc-title'>Make a string lowercase</span></p> </div> <a name='function.mb-strtolower.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>mb_strtolower</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'>$encoding</tt><span class='initializer'> = mb_internal_encoding()</span></span> ] )</div> <p class='para rdfs-comment'> Returns <i><tt class='parameter'>str</tt></i> with all alphabetic characters converted to lowercase. </p> </div> <a name='function.mb-strtolower.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being lowercased. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-strtolower.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <i><tt class='parameter'>str</tt></i> with all alphabetic characters converted to lowercase. </p> </div> <a name='function.mb-strtolower.unicode'></a><div class='refsect1 unicode'> <h3 class='title'>Unicode</h3> <p class='para'> For more information about the Unicode properties, please see <a href='http://www.unicode.org/unicode/reports/tr21/' class='link external'>&amp;raquo; http://www.unicode.org/unicode/reports/tr21/</a>. </p> <p class='para'> By contrast to <a href='http://www.php.net/manual/en/function.strtolower.php' class='function'>strtolower()</a>, &amp;#039;alphabetic&amp;#039; is determined by the Unicode character properties. Thus the behaviour of this function is not affected by locale settings and it can convert any characters that have &amp;#039;alphabetic&amp;#039; property, such as A-umlaut (&amp;Atilde;&amp;#132;). </p> </div> <a name='function.mb-strtolower.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_strtolower()</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 />$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Mary&amp;nbsp;Had&amp;nbsp;A&amp;nbsp;Little&amp;nbsp;Lamb&amp;nbsp;and&amp;nbsp;She&amp;nbsp;LOVED&amp;nbsp;It&amp;nbsp;So'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_strtolower</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Prints&amp;nbsp;mary&amp;nbsp;had&amp;nbsp;a&amp;nbsp;little&amp;nbsp;lamb&amp;nbsp;and&amp;nbsp;she&amp;nbsp;loved&amp;nbsp;it&amp;nbsp;so<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mb-strtolower.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.mb-strtoupper.php' class='function' rel='rdfs-seeAlso'>mb_strtoupper()</a> - Make a string uppercase</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-convert-case.php' class='function' rel='rdfs-seeAlso'>mb_convert_case()</a> - Perform case folding on a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.strtolower.php' class='function' rel='rdfs-seeAlso'>strtolower()</a> - Make a string lowercase</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="mb_strstr" value="<div id='function.mb-strstr' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strstr.php'>mb_strstr</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0)</p><p class='refpurpose'><span class='refname'>mb_strstr</span> &amp;mdash; <span class='dc-title'>Finds first occurrence of a string within another</span></p> </div> <a name='function.mb-strstr.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>mb_strstr</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'>bool</span> <tt class='parameter'>$part</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>mb_strstr()</b> finds the first occurrence of <i><tt class='parameter'>needle</tt></i> in <i><tt class='parameter'>haystack</tt></i> and returns the portion of <i><tt class='parameter'>haystack</tt></i> . If <i><tt class='parameter'>needle</tt></i> is not found, it returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mb-strstr.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 string from which to get the first occurrence of <i><tt class='parameter'>needle</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to find in <i><tt class='parameter'>haystack</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>part</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Determines which portion of <i><tt class='parameter'>haystack</tt></i> this function returns. If set to <b><tt class='constant'>TRUE</tt></b>, it returns all of <i><tt class='parameter'>haystack</tt></i> from the beginning to the first occurrence of <i><tt class='parameter'>needle</tt></i> . If set to <b><tt class='constant'>FALSE</tt></b>, it returns all of <i><tt class='parameter'>haystack</tt></i> from the first occurrence of <i><tt class='parameter'>needle</tt></i> to the end, Default value is <b><tt class='constant'>FALSE</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Character encoding name to use. If it is omitted, internal character encoding is used. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-strstr.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the portion of <i><tt class='parameter'>haystack</tt></i> , or <b><tt class='constant'>FALSE</tt></b> if <i><tt class='parameter'>needle</tt></i> is not found. </p> </div> <a name='function.mb-strstr.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.stristr.php' class='function' rel='rdfs-seeAlso'>stristr()</a> - Case-insensitive strstr</li> <li class='member'><a href='http://www.php.net/manual/en/function.strstr.php' class='function' rel='rdfs-seeAlso'>strstr()</a> - Find first occurrence of a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-stristr.php' class='function' rel='rdfs-seeAlso'>mb_stristr()</a> - Finds first occurrence of a string within another, case insensitive</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="mb_strrpos" value="<div id='function.mb-strrpos' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strrpos.php'>mb_strrpos</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_strrpos</span> &amp;mdash; <span class='dc-title'>Find position of last occurrence of a string in a string</span></p> </div> <a name='function.mb-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>mb_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'>int</span> <tt class='parameter'>$offset</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> Performs a multibyte safe <a href='http://www.php.net/manual/en/function.strrpos.php' class='function'>strrpos()</a> operation based on the number of characters. <i><tt class='parameter'>needle</tt></i> position is counted from the beginning of <i><tt class='parameter'>haystack</tt></i> . First character&amp;#039;s position is 0. Second character position is 1. </p> </div> <a name='function.mb-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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being checked, for the last occurrence of <i><tt class='parameter'>needle</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> to find in <i><tt class='parameter'>haystack</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <span class='simpara'> May be specified to begin searching an arbitrary number of characters into the <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. Negative values will stop searching at an arbitrary point prior to the end of the <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </span> </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-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 the <i><tt class='parameter'>haystack</tt></i> <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. If <i><tt class='parameter'>needle</tt></i> is not found, it returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mb-strrpos.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'>Added the optional parameter <i><tt class='parameter'>offset</tt></i> .</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mb-strrpos.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> The <i><tt class='parameter'>encoding</tt></i> parameter was moved from the third position to the fourth in PHP 5.2.0. For backward compatibility, <i><tt class='parameter'>encoding</tt></i> can be specified as the third parameter, but doing so is deprecated and will be removed in the future. </span> </p></blockquote> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-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.mb-strpos.php' class='function' rel='rdfs-seeAlso'>mb_strpos()</a> - Find position of first occurrence of string in a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</li> <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> </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="mb_strripos" value="<div id='function.mb-strripos' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strripos.php'>mb_strripos</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0)</p><p class='refpurpose'><span class='refname'>mb_strripos</span> &amp;mdash; <span class='dc-title'>Finds position of last occurrence of a string within another, case insensitive</span></p> </div> <a name='function.mb-strripos.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>mb_strripos</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> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>mb_strripos()</b> performs multi-byte safe <a href='http://www.php.net/manual/en/function.strripos.php' class='function'>strripos()</a> operation based on number of characters. <i><tt class='parameter'>needle</tt></i> position is counted from the beginning of <i><tt class='parameter'>haystack</tt></i> . First character&amp;#039;s position is 0. Second character position is 1. Unlike <a href='http://www.php.net/manual/en/function.mb-strrpos.php' class='function'>mb_strrpos()</a>, <b>mb_strripos()</b> is case-insensitive. </p> </div> <a name='function.mb-strripos.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 string from which to get the position of the last occurrence of <i><tt class='parameter'>needle</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to find in <i><tt class='parameter'>haystack</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The position in <i><tt class='parameter'>haystack</tt></i> to start searching </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Character encoding name to use. If it is omitted, internal character encoding is used. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-strripos.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Return the numeric position of the last occurrence of <i><tt class='parameter'>needle</tt></i> in the <i><tt class='parameter'>haystack</tt></i> string, or <b><tt class='constant'>FALSE</tt></b> if <i><tt class='parameter'>needle</tt></i> is not found. </p> </div> <a name='function.mb-strripos.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.strripos.php' class='function' rel='rdfs-seeAlso'>strripos()</a> - Find position of last occurrence of a case-insensitive string in a string</li> <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.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="mb_strrichr" value="<div id='function.mb-strrichr' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strrichr.php'>mb_strrichr</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0)</p><p class='refpurpose'><span class='refname'>mb_strrichr</span> &amp;mdash; <span class='dc-title'>Finds the last occurrence of a character in a string within another, case insensitive</span></p> </div> <a name='function.mb-strrichr.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>mb_strrichr</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'>bool</span> <tt class='parameter'>$part</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>mb_strrichr()</b> finds the last occurrence of <i><tt class='parameter'>needle</tt></i> in <i><tt class='parameter'>haystack</tt></i> and returns the portion of <i><tt class='parameter'>haystack</tt></i> . Unlike <a href='http://www.php.net/manual/en/function.mb-strrchr.php' class='function'>mb_strrchr()</a>, <b>mb_strrichr()</b> is case-insensitive. If <i><tt class='parameter'>needle</tt></i> is not found, it returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mb-strrichr.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 string from which to get the last occurrence of <i><tt class='parameter'>needle</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to find in <i><tt class='parameter'>haystack</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>part</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Determines which portion of <i><tt class='parameter'>haystack</tt></i> this function returns. If set to <b><tt class='constant'>TRUE</tt></b>, it returns all of <i><tt class='parameter'>haystack</tt></i> from the beginning to the last occurrence of <i><tt class='parameter'>needle</tt></i> . If set to <b><tt class='constant'>FALSE</tt></b>, it returns all of <i><tt class='parameter'>haystack</tt></i> from the last occurrence of <i><tt class='parameter'>needle</tt></i> to the end, Default value is <b><tt class='constant'>FALSE</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Character encoding name to use. If it is omitted, internal character encoding is used. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-strrichr.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the portion of <i><tt class='parameter'>haystack</tt></i> . or <b><tt class='constant'>FALSE</tt></b> if <i><tt class='parameter'>needle</tt></i> is not found. </p> </div> <a name='function.mb-strrichr.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.mb-stristr.php' class='function' rel='rdfs-seeAlso'>mb_stristr()</a> - Finds first occurrence of a string within another, case insensitive</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-strrchr.php' class='function' rel='rdfs-seeAlso'>mb_strrchr()</a> - Finds the last occurrence of a character in a string within 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="mb_strrchr" value="<div id='function.mb-strrchr' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strrchr.php'>mb_strrchr</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0)</p><p class='refpurpose'><span class='refname'>mb_strrchr</span> &amp;mdash; <span class='dc-title'>Finds the last occurrence of a character in a string within another</span></p> </div> <a name='function.mb-strrchr.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>mb_strrchr</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'>bool</span> <tt class='parameter'>$part</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>mb_strrchr()</b> finds the last occurrence of <i><tt class='parameter'>needle</tt></i> in <i><tt class='parameter'>haystack</tt></i> and returns the portion of <i><tt class='parameter'>haystack</tt></i> . If <i><tt class='parameter'>needle</tt></i> is not found, it returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mb-strrchr.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 string from which to get the last occurrence of <i><tt class='parameter'>needle</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to find in <i><tt class='parameter'>haystack</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>part</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Determines which portion of <i><tt class='parameter'>haystack</tt></i> this function returns. If set to <b><tt class='constant'>TRUE</tt></b>, it returns all of <i><tt class='parameter'>haystack</tt></i> from the beginning to the last occurrence of <i><tt class='parameter'>needle</tt></i> . If set to <b><tt class='constant'>FALSE</tt></b>, it returns all of <i><tt class='parameter'>haystack</tt></i> from the last occurrence of <i><tt class='parameter'>needle</tt></i> to the end, Default value is <b><tt class='constant'>FALSE</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Character encoding name to use. If it is omitted, internal character encoding is used. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-strrchr.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the portion of <i><tt class='parameter'>haystack</tt></i> . or <b><tt class='constant'>FALSE</tt></b> if <i><tt class='parameter'>needle</tt></i> is not found. </p> </div> <a name='function.mb-strrchr.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.strrchr.php' class='function' rel='rdfs-seeAlso'>strrchr()</a> - Find the last occurrence of a character in a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-strstr.php' class='function' rel='rdfs-seeAlso'>mb_strstr()</a> - Finds first occurrence of a string within another</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-strrichr.php' class='function' rel='rdfs-seeAlso'>mb_strrichr()</a> - Finds the last occurrence of a character in a string within another, case insensitive</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="mb_strpos" value="<div id='function.mb-strpos' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strpos.php'>mb_strpos</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_strpos</span> &amp;mdash; <span class='dc-title'>Find position of first occurrence of string in a string</span></p> </div> <a name='function.mb-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>mb_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> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> Finds position of the first occurrence of a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> in a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> <p class='para'> Performs a multi-byte safe <a href='http://www.php.net/manual/en/function.strpos.php' class='function'>strpos()</a> operation based on number of characters. The first character&amp;#039;s position is 0, the second character position is 1, and so on. </p> </div> <a name='function.mb-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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being checked. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The position counted from the beginning of <i><tt class='parameter'>haystack</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search offset. If it is not specified, 0 is used. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-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 the <i><tt class='parameter'>haystack</tt></i> <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. If <i><tt class='parameter'>needle</tt></i> is not found, it returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mb-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.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</li> <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> </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="mb_strlen" value="<div id='function.mb-strlen' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strlen.php'>mb_strlen</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_strlen</span> &amp;mdash; <span class='dc-title'>Get string length</span></p> </div> <a name='function.mb-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>mb_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'>$encoding</tt></span> ] )</div> <p class='para rdfs-comment'> Gets the length of a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.mb-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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being checked for length. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-strlen.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of characters in <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> having character encoding <i><tt class='parameter'>encoding</tt></i> . A multi-byte character is counted as 1. </p> </div> <a name='function.mb-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.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</li> <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> </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="mb_stristr" value="<div id='function.mb-stristr' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-stristr.php'>mb_stristr</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0)</p><p class='refpurpose'><span class='refname'>mb_stristr</span> &amp;mdash; <span class='dc-title'>Finds first occurrence of a string within another, case insensitive</span></p> </div> <a name='function.mb-stristr.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>mb_stristr</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'>bool</span> <tt class='parameter'>$part</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>mb_stristr()</b> finds the first occurrence of <i><tt class='parameter'>needle</tt></i> in <i><tt class='parameter'>haystack</tt></i> and returns the portion of <i><tt class='parameter'>haystack</tt></i> . Unlike <a href='http://www.php.net/manual/en/function.mb-strstr.php' class='function'>mb_strstr()</a>, <b>mb_stristr()</b> is case-insensitive. If <i><tt class='parameter'>needle</tt></i> is not found, it returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mb-stristr.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 string from which to get the first occurrence of <i><tt class='parameter'>needle</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to find in <i><tt class='parameter'>haystack</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>part</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Determines which portion of <i><tt class='parameter'>haystack</tt></i> this function returns. If set to <b><tt class='constant'>TRUE</tt></b>, it returns all of <i><tt class='parameter'>haystack</tt></i> from the beginning to the first occurrence of <i><tt class='parameter'>needle</tt></i> . If set to <b><tt class='constant'>FALSE</tt></b>, it returns all of <i><tt class='parameter'>haystack</tt></i> from the first occurrence of <i><tt class='parameter'>needle</tt></i> to the end, Default value is <b><tt class='constant'>FALSE</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Character encoding name to use. If it is omitted, internal character encoding is used. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-stristr.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the portion of <i><tt class='parameter'>haystack</tt></i> , or <b><tt class='constant'>FALSE</tt></b> if <i><tt class='parameter'>needle</tt></i> is not found. </p> </div> <a name='function.mb-stristr.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.stristr.php' class='function' rel='rdfs-seeAlso'>stristr()</a> - Case-insensitive strstr</li> <li class='member'><a href='http://www.php.net/manual/en/function.strstr.php' class='function' rel='rdfs-seeAlso'>strstr()</a> - Find first occurrence of a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-strstr.php' class='function' rel='rdfs-seeAlso'>mb_strstr()</a> - Finds first occurrence of a string within 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="mb_stripos" value="<div id='function.mb-stripos' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-stripos.php'>mb_stripos</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0)</p><p class='refpurpose'><span class='refname'>mb_stripos</span> &amp;mdash; <span class='dc-title'>Finds position of first occurrence of a string within another, case insensitive</span></p> </div> <a name='function.mb-stripos.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>mb_stripos</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> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>mb_stripos()</b> returns the numeric position of the first occurrence of <i><tt class='parameter'>needle</tt></i> in the <i><tt class='parameter'>haystack</tt></i> string. Unlike <a href='http://www.php.net/manual/en/function.mb-strpos.php' class='function'>mb_strpos()</a>, <b>mb_stripos()</b> is case-insensitive. If <i><tt class='parameter'>needle</tt></i> is not found, it returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mb-stripos.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 string from which to get the position of the first occurrence of <i><tt class='parameter'>needle</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to find in <i><tt class='parameter'>haystack</tt></i> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The position in <i><tt class='parameter'>haystack</tt></i> to start searching </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Character encoding name to use. If it is omitted, internal character encoding is used. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-stripos.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Return the numeric position of the first occurrence of <i><tt class='parameter'>needle</tt></i> in the <i><tt class='parameter'>haystack</tt></i> string, or <b><tt class='constant'>FALSE</tt></b> if <i><tt class='parameter'>needle</tt></i> is not found. </p> </div> <a name='function.mb-stripos.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.stripos.php' class='function' rel='rdfs-seeAlso'>stripos()</a> - Find position of first occurrence of a case-insensitive string</li> <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.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="mb_strimwidth" value="<div id='function.mb-strimwidth' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strimwidth.php'>mb_strimwidth</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_strimwidth</span> &amp;mdash; <span class='dc-title'>Get truncated string with specified width</span></p> </div> <a name='function.mb-strimwidth.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>mb_strimwidth</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'>$start</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$width</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$trimmarker</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> Truncates <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> to specified <i><tt class='parameter'>width</tt></i> . </p> </div> <a name='function.mb-strimwidth.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being decoded. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>start</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The start position offset. Number of characters from the beginning of string. (First character is 0) </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>width</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The width of the desired trim. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>trimmarker</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A string that is added to the end of string when string is truncated. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-strimwidth.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The truncated <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. If <i><tt class='parameter'>trimmarker</tt></i> is set, <i><tt class='parameter'>trimmarker</tt></i> is appended to the return value. </p> </div> <a name='function.mb-strimwidth.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_strimwidth()</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 />$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_strimwidth</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</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'>40</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'..&amp;gt;'</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.mb-strimwidth.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.mb-strwidth.php' class='function' rel='rdfs-seeAlso'>mb_strwidth()</a> - Return width of string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</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="mb_strcut" value="<div id='function.mb-strcut' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-strcut.php'>mb_strcut</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_strcut</span> &amp;mdash; <span class='dc-title'>Get part of string</span></p> </div> <a name='function.mb-strcut.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>mb_strcut</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'>$start</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>mb_strcut()</b> performs equivalent operation as <a href='http://www.php.net/manual/en/function.mb-substr.php' class='function'>mb_substr()</a> with different method. If <i><tt class='parameter'>start</tt></i> position is multi-byte character&amp;#039;s second byte or larger, it starts from first byte of multi-byte character. </p> <p class='para'> It subtracts string from <i><tt class='parameter'>str</tt></i> that is shorter than <i><tt class='parameter'>length</tt></i> AND character that is not part of multi-byte string or not being middle of shift sequence. </p> </div> <a name='function.mb-strcut.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being cut. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>start</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The position that begins the cut. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being decoded. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-strcut.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>mb_strcut()</b> returns the portion of <i><tt class='parameter'>str</tt></i> specified by the <i><tt class='parameter'>start</tt></i> and <i><tt class='parameter'>length</tt></i> parameters. </p> </div> <a name='function.mb-strcut.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.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-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</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="mb_split" value="<div id='function.mb-split' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-split.php'>mb_split</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_split</span> &amp;mdash; <span class='dc-title'>Split multibyte string using regular expression</span></p> </div> <a name='function.mb-split.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>mb_split</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$limit</tt><span class='initializer'> = -1</span></span> ] )</div> <p class='simpara'> Split a multibyte <i><tt class='parameter'>string</tt></i> using regular expression <i><tt class='parameter'>pattern</tt></i> and returns the result as an <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>. </p> </div> <a name='function.mb-split.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'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The regular expression pattern. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being split. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>limit</tt></i> </span> </dt><dd class='listitem'> <span class='simpara'> If optional parameter <i><tt class='parameter'>limit</tt></i> is specified, it will be split in <i><tt class='parameter'>limit</tt></i> elements as maximum. </span> </dd> </dl> <p> </p> </div> <a name='function.mb-split.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The result as an <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>. </p> </div> <a name='function.mb-split.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-split.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg.php' class='function' rel='rdfs-seeAlso'>mb_ereg()</a> - Regular expression match with multibyte support</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="mb_send_mail" value="<div id='function.mb-send-mail' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-send-mail.php'>mb_send_mail</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_send_mail</span> &amp;mdash; <span class='dc-title'>Send encoded mail</span></p> </div> <a name='function.mb-send-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>mb_send_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'>$additional_parameter</tt><span class='initializer'> = NULL</span></span> ]] )</div> <p class='para rdfs-comment'> Sends email. Headers and messages are converted and encoded according to the <a href='http://www.php.net/manual/en/function.mb-language.php' class='function'>mb_language()</a> setting. It&amp;#039;s a wrapper function for <a href='http://www.php.net/manual/en/function.mail.php' class='function'>mail()</a>, so see also <a href='http://www.php.net/manual/en/function.mail.php' class='function'>mail()</a> for details. </p> </div> <a name='function.mb-send-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 mail addresses being sent to. Multiple recipients may be specified by putting a comma between each address in <i><tt class='parameter'>to</tt></i> . This parameter is not automatically encoded. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>subject</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The subject of the mail. </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 of the mail. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>additional_headers</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>additional_headers</tt></i> is inserted at the end of the header. This is typically used to add extra headers. Multiple extra headers are separated with a newline (&amp;quot;\n&amp;quot;). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>additional_parameter</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>additional_parameter</tt></i> is a MTA command line parameter. It is useful when setting the correct Return-Path header when using sendmail. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-send-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.mb-send-mail.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>Content-Type</i> and <i>Content-Transfer-Encoding</i> headers may be redefined as of PHP 5.0.0. Before this time, the values defined by <a href='http://www.php.net/manual/en/function.mb-language.php' class='function'>mb_language()</a> are always used. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mb-send-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> <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.mb-language.php' class='function' rel='rdfs-seeAlso'>mb_language()</a> - Set/Get current language</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="mb_regex_set_options" value="<div id='function.mb-regex-set-options' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-regex-set-options.php'>mb_regex_set_options</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_regex_set_options</span> &amp;mdash; <span class='dc-title'>Set/Get the default options for mbregex functions</span></p> </div> <a name='function.mb-regex-set-options.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>mb_regex_set_options</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$options</tt><span class='initializer'> = &amp;quot;msr&amp;quot;</span></span> ] )</div> <p class='simpara'> Sets the default options described by <i><tt class='parameter'>options</tt></i> for multibyte regex functions. </p> </div> <a name='function.mb-regex-set-options.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'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The options to set. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-regex-set-options.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The previous options. If <i><tt class='parameter'>options</tt></i> is omitted, it returns the <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> that describes the current options. </p> </div> <a name='function.mb-regex-set-options.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.mb-split.php' class='function' rel='rdfs-seeAlso'>mb_split()</a> - Split multibyte string using regular expression</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg.php' class='function' rel='rdfs-seeAlso'>mb_ereg()</a> - Regular expression match with multibyte support</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-eregi.php' class='function' rel='rdfs-seeAlso'>mb_eregi()</a> - Regular expression match ignoring case with multibyte support</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="mb_regex_encoding" value="<div id='function.mb-regex-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-regex-encoding.php'>mb_regex_encoding</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_regex_encoding</span> &amp;mdash; <span class='dc-title'>Returns current encoding for multibyte regex as string</span></p> </div> <a name='function.mb-regex-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>mb_regex_encoding</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ] )</div> <p class='para rdfs-comment'> Returns the current encoding for a multibyte regex as a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.mb-regex-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'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The <i><tt class='parameter'>encoding</tt></i> parameter is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-regex-encoding.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> Returns the character encoding used by multibyte regex functions. </p> </div> <a name='function.mb-regex-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.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg.php' class='function' rel='rdfs-seeAlso'>mb_ereg()</a> - Regular expression match with multibyte support</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="mb_preferred_mime_name" value="<div id='function.mb-preferred-mime-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-preferred-mime-name.php'>mb_preferred_mime_name</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_preferred_mime_name</span> &amp;mdash; <span class='dc-title'>Get MIME charset string</span></p> </div> <a name='function.mb-preferred-mime-name.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>mb_preferred_mime_name</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> )</div> <p class='para rdfs-comment'> Get a MIME charset <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> for a specific encoding. </p> </div> <a name='function.mb-preferred-mime-name.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'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The encoding being checked. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-preferred-mime-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The MIME <i>charset</i> <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> for character encoding <i><tt class='parameter'>encoding</tt></i> . </p> </div> <a name='function.mb-preferred-mime-name.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_preferred_mime_name()</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 />$outputenc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'sjis-win'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>mb_http_output</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$outputenc</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>ob_start</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mb_output_handler'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;text/html;&amp;nbsp;charset='&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mb_preferred_mime_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$outputenc</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="mb_parse_str" value="<div id='function.mb-parse-str' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-parse-str.php'>mb_parse_str</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_parse_str</span> &amp;mdash; <span class='dc-title'>Parse GET/POST/COOKIE data and set global variable</span></p> </div> <a name='function.mb-parse-str.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>mb_parse_str</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoded_string</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$result</tt></span> ] )</div> <p class='para rdfs-comment'> Parses GET/POST/COOKIE data and sets global variables. Since PHP does not provide raw POST/COOKIE data, it can only be used for GET data for now. It parses URL encoded data, detects encoding, converts coding to internal encoding and set values to the <i><tt class='parameter'>result</tt></i> <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> or global variables. </p> </div> <a name='function.mb-parse-str.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_string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The URL encoded data. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> containing decoded and character encoded converted values. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-parse-str.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.mb-parse-str.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.mb-detect-order.php' class='function' rel='rdfs-seeAlso'>mb_detect_order()</a> - Set/Get character encoding detection order</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</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="mb_output_handler" value="<div id='function.mb-output-handler' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-output-handler.php'>mb_output_handler</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_output_handler</span> &amp;mdash; <span class='dc-title'>Callback function converts character encoding in output buffer</span></p> </div> <a name='function.mb-output-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>mb_output_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'> <b>mb_output_handler()</b> is <a href='http://www.php.net/manual/en/function.ob-start.php' class='function'>ob_start()</a> callback function. <b>mb_output_handler()</b> converts characters in the output buffer from internal character encoding to HTTP output character encoding. </p> </div> <a name='function.mb-output-handler.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'>contents</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The contents of the output buffer. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>status</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The status of the output buffer. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-output-handler.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The converted <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.mb-output-handler.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'> <p class='para'> This handler now adds the charset HTTP header when the following conditions are met: </p> <p class='para'> </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> Does not set <i>Content-Type</i>, using <a href='http://www.php.net/manual/en/function.header.php' class='function'>header()</a>. </span> </li> <li class='listitem'> <span class='simpara'> The default MIME type begins with <i>text/</i>. </span> </li> <li class='listitem'> <span class='simpara'> The <a href='http://www.php.net/manual/en/mbstring.configuration.php#ini.mbstring.http-input' class='link'>mbstring.http_input</a> setting is something other than <i>pass</i>. </span> </li> </ul><p> </p> </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mb-output-handler.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_output_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 />mb_http_output</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>ob_start</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mb_output_handler'</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.mb-output-handler.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: If you want to output some binary data such as image from PHP script with PHP 4.3.0 or later, Content-Type: header must be send using <a href='http://www.php.net/manual/en/function.header.php' class='function'>header()</a> before any binary data was send to client (e.g. header(&amp;quot;Content-Type: image/png&amp;quot;)). If Content-Type: header was send, output character encoding conversion will not be performed. <br /> Note that if &amp;#039;Content-Type: text/*&amp;#039; was send using <a href='http://www.php.net/manual/en/function.header.php' class='function'>header()</a>, the sending data is regarded as text, encoding conversion will be performed using character encoding settings. <br /> If you want to output some binary data such as image from PHP script with PHP 4.2.x or earlier, you must set output encoding to &amp;quot;pass&amp;quot; using <a href='http://www.php.net/manual/en/function.mb-http-output.php' class='function'>mb_http_output()</a>. <br /> </p></blockquote> </div> <a name='function.mb-output-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.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="mb_list_encodings" value="<div id='function.mb-list-encodings' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-list-encodings.php'>mb_list_encodings</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>mb_list_encodings</span> &amp;mdash; <span class='dc-title'>Returns an array of all supported encodings</span></p> </div> <a name='function.mb-list-encodings.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>mb_list_encodings</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns an array containing all supported encodings. </p> </div> <a name='function.mb-list-encodings.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='function.mb-list-encodings.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a numerically indexed array. </p> </div> <a name='function.mb-list-encodings.errors'></a><div class='refsect1 errors'> <h3 class='title'>Errors/Exceptions</h3> <p class='para'> This function does not emit any errors. </p> </div> <a name='function.mb-list-encodings.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_list_encodings()</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'>mb_list_encodings</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 ( [0] =&amp;gt; pass [1] =&amp;gt; auto [2] =&amp;gt; wchar [3] =&amp;gt; byte2be [4] =&amp;gt; byte2le [5] =&amp;gt; byte4be [6] =&amp;gt; byte4le [7] =&amp;gt; BASE64 [8] =&amp;gt; UUENCODE [9] =&amp;gt; HTML-ENTITIES [10] =&amp;gt; Quoted-Printable [11] =&amp;gt; 7bit [12] =&amp;gt; 8bit [13] =&amp;gt; UCS-4 [14] =&amp;gt; UCS-4BE [15] =&amp;gt; UCS-4LE [16] =&amp;gt; UCS-2 [17] =&amp;gt; UCS-2BE [18] =&amp;gt; UCS-2LE [19] =&amp;gt; UTF-32 [20] =&amp;gt; UTF-32BE [21] =&amp;gt; UTF-32LE [22] =&amp;gt; UTF-16 [23] =&amp;gt; UTF-16BE [24] =&amp;gt; UTF-16LE [25] =&amp;gt; UTF-8 [26] =&amp;gt; UTF-7 [27] =&amp;gt; UTF7-IMAP [28] =&amp;gt; ASCII [29] =&amp;gt; EUC-JP [30] =&amp;gt; SJIS [31] =&amp;gt; eucJP-win [32] =&amp;gt; SJIS-win [33] =&amp;gt; JIS [34] =&amp;gt; ISO-2022-JP [35] =&amp;gt; Windows-1252 [36] =&amp;gt; ISO-8859-1 [37] =&amp;gt; ISO-8859-2 [38] =&amp;gt; ISO-8859-3 [39] =&amp;gt; ISO-8859-4 [40] =&amp;gt; ISO-8859-5 [41] =&amp;gt; ISO-8859-6 [42] =&amp;gt; ISO-8859-7 [43] =&amp;gt; ISO-8859-8 [44] =&amp;gt; ISO-8859-9 [45] =&amp;gt; ISO-8859-10 [46] =&amp;gt; ISO-8859-13 [47] =&amp;gt; ISO-8859-14 [48] =&amp;gt; ISO-8859-15 [49] =&amp;gt; EUC-CN [50] =&amp;gt; CP936 [51] =&amp;gt; HZ [52] =&amp;gt; EUC-TW [53] =&amp;gt; BIG-5 [54] =&amp;gt; EUC-KR [55] =&amp;gt; UHC [56] =&amp;gt; ISO-2022-KR [57] =&amp;gt; Windows-1251 [58] =&amp;gt; CP866 [59] =&amp;gt; KOI8-R ) </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="mb_language" value="<div id='function.mb-language' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-language.php'>mb_language</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_language</span> &amp;mdash; <span class='dc-title'>Set/Get current language</span></p> </div> <a name='function.mb-language.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>mb_language</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$language</tt></span> ] )</div> <p class='para rdfs-comment'> Set/Get the current language. </p> </div> <a name='function.mb-language.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'>language</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Used for encoding e-mail messages. Valid languages are &amp;quot;Japanese&amp;quot;, &amp;quot;ja&amp;quot;,&amp;quot;English&amp;quot;,&amp;quot;en&amp;quot; and &amp;quot;uni&amp;quot; (UTF-8). <a href='http://www.php.net/manual/en/function.mb-send-mail.php' class='function'>mb_send_mail()</a> uses this setting to encode e-mail. </p> <p class='para'> Language and its setting is ISO-2022-JP/Base64 for Japanese, UTF-8/Base64 for uni, ISO-8859-1/quoted printable for English. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-language.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If <i><tt class='parameter'>language</tt></i> is set and <i><tt class='parameter'>language</tt></i> is valid, it returns <b><tt class='constant'>TRUE</tt></b>. Otherwise, it returns <b><tt class='constant'>FALSE</tt></b>. When <i><tt class='parameter'>language</tt></i> is omitted, it returns the language name as a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. If no language is set previously, it then returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mb-language.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.mb-send-mail.php' class='function' rel='rdfs-seeAlso'>mb_send_mail()</a> - Send encoded 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="mb_internal_encoding" value="<div id='function.mb-internal-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-internal-encoding.php'>mb_internal_encoding</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_internal_encoding</span> &amp;mdash; <span class='dc-title'>Set/Get internal character encoding</span></p> </div> <a name='function.mb-internal-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>mb_internal_encoding</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt><span class='initializer'> = mb_internal_encoding()</span></span> ] )</div> <p class='para rdfs-comment'> Set/Get the internal character encoding </p> </div> <a name='function.mb-internal-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'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>encoding</tt></i> is the character encoding name used for the HTTP input character encoding conversion, HTTP output character encoding conversion, and the default character encoding for string functions defined by the mbstring module. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-internal-encoding.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If <i><tt class='parameter'>encoding</tt></i> is set, then Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. If <i><tt class='parameter'>encoding</tt></i> is omitted, then the current character encoding name is returned. </p> </div> <a name='function.mb-internal-encoding.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_internal_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 /></span><span style='color: #FF8000'>/*&amp;nbsp;Set&amp;nbsp;internal&amp;nbsp;character&amp;nbsp;encoding&amp;nbsp;to&amp;nbsp;UTF-8&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mb_internal_encoding</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Display&amp;nbsp;current&amp;nbsp;internal&amp;nbsp;character&amp;nbsp;encoding&amp;nbsp;*/<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>mb_internal_encoding</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.mb-internal-encoding.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-internal-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.mb-http-input.php' class='function' rel='rdfs-seeAlso'>mb_http_input()</a> - Detect HTTP input character encoding</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-http-output.php' class='function' rel='rdfs-seeAlso'>mb_http_output()</a> - Set/Get HTTP output character encoding</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-detect-order.php' class='function' rel='rdfs-seeAlso'>mb_detect_order()</a> - Set/Get character encoding detection order</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="mb_http_output" value="<div id='function.mb-http-output' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-http-output.php'>mb_http_output</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_http_output</span> &amp;mdash; <span class='dc-title'>Set/Get HTTP output character encoding</span></p> </div> <a name='function.mb-http-output.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>mb_http_output</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ] )</div> <p class='para rdfs-comment'> Set/Get the HTTP output character encoding. Output after this function is converted to <i><tt class='parameter'>encoding</tt></i> . </p> </div> <a name='function.mb-http-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'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>encoding</tt></i> is set, <b>mb_http_output()</b> sets the HTTP output character encoding to <i><tt class='parameter'>encoding</tt></i> . </p> <p class='para'> If <i><tt class='parameter'>encoding</tt></i> is omitted, <b>mb_http_output()</b> returns the current HTTP output character encoding. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-http-output.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If <i><tt class='parameter'>encoding</tt></i> is omitted, <b>mb_http_output()</b> returns the current HTTP output character encoding. Otherwise, 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.mb-http-output.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.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-http-input.php' class='function' rel='rdfs-seeAlso'>mb_http_input()</a> - Detect HTTP input character encoding</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-detect-order.php' class='function' rel='rdfs-seeAlso'>mb_detect_order()</a> - Set/Get character encoding detection order</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="mb_http_input" value="<div id='function.mb-http-input' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-http-input.php'>mb_http_input</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_http_input</span> &amp;mdash; <span class='dc-title'>Detect HTTP input character encoding</span></p> </div> <a name='function.mb-http-input.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>mb_http_input</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$type</tt><span class='initializer'> = &amp;quot;&amp;quot;</span></span> ] )</div> <p class='simpara'> Detects the HTTP input character encoding. </p> </div> <a name='function.mb-http-input.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'> Input string specifies the input type. &amp;quot;G&amp;quot; for GET, &amp;quot;P&amp;quot; for POST, &amp;quot;C&amp;quot; for COOKIE, &amp;quot;S&amp;quot; for string, &amp;quot;L&amp;quot; for list, and &amp;quot;I&amp;quot; for the whole list (will return <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>). If type is omitted, it returns the last input type processed. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-http-input.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The character encoding name, as per the <i><tt class='parameter'>type</tt></i> . If <b>mb_http_input()</b> does not process specified HTTP input, it returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.mb-http-input.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.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-http-output.php' class='function' rel='rdfs-seeAlso'>mb_http_output()</a> - Set/Get HTTP output character encoding</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-detect-order.php' class='function' rel='rdfs-seeAlso'>mb_detect_order()</a> - Set/Get character encoding detection order</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="mb_get_info" value="<div id='function.mb-get-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-get-info.php'>mb_get_info</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_get_info</span> &amp;mdash; <span class='dc-title'>Get internal settings of mbstring</span></p> </div> <a name='function.mb-get-info.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>mb_get_info</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='simpara'> <b>mb_get_info()</b> returns the internal setting parameters of mbstring. </p> </div> <a name='function.mb-get-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'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>type</tt></i> isn&amp;#039;t specified or is specified to &amp;quot;all&amp;quot;, an <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> having the elements &amp;quot;internal_encoding&amp;quot;, &amp;quot;http_output&amp;quot;, &amp;quot;http_input&amp;quot;, &amp;quot;func_overload&amp;quot;, &amp;quot;mail_charset&amp;quot;, &amp;quot;mail_header_encoding&amp;quot;, &amp;quot;mail_body_encoding&amp;quot; will be returned. </p> <p class='para'> If <i><tt class='parameter'>type</tt></i> is specified as &amp;quot;http_output&amp;quot;, &amp;quot;http_input&amp;quot;, &amp;quot;internal_encoding&amp;quot;, &amp;quot;func_overload&amp;quot;, the specified setting parameter will be returned. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-get-info.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 type information if <i><tt class='parameter'>type</tt></i> is not specified, otherwise a specific <i><tt class='parameter'>type</tt></i> . </p> </div> <a name='function.mb-get-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'>5.1.3</td> <td align='left'> The entries &amp;quot;mail_charset&amp;quot;, &amp;quot;mail_header_encoding&amp;quot;, and &amp;quot;mail_body_encoding&amp;quot; were made available. </td> </tr> <tr valign='middle'> <td align='left'>5.3.0</td> <td align='left'> The entry &amp;quot;http_output_conv_mimetypes&amp;quot; was made available. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mb-get-info.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-http-output.php' class='function' rel='rdfs-seeAlso'>mb_http_output()</a> - Set/Get HTTP output character encoding</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="mb_ereg_search_setpos" value="<div id='function.mb-ereg-search-setpos' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-ereg-search-setpos.php'>mb_ereg_search_setpos</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_ereg_search_setpos</span> &amp;mdash; <span class='dc-title'>Set start point of next regular expression match</span></p> </div> <a name='function.mb-ereg-search-setpos.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>mb_ereg_search_setpos</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$position</tt></span> )</div> <p class='simpara'> <b>mb_ereg_search_setpos()</b> sets the starting point of a match for <a href='http://www.php.net/manual/en/function.mb-ereg-search.php' class='function'>mb_ereg_search()</a>. </p> </div> <a name='function.mb-ereg-search-setpos.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'>position</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The position to set. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-ereg-search-setpos.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> 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.mb-ereg-search-setpos.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-ereg-search-setpos.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg-search-init.php' class='function' rel='rdfs-seeAlso'>mb_ereg_search_init()</a> - Setup string and regular expression for a multibyte regular expression match</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="mb_ereg_search_regs" value="<div id='function.mb-ereg-search-regs' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-ereg-search-regs.php'>mb_ereg_search_regs</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_ereg_search_regs</span> &amp;mdash; <span class='dc-title'>Returns the matched part of a multibyte regular expression</span></p> </div> <a name='function.mb-ereg-search-regs.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>mb_ereg_search_regs</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt><span class='initializer'> = &amp;quot;ms&amp;quot;</span></span> ]] )</div> <p class='para rdfs-comment'> Returns the matched part of a multibyte regular expression. </p> </div> <a name='function.mb-ereg-search-regs.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'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search pattern. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search option. Defaults to &amp;#039;ms&amp;#039;. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-ereg-search-regs.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> <b>mb_ereg_search_regs()</b> executes the multibyte regular expression match, and if there are some matched part, it returns an <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> including substring of matched part as first element, the first grouped part with brackets as second element, the second grouped part as third element, and so on. It returns <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.mb-ereg-search-regs.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-ereg-search-regs.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg-search-init.php' class='function' rel='rdfs-seeAlso'>mb_ereg_search_init()</a> - Setup string and regular expression for a multibyte regular expression match</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="mb_ereg_search_pos" value="<div id='function.mb-ereg-search-pos' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-ereg-search-pos.php'>mb_ereg_search_pos</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_ereg_search_pos</span> &amp;mdash; <span class='dc-title'>Returns position and length of a matched part of the multibyte regular expression for a predefined multibyte string</span></p> </div> <a name='function.mb-ereg-search-pos.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>mb_ereg_search_pos</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt><span class='initializer'> = &amp;quot;ms&amp;quot;</span></span> ]] )</div> <p class='para rdfs-comment'> Returns position and length of a matched part of the multibyte regular expression for a predefined multibyte string </p> <p class='para'> The string for match is specified by <a href='http://www.php.net/manual/en/function.mb-ereg-search-init.php' class='function'>mb_ereg_search_init()</a>. If it is not specified, the previous one will be used. </p> </div> <a name='function.mb-ereg-search-pos.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'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search pattern. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search option. Defaults to &amp;#039;ms&amp;#039;. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-ereg-search-pos.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> including the position of a matched part for a multibyte regular expression. The first element of the array will be the beginning of matched part, the second element will be length (bytes) of matched part. It returns <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.mb-ereg-search-pos.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-ereg-search-pos.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg-search-init.php' class='function' rel='rdfs-seeAlso'>mb_ereg_search_init()</a> - Setup string and regular expression for a multibyte regular expression match</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="mb_ereg_search_init" value="<div id='function.mb-ereg-search-init' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-ereg-search-init.php'>mb_ereg_search_init</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_ereg_search_init</span> &amp;mdash; <span class='dc-title'>Setup string and regular expression for a multibyte regular expression match</span></p> </div> <a name='function.mb-ereg-search-init.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>mb_ereg_search_init</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt><span class='initializer'> = &amp;quot;msr&amp;quot;</span></span> ]] )</div> <p class='para rdfs-comment'> <b>mb_ereg_search_init()</b> sets <i><tt class='parameter'>string</tt></i> and <i><tt class='parameter'>pattern</tt></i> for a multibyte regular expression. These values are used for <a href='http://www.php.net/manual/en/function.mb-ereg-search.php' class='function'>mb_ereg_search()</a>, <a href='http://www.php.net/manual/en/function.mb-ereg-search-pos.php' class='function'>mb_ereg_search_pos()</a>, and <a href='http://www.php.net/manual/en/function.mb-ereg-search-regs.php' class='function'>mb_ereg_search_regs()</a>. </p> </div> <a name='function.mb-ereg-search-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'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search pattern. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search option. Defaults to &amp;#039;ms&amp;#039;. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-ereg-search-init.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> 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.mb-ereg-search-init.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-ereg-search-init.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg-search-regs.php' class='function' rel='rdfs-seeAlso'>mb_ereg_search_regs()</a> - Returns the matched part of a multibyte regular expression</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="mb_ereg_search_getregs" value="<div id='function.mb-ereg-search-getregs' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-ereg-search-getregs.php'>mb_ereg_search_getregs</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_ereg_search_getregs</span> &amp;mdash; <span class='dc-title'>Retrieve the result from the last multibyte regular expression match</span></p> </div> <a name='function.mb-ereg-search-getregs.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>mb_ereg_search_getregs</b></span> ( <span class='methodparam'>void</span> )</div> <p class='simpara'> Retrieve the result from the last multibyte regular expression match </p> </div> <a name='function.mb-ereg-search-getregs.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='function.mb-ereg-search-getregs.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> including the sub-string of matched part by last <a href='http://www.php.net/manual/en/function.mb-ereg-search.php' class='function'>mb_ereg_search()</a>, <a href='http://www.php.net/manual/en/function.mb-ereg-search-pos.php' class='function'>mb_ereg_search_pos()</a>, <a href='http://www.php.net/manual/en/function.mb-ereg-search-regs.php' class='function'>mb_ereg_search_regs()</a>. If there are some matches, the first element will have the matched sub-string, the second element will have the first part grouped with brackets, the third element will have the second part grouped with brackets, and so on. It returns <b><tt class='constant'>FALSE</tt></b> on error; </p> </div> <a name='function.mb-ereg-search-getregs.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-ereg-search-getregs.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg-search-init.php' class='function' rel='rdfs-seeAlso'>mb_ereg_search_init()</a> - Setup string and regular expression for a multibyte regular expression match</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="mb_ereg_search_getpos" value="<div id='function.mb-ereg-search-getpos' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-ereg-search-getpos.php'>mb_ereg_search_getpos</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_ereg_search_getpos</span> &amp;mdash; <span class='dc-title'>Returns start point for next regular expression match</span></p> </div> <a name='function.mb-ereg-search-getpos.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>mb_ereg_search_getpos</b></span> ( <span class='methodparam'>void</span> )</div> <p class='simpara'> Returns the start point for the next regular expression match. </p> </div> <a name='function.mb-ereg-search-getpos.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='function.mb-ereg-search-getpos.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> <b>mb_ereg_search_getpos()</b> returns the point to start regular expression match for <a href='http://www.php.net/manual/en/function.mb-ereg-search.php' class='function'>mb_ereg_search()</a>, <a href='http://www.php.net/manual/en/function.mb-ereg-search-pos.php' class='function'>mb_ereg_search_pos()</a>, <a href='http://www.php.net/manual/en/function.mb-ereg-search-regs.php' class='function'>mb_ereg_search_regs()</a>. The position is represented by bytes from the head of string. </p> </div> <a name='function.mb-ereg-search-getpos.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-ereg-search-getpos.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg-search-setpos.php' class='function' rel='rdfs-seeAlso'>mb_ereg_search_setpos()</a> - Set start point of next regular expression match</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="mb_ereg_search" value="<div id='function.mb-ereg-search' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-ereg-search.php'>mb_ereg_search</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_ereg_search</span> &amp;mdash; <span class='dc-title'>Multibyte regular expression match for predefined multibyte string</span></p> </div> <a name='function.mb-ereg-search.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>mb_ereg_search</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt><span class='initializer'> = &amp;quot;ms&amp;quot;</span></span> ]] )</div> <p class='para rdfs-comment'> Performs a multibyte regular expression match for a predefined multibyte string. </p> </div> <a name='function.mb-ereg-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'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search pattern. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search option. Defaults to &amp;#039;ms&amp;#039;. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-ereg-search.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> <b>mb_ereg_search()</b> returns <b><tt class='constant'>TRUE</tt></b> if the multibyte string matches with the regular expression, or <b><tt class='constant'>FALSE</tt></b> otherwise. The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> for matching is set by <a href='http://www.php.net/manual/en/function.mb-ereg-search-init.php' class='function'>mb_ereg_search_init()</a>. If <i><tt class='parameter'>pattern</tt></i> is not specified, the previous one is used. </p> </div> <a name='function.mb-ereg-search.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-ereg-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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg-search-init.php' class='function' rel='rdfs-seeAlso'>mb_ereg_search_init()</a> - Setup string and regular expression for a multibyte regular expression match</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="mb_ereg_replace" value="<div id='function.mb-ereg-replace' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-ereg-replace.php'>mb_ereg_replace</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_ereg_replace</span> &amp;mdash; <span class='dc-title'>Replace regular expression with multibyte support</span></p> </div> <a name='function.mb-ereg-replace.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>mb_ereg_replace</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$replacement</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt><span class='initializer'> = &amp;quot;msr&amp;quot;</span></span> ] )</div> <p class='simpara'> Scans <i><tt class='parameter'>string</tt></i> for matches to <i><tt class='parameter'>pattern</tt></i> , then replaces the matched text with <i><tt class='parameter'>replacement</tt></i> </p> </div> <a name='function.mb-ereg-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'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The regular expression pattern. </p> <p class='para'> Multibyte characters may be used in <i><tt class='parameter'>pattern</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>replacement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The replacement text. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being checked. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <span class='simpara'> Matching condition can be set by <i><tt class='parameter'>option</tt></i> parameter. If <i>i</i> is specified for this parameter, the case will be ignored. If <i>x</i> is specified, white space will be ignored. If <i>m</i> is specified, match will be executed in multiline mode and line break will be included in &amp;#039;.&amp;#039;. If <i>p</i> is specified, match will be executed in POSIX mode, line break will be considered as normal character. If <i>e</i> is specified, <i><tt class='parameter'>replacement</tt></i> string will be evaluated as PHP expression. </span> </dd> </dl> <p> </p> </div> <a name='function.mb-ereg-replace.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The resultant <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> on success, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.mb-ereg-replace.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> <div class='warning'><b class='warning'>Warning</b><p class='para'>Never use the <i>e</i> modifier when working on untrusted input. No automatic escaping will happen (as known from <a href='http://www.php.net/manual/en/function.preg-replace.php' class='function'>preg_replace()</a>). Not taking care of this will most likely create remote code execution vulnerabilities in your application.</p></div> </div> <a name='function.mb-ereg-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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-eregi-replace.php' class='function' rel='rdfs-seeAlso'>mb_eregi_replace()</a> - Replace regular expression with multibyte support ignoring case</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="mb_ereg_match" value="<div id='function.mb-ereg-match' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-ereg-match.php'>mb_ereg_match</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_ereg_match</span> &amp;mdash; <span class='dc-title'>Regular expression match for multibyte string</span></p> </div> <a name='function.mb-ereg-match.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>mb_ereg_match</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt><span class='initializer'> = &amp;quot;msr&amp;quot;</span></span> ] )</div> <p class='para rdfs-comment'> A regular expression match for a multibyte string </p> </div> <a name='function.mb-ereg-match.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'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The regular expression pattern. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being evaluated. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.mb-ereg-match.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> Returns <b><tt class='constant'>TRUE</tt></b> if <i><tt class='parameter'>string</tt></i> matches the regular expression <i><tt class='parameter'>pattern</tt></i> , <b><tt class='constant'>FALSE</tt></b> if not. </p> </div> <a name='function.mb-ereg-match.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-ereg-match.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg.php' class='function' rel='rdfs-seeAlso'>mb_ereg()</a> - Regular expression match with multibyte support</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="mb_eregi_replace" value="<div id='function.mb-eregi-replace' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-eregi-replace.php'>mb_eregi_replace</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_eregi_replace</span> &amp;mdash; <span class='dc-title'>Replace regular expression with multibyte support ignoring case</span></p> </div> <a name='function.mb-eregi-replace.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>mb_eregi_replace</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$replace</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt><span class='initializer'> = &amp;quot;msri&amp;quot;</span></span> ] )</div> <p class='simpara'> Scans <i><tt class='parameter'>string</tt></i> for matches to <i><tt class='parameter'>pattern</tt></i> , then replaces the matched text with <i><tt class='parameter'>replacement</tt></i> . </p> </div> <a name='function.mb-eregi-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'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The regular expression pattern. Multibyte characters may be used. The case will be ignored. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>replace</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The replacement text. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The searched <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <span class='simpara'> <i><tt class='parameter'>option</tt></i> has the same meaning as in <a href='http://www.php.net/manual/en/function.mb-ereg-replace.php' class='function'>mb_ereg_replace()</a>. </span> </dd> </dl> <p> </p> </div> <a name='function.mb-eregi-replace.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The resultant <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.mb-eregi-replace.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> <div class='warning'><b class='warning'>Warning</b><p class='para'>Never use the <i>e</i> modifier when working on untrusted input. No automatic escaping will happen (as known from <a href='http://www.php.net/manual/en/function.preg-replace.php' class='function'>preg_replace()</a>). Not taking care of this will most likely create remote code execution vulnerabilities in your application.</p></div> </div> <a name='function.mb-eregi-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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg-replace.php' class='function' rel='rdfs-seeAlso'>mb_ereg_replace()</a> - Replace regular expression with multibyte support</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="mb_eregi" value="<div id='function.mb-eregi' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-eregi.php'>mb_eregi</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_eregi</span> &amp;mdash; <span class='dc-title'>Regular expression match ignoring case with multibyte support</span></p> </div> <a name='function.mb-eregi.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>mb_eregi</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$regs</tt></span> ] )</div> <p class='simpara'> Executes the case insensitive regular expression match with multibyte support. </p> </div> <a name='function.mb-eregi.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'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The regular expression pattern. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being searched. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>regs</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Contains a substring of the matched <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-eregi.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> Executes the regular expression match with multibyte support, and returns <i>1</i> if matches are found. If the optional <i><tt class='parameter'>regs</tt></i> parameter was specified, the function returns the byte length of matched part, and the <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> <i><tt class='parameter'>regs</tt></i> will contain the substring of matched string. The function returns <i>1</i> if it matches with the empty string. If no matches are found or an error happens, <b><tt class='constant'>FALSE</tt></b> will be returned. </p> </div> <a name='function.mb-eregi.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-eregi.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-ereg.php' class='function' rel='rdfs-seeAlso'>mb_ereg()</a> - Regular expression match with multibyte support</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="mb_ereg" value="<div id='function.mb-ereg' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-ereg.php'>mb_ereg</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_ereg</span> &amp;mdash; <span class='dc-title'>Regular expression match with multibyte support</span></p> </div> <a name='function.mb-ereg.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>mb_ereg</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pattern</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$regs</tt></span> ] )</div> <p class='simpara'> Executes the regular expression match with multibyte support. </p> </div> <a name='function.mb-ereg.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'>pattern</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search pattern. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>regs</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Contains a substring of the matched <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-ereg.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='simpara'> Executes the regular expression match with multibyte support, and returns <i>1</i> if matches are found. If the optional <i><tt class='parameter'>regs</tt></i> parameter was specified, the function returns the byte length of matched part, and the <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> <i><tt class='parameter'>regs</tt></i> will contain the substring of matched string. The function returns <i>1</i> if it matches with the empty string. If no matches are found or an error happens, <b><tt class='constant'>FALSE</tt></b> will be returned. </p> </div> <a name='function.mb-ereg.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The internal encoding or the character encoding specified by <a href='http://www.php.net/manual/en/function.mb-regex-encoding.php' class='function'>mb_regex_encoding()</a> will be used as the character encoding for this function.<br /></p></blockquote> </div> <a name='function.mb-ereg.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.mb-regex-encoding.php' class='function' rel='rdfs-seeAlso'>mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-eregi.php' class='function' rel='rdfs-seeAlso'>mb_eregi()</a> - Regular expression match ignoring case with multibyte support</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="mb_encode_numericentity" value="<div id='function.mb-encode-numericentity' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-encode-numericentity.php'>mb_encode_numericentity</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_encode_numericentity</span> &amp;mdash; <span class='dc-title'>Encode character to HTML numeric string reference</span></p> </div> <a name='function.mb-encode-numericentity.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>mb_encode_numericentity</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$convmap</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> )</div> <p class='para rdfs-comment'> Converts specified character codes in <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> from HTML numeric character reference to character code. </p> </div> <a name='function.mb-encode-numericentity.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being encoded. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>convmap</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>convmap</tt></i> is array specifies code area to convert. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-encode-numericentity.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The converted <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.mb-encode-numericentity.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <i><tt class='parameter'>convmap</tt></i> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> $convmap&amp;nbsp;=&amp;nbsp;array&amp;nbsp;(<br />&amp;nbsp;int&amp;nbsp;start_code1,&amp;nbsp;int&amp;nbsp;end_code1,&amp;nbsp;int&amp;nbsp;offset1,&amp;nbsp;int&amp;nbsp;mask1,<br />&amp;nbsp;int&amp;nbsp;start_code2,&amp;nbsp;int&amp;nbsp;end_code2,&amp;nbsp;int&amp;nbsp;offset2,&amp;nbsp;int&amp;nbsp;mask2,<br />&amp;nbsp;........<br />&amp;nbsp;int&amp;nbsp;start_codeN,&amp;nbsp;int&amp;nbsp;end_codeN,&amp;nbsp;int&amp;nbsp;offsetN,&amp;nbsp;int&amp;nbsp;maskN&amp;nbsp;);<br />//&amp;nbsp;Specify&amp;nbsp;Unicode&amp;nbsp;value&amp;nbsp;for&amp;nbsp;start_codeN&amp;nbsp;and&amp;nbsp;end_codeN<br />//&amp;nbsp;Add&amp;nbsp;offsetN&amp;nbsp;to&amp;nbsp;value&amp;nbsp;and&amp;nbsp;take&amp;nbsp;bit-wise&amp;nbsp;'AND'&amp;nbsp;with&amp;nbsp;maskN,&amp;nbsp;then<br />//&amp;nbsp;it&amp;nbsp;converts&amp;nbsp;value&amp;nbsp;to&amp;nbsp;numeric&amp;nbsp;string&amp;nbsp;reference.</span> </code></div> </div> </div><p> </p> </div> <a name='function.mb-encode-numericentity.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #2 <b>mb_encode_numericentity()</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;Convert&amp;nbsp;Left&amp;nbsp;side&amp;nbsp;of&amp;nbsp;ISO-8859-1&amp;nbsp;to&amp;nbsp;HTML&amp;nbsp;numeric&amp;nbsp;character&amp;nbsp;reference&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$convmap&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #0000BB'>0x80</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xff</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'>0xff</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_encode_numericentity</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$convmap</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ISO-8859-1'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Convert&amp;nbsp;user&amp;nbsp;defined&amp;nbsp;SJIS-win&amp;nbsp;code&amp;nbsp;in&amp;nbsp;block&amp;nbsp;95-104&amp;nbsp;to&amp;nbsp;numeric<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;string&amp;nbsp;reference&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$convmap&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0xe000</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xe03e</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x1040</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xffff</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'>0xe03f</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xe0bb</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x1041</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xffff</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'>0xe0bc</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xe0fa</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x1084</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xffff</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'>0xe0fb</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xe177</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x1085</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xffff</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'>0xe178</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xe1b6</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x10c8</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xffff</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'>0xe1b7</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xe233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x10c9</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xffff</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'>0xe234</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xe272</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x110c</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xffff</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'>0xe273</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xe2ef</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x110d</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xffff</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'>0xe2f0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xe32e</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x1150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xffff</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'>0xe32f</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xe3ab</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x1151</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xffff&amp;nbsp;</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_encode_numericentity</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$convmap</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sjis-win'</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.mb-encode-numericentity.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.mb-decode-numericentity.php' class='function' rel='rdfs-seeAlso'>mb_decode_numericentity()</a> - Decode HTML numeric string reference to character</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="mb_encode_mimeheader" value="<div id='function.mb-encode-mimeheader' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-encode-mimeheader.php'>mb_encode_mimeheader</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_encode_mimeheader</span> &amp;mdash; <span class='dc-title'>Encode string for MIME header</span></p> </div> <a name='function.mb-encode-mimeheader.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>mb_encode_mimeheader</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> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$transfer_encoding</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$linefeed</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$indent</tt></span> ]]]] )</div> <p class='para rdfs-comment'> Encodes a given <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> by the MIME header encoding scheme. </p> </div> <a name='function.mb-encode-mimeheader.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being encoded. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>charset</tt></i> specifies the name of the character set in which <i><tt class='parameter'>str</tt></i> is represented in. The default value is determined by the current NLS setting (<i>mbstring.language</i>). <a href='http://www.php.net/manual/en/function.mb-internal-encoding.php' class='function'>mb_internal_encoding()</a> should be set to same encoding. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>transfer_encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>transfer_encoding</tt></i> specifies the scheme of MIME encoding. It should be either <i>&amp;quot;B&amp;quot;</i> (Base64) or <i>&amp;quot;Q&amp;quot;</i> (Quoted-Printable). Falls back to <i>&amp;quot;B&amp;quot;</i> if not given. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>linefeed</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>linefeed</tt></i> specifies the EOL (end-of-line) marker with which <b>mb_encode_mimeheader()</b> performs line-folding (a <a href='http://www.faqs.org/rfcs/rfc2822' class='link external'>&amp;raquo; RFC</a> term, the act of breaking a line longer than a certain length into multiple lines. The length is currently hard-coded to 74 characters). Falls back to <i>&amp;quot;\r\n&amp;quot;</i> (CRLF) if not given. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>indent</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Indentation of the first line (number of characters in the header before <i><tt class='parameter'>str</tt></i> ). </p> </dd> </dl> <p> </p> </div> <a name='function.mb-encode-mimeheader.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A converted version of the <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> represented in ASCII. </p> </div> <a name='function.mb-encode-mimeheader.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'>indent</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mb-encode-mimeheader.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_encode_mimeheader()</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 />$name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;kanji<br /></span><span style='color: #0000BB'>$mbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'kru'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$doma&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'gtinn.mon'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$addr&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_encode_mimeheader</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UTF-7'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Q'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;lt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$mbox&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'@'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$doma&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$addr</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.mb-encode-mimeheader.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function isn&amp;#039;t designed to break lines at higher-level contextual break points (word boundaries, etc.). This behaviour may clutter up the original string with unexpected spaces. <br /> </p></blockquote> </div> <a name='function.mb-encode-mimeheader.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.mb-decode-mimeheader.php' class='function' rel='rdfs-seeAlso'>mb_decode_mimeheader()</a> - Decode string in MIME header field</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="mb_detect_order" value="<div id='function.mb-detect-order' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-detect-order.php'>mb_detect_order</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_detect_order</span> &amp;mdash; <span class='dc-title'>Set/Get character encoding detection order</span></p> </div> <a name='function.mb-detect-order.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>mb_detect_order</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'>$encoding_list</tt></span> ] )</div> <p class='para rdfs-comment'> Sets the automatic character encoding detection order to <i><tt class='parameter'>encoding_list</tt></i> . </p> </div> <a name='function.mb-detect-order.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'>encoding_list</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>encoding_list</tt></i> is an <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> or comma separated list of character encoding. (&amp;quot;auto&amp;quot; is expanded to &amp;quot;ASCII, JIS, UTF-8, EUC-JP, SJIS&amp;quot;) </p> <p class='para'> If <i><tt class='parameter'>encoding_list</tt></i> is omitted, it returns the current character encoding detection order as array. </p> <p class='para'> This setting affects <a href='http://www.php.net/manual/en/function.mb-detect-encoding.php' class='function'>mb_detect_encoding()</a> and <a href='http://www.php.net/manual/en/function.mb-send-mail.php' class='function'>mb_send_mail()</a>. </p> <p class='para'> <i>mbstring</i> currently implements the following encoding detection filters. If there is an invalid byte sequence for the following encodings, encoding detection will fail. </p> <span class='simpara'> <i>UTF-8</i>, <i>UTF-7</i>, <i>ASCII</i>, <i>EUC-JP</i>,<i>SJIS</i>, <i>eucJP-win</i>, <i>SJIS-win</i>, <i>JIS</i>, <i>ISO-2022-JP</i> </span> <p class='para'> For <i>ISO-8859-*</i>, <i>mbstring</i> always detects as <i>ISO-8859-*</i>. </p> <p class='para'> For <i>UTF-16</i>, <i>UTF-32</i>, <i>UCS2</i> and <i>UCS4</i>, encoding detection will fail always. </p> <p class='para'> </p><div class='example'> <p><b>Example #1 Useless detect order example</b></p> <div class='example-contents programlisting'> <div class='cdata'><pre> ; Always detect as ISO-8859-1 detect_order = ISO-8859-1, UTF-8 ; Always detect as UTF-8, since ASCII/UTF-7 values are ; valid for UTF-8 detect_order = UTF-8, ASCII, UTF-7 </pre></div> </div> </div><p> </p> </dd> </dl> <p> </p> </div> <a name='function.mb-detect-order.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.mb-detect-order.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #2 <b>mb_detect_order()</b> examples</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;detection&amp;nbsp;order&amp;nbsp;by&amp;nbsp;enumerated&amp;nbsp;list&amp;nbsp;*/<br /></span><span style='color: #0000BB'>mb_detect_order</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'eucjp-win,sjis-win,UTF-8'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Set&amp;nbsp;detection&amp;nbsp;order&amp;nbsp;by&amp;nbsp;array&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$ary</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'ASCII'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$ary</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'JIS'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$ary</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'EUC-JP'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>mb_detect_order</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ary</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Display&amp;nbsp;current&amp;nbsp;detection&amp;nbsp;order&amp;nbsp;*/<br /></span><span style='color: #007700'>echo&amp;nbsp;</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'>mb_detect_order</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.mb-detect-order.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.mb-internal-encoding.php' class='function' rel='rdfs-seeAlso'>mb_internal_encoding()</a> - Set/Get internal character encoding</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-http-input.php' class='function' rel='rdfs-seeAlso'>mb_http_input()</a> - Detect HTTP input character encoding</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-http-output.php' class='function' rel='rdfs-seeAlso'>mb_http_output()</a> - Set/Get HTTP output character encoding</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-send-mail.php' class='function' rel='rdfs-seeAlso'>mb_send_mail()</a> - Send encoded 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="mb_detect_encoding" value="<div id='function.mb-detect-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-detect-encoding.php'>mb_detect_encoding</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_detect_encoding</span> &amp;mdash; <span class='dc-title'>Detect character encoding</span></p> </div> <a name='function.mb-detect-encoding.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>mb_detect_encoding</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str</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'>$encoding_list</tt><span class='initializer'> = mb_detect_order()</span></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$strict</tt><span class='initializer'> = false</span></span> ]] )</div> <p class='para rdfs-comment'> Detects character encoding in <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> . </p> </div> <a name='function.mb-detect-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'>str</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being detected. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding_list</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>encoding_list</tt></i> is list of character encoding. Encoding order may be specified by array or comma separated list string. </p> <p class='para'> If <i><tt class='parameter'>encoding_list</tt></i> is omitted, detect_order is used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>strict</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>strict</tt></i> specifies whether to use the strict encoding detection or not. Default is <b><tt class='constant'>FALSE</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-detect-encoding.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The detected character encoding. </p> </div> <a name='function.mb-detect-encoding.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_detect_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 /></span><span style='color: #FF8000'>/*&amp;nbsp;Detect&amp;nbsp;character&amp;nbsp;encoding&amp;nbsp;with&amp;nbsp;current&amp;nbsp;detect_order&amp;nbsp;*/<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>mb_detect_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;'auto'&amp;nbsp;is&amp;nbsp;expanded&amp;nbsp;to&amp;nbsp;'ASCII,JIS,UTF-8,EUC-JP,SJIS'&amp;nbsp;*/<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>mb_detect_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'auto'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Specify&amp;nbsp;encoding_list&amp;nbsp;character&amp;nbsp;encoding&amp;nbsp;by&amp;nbsp;comma&amp;nbsp;separated&amp;nbsp;list&amp;nbsp;*/<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>mb_detect_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'JIS,&amp;nbsp;eucjp-win,&amp;nbsp;sjis-win'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Use&amp;nbsp;array&amp;nbsp;to&amp;nbsp;specify&amp;nbsp;encoding_list&amp;nbsp;&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$ary</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'ASCII'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$ary</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'JIS'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$ary</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'EUC-JP'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>mb_detect_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ary</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.mb-detect-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.mb-detect-order.php' class='function' rel='rdfs-seeAlso'>mb_detect_order()</a> - Set/Get character encoding detection order</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="mb_decode_numericentity" value="<div id='function.mb-decode-numericentity' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-decode-numericentity.php'>mb_decode_numericentity</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_decode_numericentity</span> &amp;mdash; <span class='dc-title'>Decode HTML numeric string reference to character</span></p> </div> <a name='function.mb-decode-numericentity.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>mb_decode_numericentity</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$convmap</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> )</div> <p class='para rdfs-comment'> Convert numeric string reference of <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> in a specified block to character. </p> </div> <a name='function.mb-decode-numericentity.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being decoded. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>convmap</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>convmap</tt></i> is an <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> that specifies the code area to convert. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-decode-numericentity.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The converted <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.mb-decode-numericentity.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <i><tt class='parameter'>convmap</tt></i> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> $convmap&amp;nbsp;=&amp;nbsp;array&amp;nbsp;(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;int&amp;nbsp;start_code1,&amp;nbsp;int&amp;nbsp;end_code1,&amp;nbsp;int&amp;nbsp;offset1,&amp;nbsp;int&amp;nbsp;mask1,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;int&amp;nbsp;start_code2,&amp;nbsp;int&amp;nbsp;end_code2,&amp;nbsp;int&amp;nbsp;offset2,&amp;nbsp;int&amp;nbsp;mask2,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;........<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;int&amp;nbsp;start_codeN,&amp;nbsp;int&amp;nbsp;end_codeN,&amp;nbsp;int&amp;nbsp;offsetN,&amp;nbsp;int&amp;nbsp;maskN&amp;nbsp;);<br />//&amp;nbsp;Specify&amp;nbsp;Unicode&amp;nbsp;value&amp;nbsp;for&amp;nbsp;start_codeN&amp;nbsp;and&amp;nbsp;end_codeN<br />//&amp;nbsp;Add&amp;nbsp;offsetN&amp;nbsp;to&amp;nbsp;value&amp;nbsp;and&amp;nbsp;take&amp;nbsp;bit-wise&amp;nbsp;'AND'&amp;nbsp;with&amp;nbsp;maskN,&amp;nbsp;<br />//&amp;nbsp;then&amp;nbsp;convert&amp;nbsp;value&amp;nbsp;to&amp;nbsp;numeric&amp;nbsp;string&amp;nbsp;reference.</span> </code></div> </div> </div><p> </p> </div> <a name='function.mb-decode-numericentity.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.mb-encode-numericentity.php' class='function' rel='rdfs-seeAlso'>mb_encode_numericentity()</a> - Encode character to HTML numeric string reference</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="mb_decode_mimeheader" value="<div id='function.mb-decode-mimeheader' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-decode-mimeheader.php'>mb_decode_mimeheader</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_decode_mimeheader</span> &amp;mdash; <span class='dc-title'>Decode string in MIME header field</span></p> </div> <a name='function.mb-decode-mimeheader.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>mb_decode_mimeheader</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str</tt></span> )</div> <p class='para rdfs-comment'> Decodes encoded-word <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> in MIME header. </p> </div> <a name='function.mb-decode-mimeheader.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being decoded. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-decode-mimeheader.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The decoded <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> in internal character encoding. </p> </div> <a name='function.mb-decode-mimeheader.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.mb-encode-mimeheader.php' class='function' rel='rdfs-seeAlso'>mb_encode_mimeheader()</a> - Encode string for MIME header</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="mb_convert_variables" value="<div id='function.mb-convert-variables' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-convert-variables.php'>mb_convert_variables</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_convert_variables</span> &amp;mdash; <span class='dc-title'>Convert character code in variable(s)</span></p> </div> <a name='function.mb-convert-variables.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>mb_convert_variables</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$to_encoding</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'>$from_encoding</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 reference'>&amp;amp;$vars</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 reference'>&amp;amp;$...</tt></span> ] )</div> <p class='para rdfs-comment'> Converts character encoding of variables <i><tt class='parameter'>vars</tt></i> in encoding <i><tt class='parameter'>from_encoding</tt></i> to encoding <i><tt class='parameter'>to_encoding</tt></i> . </p> <p class='para'> <b>mb_convert_variables()</b> join strings in Array or Object to detect encoding, since encoding detection tends to fail for short strings. Therefore, it is impossible to mix encoding in single array or object. </p> </div> <a name='function.mb-convert-variables.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_encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The encoding that the <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> is being converted to. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>from_encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>from_encoding</tt></i> is specified as an <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> or comma separated <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>, it tries to detect encoding from <i><tt class='parameter'>from-coding</tt></i> . When <i><tt class='parameter'>from_encoding</tt></i> is omitted, <i>detect_order</i> is used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>vars</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>vars</tt></i> is the reference to the variable being converted. String, Array and Object are accepted. <b>mb_convert_variables()</b> assumes all parameters have the same encoding. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>...</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Additional <i><tt class='parameter'>vars</tt></i> . </p> </dd> </dl> <p> </p> </div> <a name='function.mb-convert-variables.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The character encoding before conversion for success, or <b><tt class='constant'>FALSE</tt></b> for failure. </p> </div> <a name='function.mb-convert-variables.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_convert_variables()</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;Convert&amp;nbsp;variables&amp;nbsp;$post1,&amp;nbsp;$post2&amp;nbsp;to&amp;nbsp;internal&amp;nbsp;encoding&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$interenc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_internal_encoding</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$inputenc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_convert_variables</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$interenc</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ASCII,UTF-8,SJIS-win'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$post1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$post2</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="mb_convert_kana" value="<div id='function.mb-convert-kana' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-convert-kana.php'>mb_convert_kana</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_convert_kana</span> &amp;mdash; <span class='dc-title'>Convert &amp;quot;kana&amp;quot; one from another (&amp;quot;zen-kaku&amp;quot;, &amp;quot;han-kaku&amp;quot; and more)</span></p> </div> <a name='function.mb-convert-kana.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>mb_convert_kana</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'>$option</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> ]] )</div> <p class='para rdfs-comment'> Performs a &amp;quot;han-kaku&amp;quot; - &amp;quot;zen-kaku&amp;quot; conversion for <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> . This function is only useful for Japanese. </p> </div> <a name='function.mb-convert-kana.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being converted. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The conversion option. The default value is <i>&amp;quot;KV&amp;quot;</i>. </p> <p class='para'> Specify with a combination of following options. The default value is <i>KV</i>. </p><table class='doctable table'> <caption><b>Applicable Conversion Options</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Option</th> <th>Meaning</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><i>r</i></td> <td align='left'> Convert &amp;quot;zen-kaku&amp;quot; alphabets to &amp;quot;han-kaku&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>R</i></td> <td align='left'> Convert &amp;quot;han-kaku&amp;quot; alphabets to &amp;quot;zen-kaku&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>n</i></td> <td align='left'> Convert &amp;quot;zen-kaku&amp;quot; numbers to &amp;quot;han-kaku&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>N</i></td> <td align='left'> Convert &amp;quot;han-kaku&amp;quot; numbers to &amp;quot;zen-kaku&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>a</i></td> <td align='left'> Convert &amp;quot;zen-kaku&amp;quot; alphabets and numbers to &amp;quot;han-kaku&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>A</i></td> <td align='left'> Convert &amp;quot;han-kaku&amp;quot; alphabets and numbers to &amp;quot;zen-kaku&amp;quot; (Characters included in &amp;quot;a&amp;quot;, &amp;quot;A&amp;quot; options are U+0021 - U+007E excluding U+0022, U+0027, U+005C, U+007E) </td> </tr> <tr valign='middle'> <td align='left'><i>s</i></td> <td align='left'> Convert &amp;quot;zen-kaku&amp;quot; space to &amp;quot;han-kaku&amp;quot; (U+3000 -&amp;gt; U+0020) </td> </tr> <tr valign='middle'> <td align='left'><i>S</i></td> <td align='left'> Convert &amp;quot;han-kaku&amp;quot; space to &amp;quot;zen-kaku&amp;quot; (U+0020 -&amp;gt; U+3000) </td> </tr> <tr valign='middle'> <td align='left'><i>k</i></td> <td align='left'> Convert &amp;quot;zen-kaku kata-kana&amp;quot; to &amp;quot;han-kaku kata-kana&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>K</i></td> <td align='left'> Convert &amp;quot;han-kaku kata-kana&amp;quot; to &amp;quot;zen-kaku kata-kana&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>h</i></td> <td align='left'> Convert &amp;quot;zen-kaku hira-gana&amp;quot; to &amp;quot;han-kaku kata-kana&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>H</i></td> <td align='left'> Convert &amp;quot;han-kaku kata-kana&amp;quot; to &amp;quot;zen-kaku hira-gana&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>c</i></td> <td align='left'> Convert &amp;quot;zen-kaku kata-kana&amp;quot; to &amp;quot;zen-kaku hira-gana&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>C</i></td> <td align='left'> Convert &amp;quot;zen-kaku hira-gana&amp;quot; to &amp;quot;zen-kaku kata-kana&amp;quot; </td> </tr> <tr valign='middle'> <td align='left'><i>V</i></td> <td align='left'> Collapse voiced sound notation and convert them into a character. Use with &amp;quot;K&amp;quot;,&amp;quot;H&amp;quot; </td> </tr> </tbody> </table> <p> </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-convert-kana.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The converted <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.mb-convert-kana.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_convert_kana()</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;Convert&amp;nbsp;all&amp;nbsp;'kana'&amp;nbsp;to&amp;nbsp;'zen-kaku'&amp;nbsp;'kata-kana'&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_convert_kana</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'KVC'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Convert&amp;nbsp;'han-kaku'&amp;nbsp;'kata-kana'&amp;nbsp;to&amp;nbsp;'zen-kaku'&amp;nbsp;'kata-kana'&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;and&amp;nbsp;'zen-kaku'&amp;nbsp;alpha-numeric&amp;nbsp;to&amp;nbsp;'han-kaku'&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_convert_kana</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'KVa'</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="mb_convert_encoding" value="<div id='function.mb-convert-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-convert-encoding.php'>mb_convert_encoding</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_convert_encoding</span> &amp;mdash; <span class='dc-title'>Convert character encoding</span></p> </div> <a name='function.mb-convert-encoding.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>mb_convert_encoding</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'>$to_encoding</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'>$from_encoding</tt></span> ] )</div> <p class='para rdfs-comment'> Converts the character encoding of <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> <i><tt class='parameter'>str</tt></i> to <i><tt class='parameter'>to_encoding</tt></i> from optionally <i><tt class='parameter'>from_encoding</tt></i> . </p> </div> <a name='function.mb-convert-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'>str</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being encoded. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>to_encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The type of encoding that <i><tt class='parameter'>str</tt></i> is being converted to. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>from_encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Is specified by character code names before conversion. It is either an <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>, or a comma separated enumerated list. If <i><tt class='parameter'>from_encoding</tt></i> is not specified, the internal encoding will be used. </p> <p class='para'> &amp;quot;<i>auto</i>&amp;quot; may be used, which expands to <em class='emphasis'>&amp;quot;ASCII,JIS,UTF-8,EUC-JP,SJIS&amp;quot;</em>. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-convert-encoding.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The encoded <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.mb-convert-encoding.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_convert_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 /></span><span style='color: #FF8000'>/*&amp;nbsp;Convert&amp;nbsp;internal&amp;nbsp;character&amp;nbsp;encoding&amp;nbsp;to&amp;nbsp;SJIS&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_convert_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SJIS'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Convert&amp;nbsp;EUC-JP&amp;nbsp;to&amp;nbsp;UTF-7&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_convert_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UTF-7'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'EUC-JP'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Auto&amp;nbsp;detect&amp;nbsp;encoding&amp;nbsp;from&amp;nbsp;JIS,&amp;nbsp;eucjp-win,&amp;nbsp;sjis-win,&amp;nbsp;then&amp;nbsp;convert&amp;nbsp;str&amp;nbsp;to&amp;nbsp;UCS-2LE&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_convert_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UCS-2LE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'JIS,&amp;nbsp;eucjp-win,&amp;nbsp;sjis-win'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;'auto'&amp;nbsp;is&amp;nbsp;expanded&amp;nbsp;to&amp;nbsp;'ASCII,JIS,UTF-8,EUC-JP,SJIS'&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_convert_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'EUC-JP'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'auto'</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.mb-convert-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.mb-detect-order.php' class='function' rel='rdfs-seeAlso'>mb_detect_order()</a> - Set/Get character encoding detection order</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="mb_convert_case" value="<div id='function.mb-convert-case' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-convert-case.php'>mb_convert_case</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>mb_convert_case</span> &amp;mdash; <span class='dc-title'>Perform case folding on a string</span></p> </div> <a name='function.mb-convert-case.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>mb_convert_case</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'>$mode</tt><span class='initializer'> = MB_CASE_UPPER</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt><span class='initializer'> = mb_internal_encoding()</span></span> ] )</div> <p class='para rdfs-comment'> Performs case folding on a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>, converted in the way specified by <i><tt class='parameter'>mode</tt></i> . </p> </div> <a name='function.mb-convert-case.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being converted. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The mode of the conversion. It can be one of <b><tt class='constant'>MB_CASE_UPPER</tt></b>, <b><tt class='constant'>MB_CASE_LOWER</tt></b>, or <b><tt class='constant'>MB_CASE_TITLE</tt></b>. </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 is the character encoding. If it is omitted, the internal character encoding value will be used.</p> </dd> </dl> <p> </p> </div> <a name='function.mb-convert-case.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A case folded version of <i><tt class='parameter'>string</tt></i> converted in the way specified by <i><tt class='parameter'>mode</tt></i> . </p> </div> <a name='function.mb-convert-case.unicode'></a><div class='refsect1 unicode'> <h3 class='title'>Unicode</h3> <p class='para'> By contrast to the standard case folding functions such as <a href='http://www.php.net/manual/en/function.strtolower.php' class='function'>strtolower()</a> and <a href='http://www.php.net/manual/en/function.strtoupper.php' class='function'>strtoupper()</a>, case folding is performed on the basis of the Unicode character properties. Thus the behaviour of this function is not affected by locale settings and it can convert any characters that have &amp;#039;alphabetic&amp;#039; property, such as A-umlaut (&amp;Atilde;&amp;#132;). </p> <p class='para'> For more information about the Unicode properties, please see <a href='http://www.unicode.org/unicode/reports/tr21/' class='link external'>&amp;raquo; http://www.unicode.org/unicode/reports/tr21/</a>. </p> </div> <a name='function.mb-convert-case.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mb_convert_case()</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 />$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'mary&amp;nbsp;had&amp;nbsp;a&amp;nbsp;Little&amp;nbsp;lamb&amp;nbsp;and&amp;nbsp;she&amp;nbsp;loved&amp;nbsp;it&amp;nbsp;so'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_convert_case</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MB_CASE_UPPER</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Prints&amp;nbsp;MARY&amp;nbsp;HAD&amp;nbsp;A&amp;nbsp;LITTLE&amp;nbsp;LAMB&amp;nbsp;AND&amp;nbsp;SHE&amp;nbsp;LOVED&amp;nbsp;IT&amp;nbsp;SO<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mb_convert_case</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MB_CASE_TITLE</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UTF-8'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Prints&amp;nbsp;Mary&amp;nbsp;Had&amp;nbsp;A&amp;nbsp;Little&amp;nbsp;Lamb&amp;nbsp;And&amp;nbsp;She&amp;nbsp;Loved&amp;nbsp;It&amp;nbsp;So<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mb-convert-case.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.mb-strtolower.php' class='function' rel='rdfs-seeAlso'>mb_strtolower()</a> - Make a string lowercase</li> <li class='member'><a href='http://www.php.net/manual/en/function.mb-strtoupper.php' class='function' rel='rdfs-seeAlso'>mb_strtoupper()</a> - Make a string uppercase</li> <li class='member'><a href='http://www.php.net/manual/en/function.strtolower.php' class='function' rel='rdfs-seeAlso'>strtolower()</a> - Make a string lowercase</li> <li class='member'><a href='http://www.php.net/manual/en/function.strtoupper.php' class='function' rel='rdfs-seeAlso'>strtoupper()</a> - Make a string uppercase</li> <li class='member'><a href='http://www.php.net/manual/en/function.ucfirst.php' class='function' rel='rdfs-seeAlso'>ucfirst()</a> - Make a string's first character uppercase</li> <li class='member'><a href='http://www.php.net/manual/en/function.ucwords.php' class='function' rel='rdfs-seeAlso'>ucwords()</a> - Uppercase the first character of each word 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="mb_check_encoding" value="<div id='function.mb-check-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mb-check-encoding.php'>mb_check_encoding</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.4.3, PHP 5 &amp;gt;= 5.1.3)</p><p class='refpurpose'><span class='refname'>mb_check_encoding</span> &amp;mdash; <span class='dc-title'>Check if the string is valid for the specified encoding</span></p> </div> <a name='function.mb-check-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>mb_check_encoding</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$var</tt><span class='initializer'> = NULL</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt><span class='initializer'> = mb_internal_encoding()</span></span> ]] )</div> <p class='para rdfs-comment'> Checks if the specified byte stream is valid for the specified encoding. It is useful to prevent so-called &amp;quot;Invalid Encoding Attack&amp;quot;. </p> <p class='para'> </p> </div> <a name='function.mb-check-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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The byte stream to check. If it is omitted, this function checks all the input from the beginning of the request. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The expected encoding. </p> </dd> </dl> <p> </p> </div> <a name='function.mb-check-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> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="max" value="<div id='function.max' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.max.php'>max</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>max</span> &amp;mdash; <span class='dc-title'>Find highest value</span></p> </div> <a name='function.max.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>max</b></span> ( <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$values</tt></span> )</div> <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>max</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'>$value1</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'>$value2</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'>$value3...</tt></span> ] )</div> <p class='para rdfs-comment'> If the first and only parameter is an array, <b>max()</b> returns the highest value in that array. If at least two parameters are provided, <b>max()</b> returns the biggest of these values. </p> <blockquote><p><b class='note'>Note</b>: PHP will evaluate a non-numeric <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> as <i>0</i> if compared to <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a>, but still return the string if it&amp;#039;s seen as the numerically highest value. If multiple arguments evaluate to <i>0</i>, <b>max()</b> will return a numeric <i>0</i> if given, else the alphabetical highest string value will be returned. <br /> </p></blockquote> </div> <a name='function.max.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'>values</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array containing the values. </p> </dd> </dl> <p> </p> </div> <a name='function.max.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>max()</b> returns the numerically highest of the parameter values. </p> </div> <a name='function.max.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Example uses of <b>max()</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: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>max</span><span style='color: #007700'>(</span><span style='color: #0000BB'>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: #0000BB'>5</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>6</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>7</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;7<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>max</span><span style='color: #007700'>(array(</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</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<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>max</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'hello'</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;0<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>max</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'hello'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;hello<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>max</span><span style='color: #007700'>(-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'hello'</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;hello<br /><br />//&amp;nbsp;With&amp;nbsp;multiple&amp;nbsp;arrays,&amp;nbsp;max&amp;nbsp;compares&amp;nbsp;from&amp;nbsp;left&amp;nbsp;to&amp;nbsp;right<br />//&amp;nbsp;so&amp;nbsp;in&amp;nbsp;our&amp;nbsp;example:&amp;nbsp;2&amp;nbsp;==&amp;nbsp;2,&amp;nbsp;but&amp;nbsp;4&amp;nbsp;&amp;lt;&amp;nbsp;5<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>max</span><span style='color: #007700'>(array(</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>8</span><span style='color: #007700'>),&amp;nbsp;array(</span><span style='color: #0000BB'>2</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'>7</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;array(2,&amp;nbsp;5,&amp;nbsp;7)<br /><br />//&amp;nbsp;If&amp;nbsp;both&amp;nbsp;an&amp;nbsp;array&amp;nbsp;and&amp;nbsp;non-array&amp;nbsp;are&amp;nbsp;given,&amp;nbsp;the&amp;nbsp;array<br />//&amp;nbsp;is&amp;nbsp;always&amp;nbsp;returned&amp;nbsp;as&amp;nbsp;it's&amp;nbsp;seen&amp;nbsp;as&amp;nbsp;the&amp;nbsp;largest<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>max</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'string'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #0000BB'>2</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'>7</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>42</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;array(2,&amp;nbsp;5,&amp;nbsp;7)<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.max.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.min.php' class='function' rel='rdfs-seeAlso'>min()</a> - Find lowest value</li> <li class='member'><a href='http://www.php.net/manual/en/function.count.php' class='function' rel='rdfs-seeAlso'>count()</a> - Count all elements in an array, or properties in an object</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="mail" value="<div id='function.mail' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mail.php'>mail</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>mail</span> &amp;mdash; <span class='dc-title'>Send mail</span></p> </div> <a name='function.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>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> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$additional_parameters</tt></span> ]] )</div> <p class='para rdfs-comment'> Sends an email. </p> </div> <a name='function.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'> Receiver, or receivers of the mail. </p> <p class='para'> The formatting of this string must comply with <a href='http://www.faqs.org/rfcs/rfc2822' class='link external'>&amp;raquo; RFC 2822</a>. Some examples are: </p><ul class='simplelist'> <li class='member'>user@example.com</li> <li class='member'>user@example.com, anotheruser@example.com</li> <li class='member'>User &amp;lt;user@example.com&amp;gt;</li> <li class='member'>User &amp;lt;user@example.com&amp;gt;, Another User &amp;lt;anotheruser@example.com&amp;gt;</li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>subject</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Subject of the email to be sent. </p> <div class='caution'><b class='caution'>Caution</b> <p class='para'> Subject must satisfy <a href='http://www.faqs.org/rfcs/rfc2047' class='link external'>&amp;raquo; RFC 2047</a>. </p> </div> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>message</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Message to be sent. </p> <p class='para'> Each line should be separated with a LF (\n). Lines should not be larger than 70 characters. </p> <div class='caution'><b class='caution'>Caution</b> <p class='para'> (Windows only) When PHP is talking to a SMTP server directly, if a full stop is found on the start of a line, it is removed. To counter-act this, replace these occurrences with a double dot. </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: #0000BB'>str_replace</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'\n.'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\n..'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <p> </p> </div> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>additional_headers</tt></i> (optional)</span> </dt><dd class='listitem'> <p class='para'> String to be inserted at the end of the email header. </p> <p class='para'> This is typically used to add extra headers (From, Cc, and Bcc). Multiple extra headers should be separated with a CRLF (\r\n). </p> <blockquote><p><b class='note'>Note</b>: When sending mail, the mail <em class='emphasis'>must</em> contain a <i>From</i> header. This can be set with the <i><tt class='parameter'>additional_headers</tt></i> parameter, or a default can be set in <var class='filename'>php.ini</var>. <br /> Failing to do this will result in an error message similar to <i>Warning: mail(): &amp;quot;sendmail_from&amp;quot; not set in php.ini or custom &amp;quot;From:&amp;quot; header missing</i>. The <i>From</i> header sets also <i>Return-Path</i> under Windows. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: If messages are not received, try using a LF (\n) only. Some poor quality Unix mail transfer agents replace LF by CRLF automatically (which leads to doubling CR if CRLF is used). This should be a last resort, as it does not comply with <a href='http://www.faqs.org/rfcs/rfc2822' class='link external'>&amp;raquo; RFC 2822</a>. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>additional_parameters</tt></i> (optional)</span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>additional_parameters</tt></i> parameter can be used to pass additional flags as command line options to the program configured to be used when sending mail, as defined by the <i>sendmail_path</i> configuration setting. For example, this can be used to set the envelope sender address when using sendmail with the <i>-f</i> sendmail option. </p> <p class='para'> The user that the webserver runs as should be added as a trusted user to the sendmail configuration to prevent a &amp;#039;X-Warning&amp;#039; header from being added to the message when the envelope sender (-f) is set using this method. For sendmail users, this file is <var class='filename'>/etc/mail/trusted-users</var>. </p> </dd> </dl> <p> </p> </div> <a name='function.mail.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 mail was successfully accepted for delivery, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> <p class='para'> It is important to note that just because the mail was accepted for delivery, it does NOT mean the mail will actually reach the intended destination. </p> </div> <a name='function.mail.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 (Windows only)</td> <td align='left'> All custom headers (like From, Cc, Bcc and Date) are supported, and are not case-sensitive. (As custom headers are not interpreted by the MTA in the first place, but are parsed by PHP, PHP &amp;lt; 4.3 only supported the Cc header element and was case-sensitive). </td> </tr> <tr valign='middle'> <td align='left'>4.2.3</td> <td align='left'> The <i><tt class='parameter'>additional_parameters</tt></i> parameter is disabled in <a href='http://www.php.net/manual/en/ini.sect.safe-mode.php#ini.safe-mode' class='link'>safe_mode</a> and the <b>mail()</b> function will expose a warning message and return <b><tt class='constant'>FALSE</tt></b> when used. </td> </tr> <tr valign='middle'> <td align='left'>4.0.5</td> <td align='left'> The <i><tt class='parameter'>additional_parameters</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mail.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Sending mail.</b></p> <div class='example-contents para'><p> Using <b>mail()</b> to send a simple email: </p></div> <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;The&amp;nbsp;message<br /></span><span style='color: #0000BB'>$message&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Line&amp;nbsp;1\nLine&amp;nbsp;2\nLine&amp;nbsp;3'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;In&amp;nbsp;case&amp;nbsp;any&amp;nbsp;of&amp;nbsp;our&amp;nbsp;lines&amp;nbsp;are&amp;nbsp;larger&amp;nbsp;than&amp;nbsp;70&amp;nbsp;characters,&amp;nbsp;we&amp;nbsp;should&amp;nbsp;use&amp;nbsp;wordwrap()<br /></span><span style='color: #0000BB'>$message&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>wordwrap</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$message</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>70</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Send<br /></span><span style='color: #0000BB'>mail</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'caffeinated@example.com'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'My&amp;nbsp;Subject'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$message</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Sending mail with extra headers.</b></p> <div class='example-contents para'><p> The addition of basic headers, telling the MUA the From and Reply-To addresses: </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$to&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'nobody@example.com'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$subject&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'the&amp;nbsp;subject'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$message&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'hello'</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: #DD0000'>'From:&amp;nbsp;webmaster@example.com'&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;</span><span style='color: #DD0000'>'Reply-To:&amp;nbsp;webmaster@example.com'&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;</span><span style='color: #DD0000'>'X-Mailer:&amp;nbsp;PHP/'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>phpversion</span><span style='color: #007700'>();<br /><br /></span><span style='color: #0000BB'>mail</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$to</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$subject</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$message</span><span style='color: #007700'>,&amp;nbsp;</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><p> </p><div class='example'> <p><b>Example #3 Sending mail with an additional command line parameter.</b></p> <div class='example-contents para'><p> The <i><tt class='parameter'>additional_parameters</tt></i> parameter can be used to pass an additional parameter to the program configured to use when sending mail using the <i>sendmail_path</i>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />mail</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'nobody@example.com'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'the&amp;nbsp;subject'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'the&amp;nbsp;message'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>null</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'-fwebmaster@example.com'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #4 Sending HTML email</b></p> <div class='example-contents para'><p> It is also possible to send HTML email with <b>mail()</b>. </p></div> <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;multiple&amp;nbsp;recipients<br /></span><span style='color: #0000BB'>$to&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'aidan@example.com'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>',&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;note&amp;nbsp;the&amp;nbsp;comma<br /></span><span style='color: #0000BB'>$to&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'wez@example.com'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;subject<br /></span><span style='color: #0000BB'>$subject&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Birthday&amp;nbsp;Reminders&amp;nbsp;for&amp;nbsp;August'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;message<br /></span><span style='color: #0000BB'>$message&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'<br />&amp;lt;html&amp;gt;<br />&amp;lt;head&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;title&amp;gt;Birthday&amp;nbsp;Reminders&amp;nbsp;for&amp;nbsp;August&amp;lt;/title&amp;gt;<br />&amp;lt;/head&amp;gt;<br />&amp;lt;body&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;p&amp;gt;Here&amp;nbsp;are&amp;nbsp;the&amp;nbsp;birthdays&amp;nbsp;upcoming&amp;nbsp;in&amp;nbsp;August!&amp;lt;/p&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;table&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;tr&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;th&amp;gt;Person&amp;lt;/th&amp;gt;&amp;lt;th&amp;gt;Day&amp;lt;/th&amp;gt;&amp;lt;th&amp;gt;Month&amp;lt;/th&amp;gt;&amp;lt;th&amp;gt;Year&amp;lt;/th&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/tr&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;tr&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;td&amp;gt;Joe&amp;lt;/td&amp;gt;&amp;lt;td&amp;gt;3rd&amp;lt;/td&amp;gt;&amp;lt;td&amp;gt;August&amp;lt;/td&amp;gt;&amp;lt;td&amp;gt;1970&amp;lt;/td&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/tr&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;tr&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;td&amp;gt;Sally&amp;lt;/td&amp;gt;&amp;lt;td&amp;gt;17th&amp;lt;/td&amp;gt;&amp;lt;td&amp;gt;August&amp;lt;/td&amp;gt;&amp;lt;td&amp;gt;1973&amp;lt;/td&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/tr&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;lt;/table&amp;gt;<br />&amp;lt;/body&amp;gt;<br />&amp;lt;/html&amp;gt;<br />'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;To&amp;nbsp;send&amp;nbsp;HTML&amp;nbsp;mail,&amp;nbsp;the&amp;nbsp;Content-type&amp;nbsp;header&amp;nbsp;must&amp;nbsp;be&amp;nbsp;set<br /></span><span style='color: #0000BB'>$headers&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'MIME-Version:&amp;nbsp;1.0'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\r\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: #DD0000'>'Content-type:&amp;nbsp;text/html;&amp;nbsp;charset=iso-8859-1'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\r\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Additional&amp;nbsp;headers<br /></span><span style='color: #0000BB'>$headers&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'To:&amp;nbsp;Mary&amp;nbsp;&amp;lt;mary@example.com&amp;gt;,&amp;nbsp;Kelly&amp;nbsp;&amp;lt;kelly@example.com&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\r\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: #DD0000'>'From:&amp;nbsp;Birthday&amp;nbsp;Reminder&amp;nbsp;&amp;lt;birthday@example.com&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\r\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: #DD0000'>'Cc:&amp;nbsp;birthdayarchive@example.com'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\r\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: #DD0000'>'Bcc:&amp;nbsp;birthdaycheck@example.com'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\r\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Mail&amp;nbsp;it<br /></span><span style='color: #0000BB'>mail</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$to</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$subject</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$message</span><span style='color: #007700'>,&amp;nbsp;</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> </p><blockquote><p><b class='note'>Note</b>: If intending to send HTML or otherwise Complex mails, it is recommended to use the PEAR package <a href='http://pear.php.net/package/Mail_Mime' class='link external'>&amp;raquo; PEAR::Mail_Mime</a>. <br /> </p></blockquote><p> </p></div> </div><p> </p> </div> <a name='function.mail.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The Windows implementation of <b>mail()</b> differs in many ways from the Unix implementation. First, it doesn&amp;#039;t use a local binary for composing messages but only operates on direct sockets which means a <i>MTA</i> is needed listening on a network socket (which can either on the localhost or a remote machine). <br /> Second, the custom headers like <i>From:</i>, <i>Cc:</i>, <i>Bcc:</i> and <i>Date:</i> are <em class='emphasis'>not</em> interpreted by the <i>MTA</i> in the first place, but are parsed by PHP. <br /> As such, the <i><tt class='parameter'>to</tt></i> parameter should not be an address in the form of &amp;quot;Something &amp;lt;someone@example.com&amp;gt;&amp;quot;. The mail command may not parse this properly while talking with the MTA. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: Email with attachments and special types of content (e.g. HTML) can be sent using this function. This is accomplished via MIME-encoding - for more information, see this <a href='http://www.zend.com/zend/spotlight/sendmimeemailpart1.php' class='link external'>&amp;raquo; Zend article</a> or the <a href='http://pear.php.net/package/Mail_Mime' class='link external'>&amp;raquo; PEAR Mime Classes</a>. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: It is worth noting that the <b>mail()</b> function is not suitable for larger volumes of email in a loop. This function opens and closes an SMTP socket for each email, which is not very efficient. <br /> For the sending of large amounts of email, see the <a href='http://pear.php.net/package/Mail' class='link external'>&amp;raquo; PEAR::Mail</a>, and <a href='http://pear.php.net/package/Mail_Queue' class='link external'>&amp;raquo; PEAR::Mail_Queue</a> packages. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: The following RFCs may be useful: <a href='http://www.faqs.org/rfcs/rfc1896' class='link external'>&amp;raquo; RFC 1896</a>, <a href='http://www.faqs.org/rfcs/rfc2045' class='link external'>&amp;raquo; RFC 2045</a>, <a href='http://www.faqs.org/rfcs/rfc2046' class='link external'>&amp;raquo; RFC 2046</a>, <a href='http://www.faqs.org/rfcs/rfc2047' class='link external'>&amp;raquo; RFC 2047</a>, <a href='http://www.faqs.org/rfcs/rfc2048' class='link external'>&amp;raquo; RFC 2048</a>, <a href='http://www.faqs.org/rfcs/rfc2049' class='link external'>&amp;raquo; RFC 2049</a>, and <a href='http://www.faqs.org/rfcs/rfc2822' class='link external'>&amp;raquo; RFC 2822</a>. <br /> </p></blockquote> </div> <a name='function.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.imap-mail.php' class='function' rel='rdfs-seeAlso'>imap_mail()</a> - Send an email message</li> <li class='member'><a href='http://pear.php.net/package/Mail' class='link external'>&amp;raquo; PEAR::Mail</a></li> <li class='member'><a href='http://pear.php.net/package/Mail_Mime' class='link external'>&amp;raquo; PEAR::Mail_Mime</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="magic_quotes_runtime" value="<div id='function.magic-quotes-runtime' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.magic-quotes-runtime.php'>magic_quotes_runtime</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>magic_quotes_runtime</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.set-magic-quotes-runtime.php' class='function'>set_magic_quotes_runtime()</a></span></p> </div> <a name='function.magic-quotes-runtime.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.set-magic-quotes-runtime.php' class='function'>set_magic_quotes_runtime()</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="ltrim" value="<div id='function.ltrim' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ltrim.php'>ltrim</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ltrim</span> &amp;mdash; <span class='dc-title'>Strip whitespace (or other characters) from the beginning of a string</span></p> </div> <a name='function.ltrim.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>ltrim</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'>$charlist</tt></span> ] )</div> <p class='para rdfs-comment'> Strip whitespace (or other characters) from the beginning of a string. </p> </div> <a name='function.ltrim.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 input string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charlist</tt></i> </span> </dt><dd class='listitem'> <p class='para'> You can also specify the characters you want to strip, by means of the <i><tt class='parameter'>charlist</tt></i> parameter. Simply list all characters that you want to be stripped. With <i>..</i> you can specify a range of characters. </p> </dd> </dl> <p> </p> </div> <a name='function.ltrim.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> This function returns a string with whitespace stripped from the beginning of <i><tt class='parameter'>str</tt></i> . Without the second parameter, <b>ltrim()</b> will strip these characters: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> &amp;quot; &amp;quot; (<acronym title='American Standard Code for Information Interchange'>ASCII</acronym> <i>32</i> (<i>0x20</i>)), an ordinary space. </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;\t&amp;quot; (<acronym title='American Standard Code for Information Interchange'>ASCII</acronym> <i>9</i> (<i>0x09</i>)), a tab. </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;\n&amp;quot; (<acronym title='American Standard Code for Information Interchange'>ASCII</acronym> <i>10</i> (<i>0x0A</i>)), a new line (line feed). </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;\r&amp;quot; (<acronym title='American Standard Code for Information Interchange'>ASCII</acronym> <i>13</i> (<i>0x0D</i>)), a carriage return. </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;\0&amp;quot; (<acronym title='American Standard Code for Information Interchange'>ASCII</acronym> <i>0</i> (<i>0x00</i>)), the <i>NUL</i>-byte. </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;\x0B&amp;quot; (<acronym title='American Standard Code for Information Interchange'>ASCII</acronym> <i>11</i> (<i>0x0B</i>)), a vertical tab. </span> </li> </ul><p> </p> </div> <a name='function.ltrim.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 <i><tt class='parameter'>charlist</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ltrim.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Usage example of <b>ltrim()</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 />$text&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'\t\tThese&amp;nbsp;are&amp;nbsp;a&amp;nbsp;few&amp;nbsp;words&amp;nbsp;:)&amp;nbsp;...&amp;nbsp;&amp;nbsp;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$binary&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'\x09Example&amp;nbsp;string\x0A'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hello&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Hello&amp;nbsp;World'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$binary</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$hello</span><span style='color: #007700'>);<br /><br />print&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /><br /></span><span style='color: #0000BB'>$trimmed&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ltrim</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$trimmed</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$trimmed&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ltrim</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;\t.'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$trimmed</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$trimmed&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ltrim</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$hello</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Hdle'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$trimmed</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;trim&amp;nbsp;the&amp;nbsp;ASCII&amp;nbsp;control&amp;nbsp;characters&amp;nbsp;at&amp;nbsp;the&amp;nbsp;beginning&amp;nbsp;of&amp;nbsp;$binary<br />//&amp;nbsp;(from&amp;nbsp;0&amp;nbsp;to&amp;nbsp;31&amp;nbsp;inclusive)<br /></span><span style='color: #0000BB'>$clean&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ltrim</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$binary</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\x00..\x1F'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$clean</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> string(32) &amp;quot; These are a few words :) ... &amp;quot; string(16) &amp;quot; Example string &amp;quot; string(11) &amp;quot;Hello World&amp;quot; string(30) &amp;quot;These are a few words :) ... &amp;quot; string(30) &amp;quot;These are a few words :) ... &amp;quot; string(7) &amp;quot;o World&amp;quot; string(15) &amp;quot;Example string &amp;quot; </pre></div> </div> </div><p> </p> </div> <a name='function.ltrim.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.trim.php' class='function' rel='rdfs-seeAlso'>trim()</a> - Strip whitespace (or other characters) from the beginning and end of a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.rtrim.php' class='function' rel='rdfs-seeAlso'>rtrim()</a> - Strip whitespace (or other characters) from the end of 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="lstat" value="<div id='function.lstat' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.lstat.php'>lstat</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>lstat</span> &amp;mdash; <span class='dc-title'>Gives information about a file or symbolic link</span></p> </div> <a name='function.lstat.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>lstat</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Gathers the statistics of the file or symbolic link named by <i><tt class='parameter'>filename</tt></i> . </p> </div> <a name='function.lstat.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 a file or a symbolic link. </p> </dd> </dl> <p> </p> </div> <a name='function.lstat.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> See the manual page for <a href='http://www.php.net/manual/en/function.stat.php' class='function'>stat()</a> for information on the structure of the array that <b>lstat()</b> returns. This function is identical to the <a href='http://www.php.net/manual/en/function.stat.php' class='function'>stat()</a> function except that if the <i><tt class='parameter'>filename</tt></i> parameter is a symbolic link, the status of the symbolic link is returned, not the status of the file pointed to by the symbolic link. </p> </div> <a name='function.lstat.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Comparison of <a href='http://www.php.net/manual/en/function.stat.php' class='function'>stat()</a> and <b>lstat()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />symlink</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'uploads.php'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'uploads'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Contrast&amp;nbsp;information&amp;nbsp;for&amp;nbsp;uploads.php&amp;nbsp;and&amp;nbsp;uploads<br /></span><span style='color: #0000BB'>array_diff</span><span style='color: #007700'>(</span><span style='color: #0000BB'>stat</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'uploads'</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>lstat</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'uploads'</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 para'><p> Information that differs between the two files. </p></div> <div class='example-contents screen'> <div class='cdata'><pre> Array ( [ino] =&amp;gt; 97236376 [mode] =&amp;gt; 33188 [size] =&amp;gt; 34 [atime] =&amp;gt; 1223580003 [mtime] =&amp;gt; 1223581848 [ctime] =&amp;gt; 1223581848 [blocks] =&amp;gt; 8 ) </pre></div> </div> </div><p> </p> </div> <a name='function.lstat.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The results of this function are cached. See <a href='http://www.php.net/manual/en/function.clearstatcache.php' class='function'>clearstatcache()</a> for more details.</span></p></blockquote> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>As of PHP 5.0.0, this function can also be used with <em class='emphasis'>some</em> URL wrappers. Refer to <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for a listing of which wrappers support <a href='http://www.php.net/manual/en/function.stat.php' class='function'>stat()</a> family of functionality.</p></div> </div> <a name='function.lstat.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.stat.php' class='function' rel='rdfs-seeAlso'>stat()</a> - Gives information about a file</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="long2ip" value="<div id='function.long2ip' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.long2ip.php'>long2ip</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>long2ip</span> &amp;mdash; <span class='dc-title'>Converts an (IPv4) Internet network address into a string in Internet standard dotted format</span></p> </div> <a name='function.long2ip.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>long2ip</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$proper_address</tt></span> )</div> <p class='para rdfs-comment'> The function <b>long2ip()</b> generates an Internet address in dotted format (i.e.: aaa.bbb.ccc.ddd) from the proper address representation. </p> </div> <a name='function.long2ip.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'>proper_address</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A proper address representation. </p> </dd> </dl> <p> </p> </div> <a name='function.long2ip.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the Internet IP address as a string. </p> </div> <a name='function.long2ip.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.ip2long.php' class='function' rel='rdfs-seeAlso'>ip2long()</a> - Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address</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="LogicException" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.logicexception.php'>The LogicException class</a></h1> <div class='partintro'> <div id='logicexception.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> Exception thrown if a logic expression is invalid </p> </div> <div id='logicexception.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>LogicException</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>LogicException</b> </span> <span class='ooclass'> <span class='modifier'>extends</span> <a href='http://www.php.net/manual/en/class.exception.php' class='classname'>Exception</a> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Inherited methods */</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getmessage.php' class='function'>Exception::getMessage</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>Exception</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getprevious.php' class='function'>Exception::getPrevious</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getcode.php' class='function'>Exception::getCode</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getfile.php' class='function'>Exception::getFile</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getline.php' class='function'>Exception::getLine</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>array</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.gettrace.php' class='function'>Exception::getTrace</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.gettraceasstring.php' class='function'>Exception::getTraceAsString</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.tostring.php' class='function'>Exception::__toString</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>private</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.clone.php' class='function'>Exception::__clone</a></span> ( <span class='methodparam'>void</span> )</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="log10" value="<div id='function.log10' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.log10.php'>log10</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>log10</span> &amp;mdash; <span class='dc-title'>Base-10 logarithm</span></p> </div> <a name='function.log10.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>float</span> <span class='methodname'><b>log10</b></span> ( <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$arg</tt></span> )</div> <p class='para rdfs-comment'> Returns the base-10 logarithm of <i><tt class='parameter'>arg</tt></i> . </p> </div> <a name='function.log10.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'>arg</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The argument to process </p> </dd> </dl> <p> </p> </div> <a name='function.log10.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The base-10 logarithm of <i><tt class='parameter'>arg</tt></i> </p> </div> <a name='function.log10.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.log.php' class='function' rel='rdfs-seeAlso'>log()</a> - Natural logarithm</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="log" value="<div id='function.log' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.log.php'>log</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>log</span> &amp;mdash; <span class='dc-title'>Natural logarithm</span></p> </div> <a name='function.log.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>float</span> <span class='methodname'><b>log</b></span> ( <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$arg</tt></span> [, <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$base</tt><span class='initializer'> = M_E</span></span> ] )</div> <p class='para rdfs-comment'> If the optional <i><tt class='parameter'>base</tt></i> parameter is specified, <b>log()</b> returns log<sub class='subscript'>base</sub> <i><tt class='parameter'>arg</tt></i> , otherwise <b>log()</b> returns the natural logarithm of <i><tt class='parameter'>arg</tt></i> . </p> </div> <a name='function.log.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'>arg</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value to calculate the logarithm for </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>base</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional logarithmic base to use (defaults to &amp;#039;e&amp;#039; and so to the natural logarithm). </p> </dd> </dl> <p> </p> </div> <a name='function.log.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The logarithm of <i><tt class='parameter'>arg</tt></i> to <i><tt class='parameter'>base</tt></i> , if given, or the natural logarithm. </p> </div> <a name='function.log.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 optional parameter <i><tt class='parameter'>base</tt></i> became available. For older versions you can calculate the logarithm in base <i>b</i> of a number <i>n</i>, but using the mathematical identity: log<sub class='subscript'>b</sub>(n) = log(n)/log(b), where log is the neperian (or natural) logarithm. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.log.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.log10.php' class='function' rel='rdfs-seeAlso'>log10()</a> - Base-10 logarithm</li> <li class='member'><a href='http://www.php.net/manual/en/function.exp.php' class='function' rel='rdfs-seeAlso'>exp()</a> - Calculates the exponent of e</li> <li class='member'><a href='http://www.php.net/manual/en/function.pow.php' class='function' rel='rdfs-seeAlso'>pow()</a> - Exponential expression</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="localtime" value="<div id='function.localtime' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.localtime.php'>localtime</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>localtime</span> &amp;mdash; <span class='dc-title'>Get the local time</span></p> </div> <a name='function.localtime.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>localtime</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timestamp</tt><span class='initializer'> = time()</span></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$is_associative</tt><span class='initializer'> = false</span></span> ]] )</div> <p class='para rdfs-comment'> The <b>localtime()</b> function returns an array identical to that of the structure returned by the C function call. </p> </div> <a name='function.localtime.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'> The optional <i><tt class='parameter'>timestamp</tt></i> parameter is an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> Unix timestamp that defaults to the current local time if a <i><tt class='parameter'>timestamp</tt></i> is not given. In other words, it defaults to the value of <a href='http://www.php.net/manual/en/function.time.php' class='function'>time()</a>. </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>is_associative</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If set to <b><tt class='constant'>FALSE</tt></b> or not supplied then the array is returned as a regular, numerically indexed array. If the argument is set to <b><tt class='constant'>TRUE</tt></b> then <b>localtime()</b> returns an associative array containing all the different elements of the structure returned by the C function call to localtime. The names of the different keys of the associative array are as follows: </p> <p class='para'> </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> &amp;quot;tm_sec&amp;quot; - seconds </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;tm_min&amp;quot; - minutes </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;tm_hour&amp;quot; - hour </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;tm_mday&amp;quot; - day of the month </span> <span class='simpara'> Months are from 0 (Jan) to 11 (Dec) and days of the week are from 0 (Sun) to 6 (Sat). </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;tm_mon&amp;quot; - month of the year, starting with 0 for January </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;tm_year&amp;quot; - Years since 1900 </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;tm_wday&amp;quot; - Day of the week </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;tm_yday&amp;quot; - Day of the year </span> </li> <li class='listitem'> <span class='simpara'> &amp;quot;tm_isdst&amp;quot; - Is daylight savings time in effect </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.localtime.errors'></a><div class='refsect1 errors'> <h3 class='title'>Errors/Exceptions</h3> <p class='para'> Every call to a date/time function will generate a <b><tt class='constant'>E_NOTICE</tt></b> if the time zone is not valid, and/or a <b><tt class='constant'>E_STRICT</tt></b> or <b><tt class='constant'>E_WARNING</tt></b> message if using the system settings or the <var class='varname'>TZ</var> environment variable. See also <a href='http://www.php.net/manual/en/function.date-default-timezone-set.php' class='function'>date_default_timezone_set()</a></p> </div> <a name='function.localtime.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.1.0</td><td align='left'><p class='para'> Now issues the <b><tt class='constant'>E_STRICT</tt></b> and <b><tt class='constant'>E_NOTICE</tt></b> time zone errors.</p></td></tr> </tbody> </table> <p> </p> </div> <a name='function.localtime.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>localtime()</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 />$localtime&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>localtime</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$localtime_assoc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>localtime</span><span style='color: #007700'>(</span><span style='color: #0000BB'>time</span><span style='color: #007700'>(),&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$localtime</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$localtime_assoc</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 ( [0] =&amp;gt; 24 [1] =&amp;gt; 3 [2] =&amp;gt; 19 [3] =&amp;gt; 3 [4] =&amp;gt; 3 [5] =&amp;gt; 105 [6] =&amp;gt; 0 [7] =&amp;gt; 92 [8] =&amp;gt; 1 ) Array ( [tm_sec] =&amp;gt; 24 [tm_min] =&amp;gt; 3 [tm_hour] =&amp;gt; 19 [tm_mday] =&amp;gt; 3 [tm_mon] =&amp;gt; 3 [tm_year] =&amp;gt; 105 [tm_wday] =&amp;gt; 0 [tm_yday] =&amp;gt; 92 [tm_isdst] =&amp;gt; 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="localeconv" value="<div id='function.localeconv' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.localeconv.php'>localeconv</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>localeconv</span> &amp;mdash; <span class='dc-title'>Get numeric formatting information</span></p> </div> <a name='function.localeconv.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>localeconv</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns an associative array containing localized numeric and monetary formatting information. </p> </div> <a name='function.localeconv.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>localeconv()</b> returns data based upon the current locale as set by <a href='http://www.php.net/manual/en/function.setlocale.php' class='function'>setlocale()</a>. The associative array that is returned contains the following fields: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Array element</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>decimal_point</td> <td align='left'>Decimal point character</td> </tr> <tr valign='middle'> <td align='left'>thousands_sep</td> <td align='left'>Thousands separator</td> </tr> <tr valign='middle'> <td align='left'>grouping</td> <td align='left'>Array containing numeric groupings</td> </tr> <tr valign='middle'> <td align='left'>int_curr_symbol</td> <td align='left'>International currency symbol (i.e. USD)</td> </tr> <tr valign='middle'> <td align='left'>currency_symbol</td> <td align='left'>Local currency symbol (i.e. $)</td> </tr> <tr valign='middle'> <td align='left'>mon_decimal_point</td> <td align='left'>Monetary decimal point character</td> </tr> <tr valign='middle'> <td align='left'>mon_thousands_sep</td> <td align='left'>Monetary thousands separator</td> </tr> <tr valign='middle'> <td align='left'>mon_grouping</td> <td align='left'>Array containing monetary groupings</td> </tr> <tr valign='middle'> <td align='left'>positive_sign</td> <td align='left'>Sign for positive values</td> </tr> <tr valign='middle'> <td align='left'>negative_sign</td> <td align='left'>Sign for negative values</td> </tr> <tr valign='middle'> <td align='left'>int_frac_digits</td> <td align='left'>International fractional digits</td> </tr> <tr valign='middle'> <td align='left'>frac_digits</td> <td align='left'>Local fractional digits</td> </tr> <tr valign='middle'> <td align='left'>p_cs_precedes</td> <td align='left'> <b><tt class='constant'>TRUE</tt></b> if currency_symbol precedes a positive value, <b><tt class='constant'>FALSE</tt></b> if it succeeds one </td> </tr> <tr valign='middle'> <td align='left'>p_sep_by_space</td> <td align='left'> <b><tt class='constant'>TRUE</tt></b> if a space separates currency_symbol from a positive value, <b><tt class='constant'>FALSE</tt></b> otherwise </td> </tr> <tr valign='middle'> <td align='left'>n_cs_precedes</td> <td align='left'> <b><tt class='constant'>TRUE</tt></b> if currency_symbol precedes a negative value, <b><tt class='constant'>FALSE</tt></b> if it succeeds one </td> </tr> <tr valign='middle'> <td align='left'>n_sep_by_space</td> <td align='left'> <b><tt class='constant'>TRUE</tt></b> if a space separates currency_symbol from a negative value, <b><tt class='constant'>FALSE</tt></b> otherwise </td> </tr> <tr valign='top'> <td align='left'>p_sign_posn</td> <td align='left'> <ul class='simplelist'> <li class='member'>0 - Parentheses surround the quantity and currency_symbol</li> <li class='member'>1 - The sign string precedes the quantity and currency_symbol</li> <li class='member'>2 - The sign string succeeds the quantity and currency_symbol</li> <li class='member'>3 - The sign string immediately precedes the currency_symbol</li> <li class='member'>4 - The sign string immediately succeeds the currency_symbol</li> </ul> </td> </tr> <tr valign='top'> <td align='left'>n_sign_posn</td> <td align='left'> <ul class='simplelist'> <li class='member'>0 - Parentheses surround the quantity and currency_symbol</li> <li class='member'>1 - The sign string precedes the quantity and currency_symbol</li> <li class='member'>2 - The sign string succeeds the quantity and currency_symbol</li> <li class='member'>3 - The sign string immediately precedes the currency_symbol</li> <li class='member'>4 - The sign string immediately succeeds the currency_symbol</li> </ul> </td> </tr> </tbody> </table> <p> </p> <p class='para'> The <i>p_sign_posn</i>, and <i>n_sign_posn</i> contain a string of formatting options. Each number representing one of the above listed conditions. </p> <p class='para'> The grouping fields contain arrays that define the way numbers should be grouped. For example, the monetary grouping field for the nl_NL locale (in UTF-8 mode with the euro sign), would contain a 2 item array with the values 3 and 3. The higher the index in the array, the farther left the grouping is. If an array element is equal to <b><tt class='constant'>CHAR_MAX</tt></b>, no further grouping is done. If an array element is equal to 0, the previous element should be used. </p> </div> <a name='function.localeconv.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>localeconv()</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'>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'>'nl_NL.UTF-8@euro'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$locale_info&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>localeconv</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'>$locale_info</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> Array ( [decimal_point] =&amp;gt; . [thousands_sep] =&amp;gt; [int_curr_symbol] =&amp;gt; EUR [currency_symbol] =&amp;gt; &amp;acirc;&amp;#130;&amp;not; [mon_decimal_point] =&amp;gt; , [mon_thousands_sep] =&amp;gt; [positive_sign] =&amp;gt; [negative_sign] =&amp;gt; - [int_frac_digits] =&amp;gt; 2 [frac_digits] =&amp;gt; 2 [p_cs_precedes] =&amp;gt; 1 [p_sep_by_space] =&amp;gt; 1 [n_cs_precedes] =&amp;gt; 1 [n_sep_by_space] =&amp;gt; 1 [p_sign_posn] =&amp;gt; 1 [n_sign_posn] =&amp;gt; 2 [grouping] =&amp;gt; Array ( ) [mon_grouping] =&amp;gt; Array ( [0] =&amp;gt; 3 [1] =&amp;gt; 3 ) ) </pre></div> </div> </div><p> </p> </div> <a name='function.localeconv.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="LimitIterator::valid" value="<div id='limititerator.valid' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/limititerator.valid.php'>LimitIterator::valid</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>LimitIterator::valid</span> &amp;mdash; <span class='dc-title'>Check whether the current element is valid</span></p> </div> <a name='limititerator.valid.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>LimitIterator::valid</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Checks whether the current element is valid. </p> <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='limititerator.valid.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='limititerator.valid.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="LimitIterator::seek" value="<div id='limititerator.seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/limititerator.seek.php'>LimitIterator::seek</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>LimitIterator::seek</span> &amp;mdash; <span class='dc-title'>Seek to the given position</span></p> </div> <a name='limititerator.seek.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>LimitIterator::seek</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$position</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='limititerator.seek.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'>position</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The position being seeked to. </p> </dd> </dl> <p> </p> </div> <a name='limititerator.seek.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </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="LimitIterator::rewind" value="<div id='limititerator.rewind' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/limititerator.rewind.php'>LimitIterator::rewind</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>LimitIterator::rewind</span> &amp;mdash; <span class='dc-title'>Rewind the iterator to the specified starting offset</span></p> </div> <a name='limititerator.rewind.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>LimitIterator::rewind</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Rewinds the iterator to the specified starting offset. </p> <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='limititerator.rewind.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='limititerator.rewind.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </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="LimitIterator::next" value="<div id='limititerator.next' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/limititerator.next.php'>LimitIterator::next</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>LimitIterator::next</span> &amp;mdash; <span class='dc-title'>Move the iterator forward</span></p> </div> <a name='limititerator.next.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>LimitIterator::next</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Moves the iterator forward. </p> <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='limititerator.next.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='limititerator.next.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </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="LimitIterator::getPosition" value="<div id='limititerator.getposition' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/limititerator.getposition.php'>LimitIterator::getPosition</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>LimitIterator::getPosition</span> &amp;mdash; <span class='dc-title'>Return the current position</span></p> </div> <a name='limititerator.getposition.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>LimitIterator::getPosition</b></span> ( <span class='methodparam'>void</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='limititerator.getposition.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='limititerator.getposition.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The current position. </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="LimitIterator" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.limititerator.php'>The LimitIterator class</a></h1> <div class='partintro'> <div id='limititerator.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> ... </p> </div> <div id='limititerator.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>LimitIterator</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>LimitIterator</b> </span> <span class='ooclass'> <span class='modifier'>extends</span> <a href='http://www.php.net/manual/en/class.iteratoriterator.php' class='classname'>IteratorIterator</a> </span> <span class='oointerface'>implements <a href='http://www.php.net/manual/en/class.outeriterator.php' class='interfacename'>OuterIterator</a> </span> <span class='oointerface'>, <a href='http://www.php.net/manual/en/class.traversable.php' class='interfacename'>Traversable</a> </span> <span class='oointerface'>, <a href='http://www.php.net/manual/en/class.iterator.php' class='interfacename'>Iterator</a> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/limititerator.getposition.php' class='function'>getPosition</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/limititerator.next.php' class='function'>next</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/limititerator.rewind.php' class='function'>rewind</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/limititerator.seek.php' class='function'>seek</a></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$position</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/limititerator.valid.php' class='function'>valid</a></span> ( <span class='methodparam'>void</span> )</div> }</div> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/limititerator.getposition.php'>LimitIterator::getPosition</a> &amp;acirc;&amp;#128;&amp;#148; Return the current position</li><li><a href='http://www.php.net/manual/en/limititerator.next.php'>LimitIterator::next</a> &amp;acirc;&amp;#128;&amp;#148; Move the iterator forward</li><li><a href='http://www.php.net/manual/en/limititerator.rewind.php'>LimitIterator::rewind</a> &amp;acirc;&amp;#128;&amp;#148; Rewind the iterator to the specified starting offset</li><li><a href='http://www.php.net/manual/en/limititerator.seek.php'>LimitIterator::seek</a> &amp;acirc;&amp;#128;&amp;#148; Seek to the given position</li><li><a href='http://www.php.net/manual/en/limititerator.valid.php'>LimitIterator::valid</a> &amp;acirc;&amp;#128;&amp;#148; Check whether the current element is valid</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="levenshtein" value="<div id='function.levenshtein' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.levenshtein.php'>levenshtein</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.1, PHP 5)</p><p class='refpurpose'><span class='refname'>levenshtein</span> &amp;mdash; <span class='dc-title'>Calculate Levenshtein distance between two strings</span></p> </div> <a name='function.levenshtein.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>levenshtein</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str1</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str2</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>levenshtein</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str1</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cost_ins</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cost_rep</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cost_del</tt></span> )</div> <p class='para rdfs-comment'> The Levenshtein distance is defined as the minimal number of characters you have to replace, insert or delete to transform <i><tt class='parameter'>str1</tt></i> into <i><tt class='parameter'>str2</tt></i> . The complexity of the algorithm is <i>O(m*n)</i>, where <i>n</i> and <i>m</i> are the length of <i><tt class='parameter'>str1</tt></i> and <i><tt class='parameter'>str2</tt></i> (rather good when compared to <a href='http://www.php.net/manual/en/function.similar-text.php' class='function'>similar_text()</a>, which is O(max(n,m)**3), but still expensive). </p> <p class='para'> In its simplest form the function will take only the two strings as parameter and will calculate just the number of insert, replace and delete operations needed to transform <i><tt class='parameter'>str1</tt></i> into <i><tt class='parameter'>str2</tt></i> . </p> <p class='para'> A second variant will take three additional parameters that define the cost of insert, replace and delete operations. This is more general and adaptive than variant one, but not as efficient. </p> </div> <a name='function.levenshtein.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'>str1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> One of the strings being evaluated for Levenshtein distance. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>str2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> One of the strings being evaluated for Levenshtein distance. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cost_ins</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Defines the cost of insertion. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cost_rep</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Defines the cost of replacement. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cost_del</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Defines the cost of deletion. </p> </dd> </dl> <p> </p> </div> <a name='function.levenshtein.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> This function returns the Levenshtein-Distance between the two argument strings or -1, if one of the argument strings is longer than the limit of 255 characters. </p> </div> <a name='function.levenshtein.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>levenshtein()</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;input&amp;nbsp;misspelled&amp;nbsp;word<br /></span><span style='color: #0000BB'>$input&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'carrrot'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;array&amp;nbsp;of&amp;nbsp;words&amp;nbsp;to&amp;nbsp;check&amp;nbsp;against<br /></span><span style='color: #0000BB'>$words&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'apple'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'pineapple'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'banana'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'orange'</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'>'radish'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'carrot'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'pea'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'bean'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'potato'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;no&amp;nbsp;shortest&amp;nbsp;distance&amp;nbsp;found,&amp;nbsp;yet<br /></span><span style='color: #0000BB'>$shortest&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;loop&amp;nbsp;through&amp;nbsp;words&amp;nbsp;to&amp;nbsp;find&amp;nbsp;the&amp;nbsp;closest<br /></span><span style='color: #007700'>foreach&amp;nbsp;(</span><span style='color: #0000BB'>$words&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$word</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;calculate&amp;nbsp;the&amp;nbsp;distance&amp;nbsp;between&amp;nbsp;the&amp;nbsp;input&amp;nbsp;word,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;and&amp;nbsp;the&amp;nbsp;current&amp;nbsp;word<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$lev&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>levenshtein</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$input</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$word</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;check&amp;nbsp;for&amp;nbsp;an&amp;nbsp;exact&amp;nbsp;match<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$lev&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;closest&amp;nbsp;word&amp;nbsp;is&amp;nbsp;this&amp;nbsp;one&amp;nbsp;(exact&amp;nbsp;match)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$closest&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$word</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'>$shortest&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;break&amp;nbsp;out&amp;nbsp;of&amp;nbsp;the&amp;nbsp;loop;&amp;nbsp;we've&amp;nbsp;found&amp;nbsp;an&amp;nbsp;exact&amp;nbsp;match<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>break;<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;if&amp;nbsp;this&amp;nbsp;distance&amp;nbsp;is&amp;nbsp;less&amp;nbsp;than&amp;nbsp;the&amp;nbsp;next&amp;nbsp;found&amp;nbsp;shortest<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;distance,&amp;nbsp;OR&amp;nbsp;if&amp;nbsp;a&amp;nbsp;next&amp;nbsp;shortest&amp;nbsp;word&amp;nbsp;has&amp;nbsp;not&amp;nbsp;yet&amp;nbsp;been&amp;nbsp;found<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$lev&amp;nbsp;</span><span style='color: #007700'>&amp;lt;=&amp;nbsp;</span><span style='color: #0000BB'>$shortest&amp;nbsp;</span><span style='color: #007700'>||&amp;nbsp;</span><span style='color: #0000BB'>$shortest&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;set&amp;nbsp;the&amp;nbsp;closest&amp;nbsp;match,&amp;nbsp;and&amp;nbsp;shortest&amp;nbsp;distance<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$closest&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$word</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'>$shortest&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$lev</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'>'Input&amp;nbsp;word:&amp;nbsp;</span><span style='color: #0000BB'>$input</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$shortest&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'>'Exact&amp;nbsp;match&amp;nbsp;found:&amp;nbsp;</span><span style='color: #0000BB'>$closest</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'>'Did&amp;nbsp;you&amp;nbsp;mean:&amp;nbsp;</span><span style='color: #0000BB'>$closest</span><span style='color: #DD0000'>?\n'</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> Input word: carrrot Did you mean: carrot? </pre></div> </div> </div><p> </p> </div> <a name='function.levenshtein.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.soundex.php' class='function' rel='rdfs-seeAlso'>soundex()</a> - Calculate the soundex key of a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.similar-text.php' class='function' rel='rdfs-seeAlso'>similar_text()</a> - Calculate the similarity between two strings</li> <li class='member'><a href='http://www.php.net/manual/en/function.metaphone.php' class='function' rel='rdfs-seeAlso'>metaphone()</a> - Calculate the metaphone key of 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="LengthException" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.lengthexception.php'>The LengthException class</a></h1> <div class='partintro'> <div id='lengthexception.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> Exception thrown if a length is invalid </p> </div> <div id='lengthexception.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>LengthException</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>LengthException</b> </span> <span class='ooclass'> <span class='modifier'>extends</span> <a href='http://www.php.net/manual/en/class.logicexception.php' class='classname'>LogicException</a> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Inherited methods */</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getmessage.php' class='function'>Exception::getMessage</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>Exception</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getprevious.php' class='function'>Exception::getPrevious</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getcode.php' class='function'>Exception::getCode</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getfile.php' class='function'>Exception::getFile</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getline.php' class='function'>Exception::getLine</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>array</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.gettrace.php' class='function'>Exception::getTrace</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.gettraceasstring.php' class='function'>Exception::getTraceAsString</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.tostring.php' class='function'>Exception::__toString</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>private</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.clone.php' class='function'>Exception::__clone</a></span> ( <span class='methodparam'>void</span> )</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="lcg_value" value="<div id='function.lcg-value' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.lcg-value.php'>lcg_value</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>lcg_value</span> &amp;mdash; <span class='dc-title'>Combined linear congruential generator</span></p> </div> <a name='function.lcg-value.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>float</span> <span class='methodname'><b>lcg_value</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> <b>lcg_value()</b> returns a pseudo random number in the range of (0, 1). The function combines two CGs with periods of 2^31 - 85 and 2^31 - 249. The period of this function is equal to the product of both primes. </p> </div> <a name='function.lcg-value.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A pseudo random float value in the range of (0, 1) </p> </div> <a name='function.lcg-value.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.rand.php' class='function' rel='rdfs-seeAlso'>rand()</a> - Generate a random integer</li> <li class='member'><a href='http://www.php.net/manual/en/function.mt-rand.php' class='function' rel='rdfs-seeAlso'>mt_rand()</a> - Generate a better random value</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="ksort" value="<div id='function.ksort' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ksort.php'>ksort</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ksort</span> &amp;mdash; <span class='dc-title'>Sort an array by key</span></p> </div> <a name='function.ksort.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>ksort</b></span> ( <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$array</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$sort_flags</tt><span class='initializer'> = SORT_REGULAR</span></span> ] )</div> <p class='para rdfs-comment'> Sorts an array by key, maintaining key to data correlations. This is useful mainly for associative arrays. </p> </div> <a name='function.ksort.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'>array</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The input array. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>sort_flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> You may modify the behavior of the sort using the optional parameter <i><tt class='parameter'>sort_flags</tt></i> , for details see <a href='http://www.php.net/manual/en/function.sort.php' class='function'>sort()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.ksort.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.ksort.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.0.0</td> <td align='left'> The optional <i><tt class='parameter'>sort_flags</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ksort.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ksort()</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 />$fruits&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'d'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'lemon'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'a'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'orange'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'b'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'banana'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'c'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'apple'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>ksort</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fruits</span><span style='color: #007700'>);<br />foreach&amp;nbsp;(</span><span style='color: #0000BB'>$fruits&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;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$key</span><span style='color: #DD0000'>&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>$val</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> a = orange b = banana c = apple d = lemon </pre></div> </div> </div><p> </p> </div> <a name='function.ksort.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.asort.php' class='function' rel='rdfs-seeAlso'>asort()</a> - Sort an array and maintain index association</li> <li class='member'>The <a href='http://www.php.net/manual/en/array.sorting.php' class='link'>comparison of array sorting 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="krsort" value="<div id='function.krsort' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.krsort.php'>krsort</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>krsort</span> &amp;mdash; <span class='dc-title'>Sort an array by key in reverse order</span></p> </div> <a name='function.krsort.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>krsort</b></span> ( <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$array</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$sort_flags</tt><span class='initializer'> = SORT_REGULAR</span></span> ] )</div> <p class='para rdfs-comment'> Sorts an array by key in reverse order, maintaining key to data correlations. This is useful mainly for associative arrays. </p> </div> <a name='function.krsort.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'>array</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The input array. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>sort_flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> You may modify the behavior of the sort using the optional parameter <i><tt class='parameter'>sort_flags</tt></i> , for details see <a href='http://www.php.net/manual/en/function.sort.php' class='function'>sort()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.krsort.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.krsort.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>krsort()</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 />$fruits&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'d'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'lemon'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'a'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'orange'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'b'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'banana'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'c'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'apple'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>krsort</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$fruits</span><span style='color: #007700'>);<br />foreach&amp;nbsp;(</span><span style='color: #0000BB'>$fruits&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;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$key</span><span style='color: #DD0000'>&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>$val</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> d = lemon c = apple b = banana a = orange </pre></div> </div> </div><p> </p> </div> <a name='function.krsort.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.arsort.php' class='function' rel='rdfs-seeAlso'>arsort()</a> - Sort an array in reverse order and maintain index association</li> <li class='member'><a href='http://www.php.net/manual/en/function.ksort.php' class='function' rel='rdfs-seeAlso'>ksort()</a> - Sort an array by key</li> <li class='member'>The <a href='http://www.php.net/manual/en/array.sorting.php' class='link'>comparison of array sorting 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="key" value="<div id='function.key' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.key.php'>key</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>key</span> &amp;mdash; <span class='dc-title'>Fetch a key from an array</span></p> </div> <a name='function.key.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>key</b></span> ( <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$array</tt></span> )</div> <p class='para rdfs-comment'> <b>key()</b> returns the index element of the current array position. </p> </div> <a name='function.key.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'>array</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The array. </p> </dd> </dl> <p> </p> </div> <a name='function.key.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The <b>key()</b> function simply returns the key of the array element that&amp;#039;s currently being pointed to by the internal pointer. It does not move the pointer in any way. If the internal pointer points beyond the end of the elements list or the array is empty, <b>key()</b> returns <b><tt class='constant'>NULL</tt></b>. </p> </div> <a name='function.key.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>key()</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 />$array&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'fruit1'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'apple'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'fruit2'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'orange'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'fruit3'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'grape'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'fruit4'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'apple'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'fruit5'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'apple'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;this&amp;nbsp;cycle&amp;nbsp;echoes&amp;nbsp;all&amp;nbsp;associative&amp;nbsp;array<br />//&amp;nbsp;key&amp;nbsp;where&amp;nbsp;value&amp;nbsp;equals&amp;nbsp;'apple'<br /></span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$fruit_name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>current</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$array</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$fruit_name&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #DD0000'>'apple'</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'>key</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$array</span><span style='color: #007700'>).</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;'</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'>next</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$array</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> fruit1&amp;lt;br /&amp;gt; fruit4&amp;lt;br /&amp;gt; fruit5&amp;lt;br /&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='function.key.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.current.php' class='function' rel='rdfs-seeAlso'>current()</a> - Return the current element in an array</li> <li class='member'><a href='http://www.php.net/manual/en/function.next.php' class='function' rel='rdfs-seeAlso'>next()</a> - Advance the internal array pointer of an array</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="json_encode" value="<div id='function.json-encode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.json-encode.php'>json_encode</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0, PECL json &amp;gt;= 1.2.0)</p><p class='refpurpose'><span class='refname'>json_encode</span> &amp;mdash; <span class='dc-title'>Returns the JSON representation of a value</span></p> </div> <a name='function.json-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>json_encode</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'>$value</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'> Returns a string containing the JSON representation of <i><tt class='parameter'>value</tt></i> . </p> </div> <a name='function.json-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'>value</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>value</tt></i> being encoded. Can be any type except a <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> <p class='para'> This function only works with UTF-8 encoded data. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Bitmask consisting of <b><tt class='constant'>JSON_HEX_QUOT</tt></b>, <b><tt class='constant'>JSON_HEX_TAG</tt></b>, <b><tt class='constant'>JSON_HEX_AMP</tt></b>, <b><tt class='constant'>JSON_HEX_APOS</tt></b>, <b><tt class='constant'>JSON_FORCE_OBJECT</tt></b>. Defaults to 0. </p> </dd> </dl> <p> </p> </div> <a name='function.json-encode.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a JSON encoded <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> on success. </p> </div> <a name='function.json-encode.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.3.0</td> <td align='left'> The <i><tt class='parameter'>options</tt></i> parameter was added. </td> </tr> <tr valign='middle'> <td align='left'>5.2.1</td> <td align='left'> Added support to JSON encode basic types. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.json-encode.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>json_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 />$arr&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array&amp;nbsp;(</span><span style='color: #DD0000'>'a'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'b'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'c'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'d'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'e'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$arr</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;quot;a&amp;quot;:1,&amp;quot;b&amp;quot;:2,&amp;quot;c&amp;quot;:3,&amp;quot;d&amp;quot;:4,&amp;quot;e&amp;quot;:5} </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 A <b>json_encode()</b> example showing all the options in action</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;array(</span><span style='color: #DD0000'>'&amp;lt;foo&amp;gt;'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>''bar''</span><span style='color: #007700'>,</span><span style='color: #DD0000'>''baz''</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'&amp;amp;blong&amp;amp;'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Normal:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Tags:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,</span><span style='color: #0000BB'>JSON_HEX_TAG</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Apos:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,</span><span style='color: #0000BB'>JSON_HEX_APOS</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Quot:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,</span><span style='color: #0000BB'>JSON_HEX_QUOT</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Amp:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,</span><span style='color: #0000BB'>JSON_HEX_AMP</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'All:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,</span><span style='color: #0000BB'>JSON_HEX_TAG</span><span style='color: #007700'>|</span><span style='color: #0000BB'>JSON_HEX_APOS</span><span style='color: #007700'>|</span><span style='color: #0000BB'>JSON_HEX_QUOT</span><span style='color: #007700'>|</span><span style='color: #0000BB'>JSON_HEX_AMP</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$b&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array();<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Empty&amp;nbsp;array&amp;nbsp;output&amp;nbsp;as&amp;nbsp;array:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Empty&amp;nbsp;array&amp;nbsp;output&amp;nbsp;as&amp;nbsp;object:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>JSON_FORCE_OBJECT</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$c&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(array(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,</span><span style='color: #0000BB'>3</span><span style='color: #007700'>));<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Non-associative&amp;nbsp;array&amp;nbsp;output&amp;nbsp;as&amp;nbsp;array:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Non-associative&amp;nbsp;array&amp;nbsp;output&amp;nbsp;as&amp;nbsp;object:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>JSON_FORCE_OBJECT</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'\n\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> Normal: [&amp;quot;&amp;lt;foo&amp;gt;&amp;quot;,&amp;quot;&amp;#039;bar&amp;#039;&amp;quot;,&amp;quot;\&amp;quot;baz\&amp;quot;&amp;quot;,&amp;quot;&amp;amp;blong&amp;amp;&amp;quot;] Tags: [&amp;quot;\u003Cfoo\u003E&amp;quot;,&amp;quot;&amp;#039;bar&amp;#039;&amp;quot;,&amp;quot;\&amp;quot;baz\&amp;quot;&amp;quot;,&amp;quot;&amp;amp;blong&amp;amp;&amp;quot;] Apos: [&amp;quot;&amp;lt;foo&amp;gt;&amp;quot;,&amp;quot;\u0027bar\u0027&amp;quot;,&amp;quot;\&amp;quot;baz\&amp;quot;&amp;quot;,&amp;quot;&amp;amp;blong&amp;amp;&amp;quot;] Quot: [&amp;quot;&amp;lt;foo&amp;gt;&amp;quot;,&amp;quot;&amp;#039;bar&amp;#039;&amp;quot;,&amp;quot;\u0022baz\u0022&amp;quot;,&amp;quot;&amp;amp;blong&amp;amp;&amp;quot;] Amp: [&amp;quot;&amp;lt;foo&amp;gt;&amp;quot;,&amp;quot;&amp;#039;bar&amp;#039;&amp;quot;,&amp;quot;\&amp;quot;baz\&amp;quot;&amp;quot;,&amp;quot;\u0026blong\u0026&amp;quot;] All: [&amp;quot;\u003Cfoo\u003E&amp;quot;,&amp;quot;\u0027bar\u0027&amp;quot;,&amp;quot;\u0022baz\u0022&amp;quot;,&amp;quot;\u0026blong\u0026&amp;quot;] Empty array output as array: [] Empty array output as object: {} Non-associative array output as array: [[1,2,3]] Non-associative array output as object: {&amp;quot;0&amp;quot;:{&amp;quot;0&amp;quot;:1,&amp;quot;1&amp;quot;:2,&amp;quot;2&amp;quot;:3}} </pre></div> </div> </div><p> </p> </div> <a name='function.json-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.json-decode.php' class='function' rel='rdfs-seeAlso'>json_decode()</a> - Decodes a JSON 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="json_decode" value="<div id='function.json-decode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.json-decode.php'>json_decode</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0, PECL json &amp;gt;= 1.2.0)</p><p class='refpurpose'><span class='refname'>json_decode</span> &amp;mdash; <span class='dc-title'>Decodes a JSON string</span></p> </div> <a name='function.json-decode.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>json_decode</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$json</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$assoc</tt><span class='initializer'> = false</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$depth</tt><span class='initializer'> = 512</span></span> ]] )</div> <p class='para rdfs-comment'> Takes a JSON encoded string and converts it into a PHP variable. </p> </div> <a name='function.json-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'>json</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>json</tt></i> <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being decoded. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>assoc</tt></i> </span> </dt><dd class='listitem'> <p class='para'> When <b><tt class='constant'>TRUE</tt></b>, returned <a href='http://www.php.net/manual/en/language.types.object.php' class='type object'>object</a>s will be converted into associative <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>s. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>depth</tt></i> </span> </dt><dd class='listitem'> <p class='para'> User specified recursion depth. </p> </dd> </dl> <p> </p> </div> <a name='function.json-decode.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.object.php' class='type object'>object</a> or if the optional <i><tt class='parameter'>assoc</tt></i> parameter is <b><tt class='constant'>TRUE</tt></b>, an associative <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> is instead returned. <b><tt class='constant'>NULL</tt></b> is returned if the <i><tt class='parameter'>json</tt></i> cannot be decoded or if the encoded data is deeper than the recursion limit. </p> </div> <a name='function.json-decode.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>json_decode()</b> examples</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$json&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'{'a':1,'b':2,'c':3,'d':4,'e':5}'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>json_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$json</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>json_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$json</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</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> object(stdClass)#1 (5) { [&amp;quot;a&amp;quot;] =&amp;gt; int(1) [&amp;quot;b&amp;quot;] =&amp;gt; int(2) [&amp;quot;c&amp;quot;] =&amp;gt; int(3) [&amp;quot;d&amp;quot;] =&amp;gt; int(4) [&amp;quot;e&amp;quot;] =&amp;gt; int(5) } array(5) { [&amp;quot;a&amp;quot;] =&amp;gt; int(1) [&amp;quot;b&amp;quot;] =&amp;gt; int(2) [&amp;quot;c&amp;quot;] =&amp;gt; int(3) [&amp;quot;d&amp;quot;] =&amp;gt; int(4) [&amp;quot;e&amp;quot;] =&amp;gt; int(5) } </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Another 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 />$json&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'{'foo-bar':&amp;nbsp;12345}'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>json_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$json</span><span style='color: #007700'>);<br />print&amp;nbsp;</span><span style='color: #0000BB'>$obj</span><span style='color: #007700'>-&amp;gt;{</span><span style='color: #DD0000'>'foo-bar'</span><span style='color: #007700'>};&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;12345<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #3 common mistakes using <b>json_decode()</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;the&amp;nbsp;following&amp;nbsp;strings&amp;nbsp;are&amp;nbsp;valid&amp;nbsp;JavaScript&amp;nbsp;but&amp;nbsp;not&amp;nbsp;valid&amp;nbsp;JSON<br /><br />//&amp;nbsp;the&amp;nbsp;name&amp;nbsp;and&amp;nbsp;value&amp;nbsp;must&amp;nbsp;be&amp;nbsp;enclosed&amp;nbsp;in&amp;nbsp;double&amp;nbsp;quotes<br />//&amp;nbsp;single&amp;nbsp;quotes&amp;nbsp;are&amp;nbsp;not&amp;nbsp;valid&amp;nbsp;<br /></span><span style='color: #0000BB'>$bad_json&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'{&amp;nbsp;'bar':&amp;nbsp;'baz'&amp;nbsp;}'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>json_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$bad_json</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;null<br /><br />//&amp;nbsp;the&amp;nbsp;name&amp;nbsp;must&amp;nbsp;be&amp;nbsp;enclosed&amp;nbsp;in&amp;nbsp;double&amp;nbsp;quotes<br /></span><span style='color: #0000BB'>$bad_json&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'{&amp;nbsp;bar:&amp;nbsp;'baz'&amp;nbsp;}'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>json_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$bad_json</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;null<br /><br />//&amp;nbsp;trailing&amp;nbsp;commas&amp;nbsp;are&amp;nbsp;not&amp;nbsp;allowed<br /></span><span style='color: #0000BB'>$bad_json&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'{&amp;nbsp;bar:&amp;nbsp;'baz',&amp;nbsp;}'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>json_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$bad_json</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;null<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #4 <i><tt class='parameter'>depth</tt></i> errors</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;Encode&amp;nbsp;the&amp;nbsp;data.<br /></span><span style='color: #0000BB'>$json&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>json_encode</span><span style='color: #007700'>(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>1&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;array(<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: #DD0000'>'English'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;array(<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'>'One'</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'>'January'<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: #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: #DD0000'>'French'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;array(<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'>'Une'</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'>'Janvier'<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: #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: #FF8000'>//&amp;nbsp;Define&amp;nbsp;the&amp;nbsp;errors.<br /></span><span style='color: #0000BB'>$json_errors&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>JSON_ERROR_NONE&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;error&amp;nbsp;has&amp;nbsp;occurred'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>JSON_ERROR_DEPTH&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;maximum&amp;nbsp;stack&amp;nbsp;depth&amp;nbsp;has&amp;nbsp;been&amp;nbsp;exceeded'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>JSON_ERROR_CTRL_CHAR&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'Control&amp;nbsp;character&amp;nbsp;error,&amp;nbsp;possibly&amp;nbsp;incorrectly&amp;nbsp;encoded'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>JSON_ERROR_SYNTAX&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'Syntax&amp;nbsp;error'</span><span style='color: #007700'>,<br />);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Show&amp;nbsp;the&amp;nbsp;errors&amp;nbsp;for&amp;nbsp;different&amp;nbsp;depths.<br /></span><span style='color: #007700'>foreach(</span><span style='color: #0000BB'>range</span><span style='color: #007700'>(</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>)&amp;nbsp;as&amp;nbsp;</span><span style='color: #0000BB'>$depth</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>json_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$json</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>True</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$depth</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Last&amp;nbsp;error&amp;nbsp;:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$json_errors</span><span style='color: #007700'>[</span><span style='color: #0000BB'>json_last_error</span><span style='color: #007700'>()],&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<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(1) { [1]=&amp;gt; array(2) { [&amp;quot;English&amp;quot;]=&amp;gt; array(2) { [0]=&amp;gt; string(3) &amp;quot;One&amp;quot; [1]=&amp;gt; string(7) &amp;quot;January&amp;quot; } [&amp;quot;French&amp;quot;]=&amp;gt; array(2) { [0]=&amp;gt; string(3) &amp;quot;Une&amp;quot; [1]=&amp;gt; string(7) &amp;quot;Janvier&amp;quot; } } } Last error : No error has occurred NULL Last error : The maximum stack depth has been exceeded </pre></div> </div> </div><p> </p> </div> <a name='function.json-decode.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The JSON spec is not JavaScript, but a subset of JavaScript. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: In the event of a failure to decode, <a href='http://www.php.net/manual/en/function.json-last-error.php' class='function'>json_last_error()</a> can be used to determine the exact nature of the error. <br /> </p></blockquote> </div> <a name='function.json-decode.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.3.0</td> <td align='left'>Added the optional <i><tt class='parameter'>depth</tt></i> . The default recursion depth was increased from 128 to 512</td> </tr> <tr valign='middle'> <td align='left'>5.2.3</td> <td align='left'>The nesting limit was increased from 20 to 128</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.json-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.json-encode.php' class='function' rel='rdfs-seeAlso'>json_encode()</a> - Returns the JSON representation of a value</li> <li class='member'><a href='http://www.php.net/manual/en/function.json-last-error.php' class='function' rel='rdfs-seeAlso'>json_last_error()</a> - Returns the last error 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="jpeg2wbmp" value="<div id='function.jpeg2wbmp' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.jpeg2wbmp.php'>jpeg2wbmp</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>jpeg2wbmp</span> &amp;mdash; <span class='dc-title'>Convert JPEG image file to WBMP image file</span></p> </div> <a name='function.jpeg2wbmp.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>jpeg2wbmp</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$jpegname</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$wbmpname</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dest_height</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dest_width</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$threshold</tt></span> )</div> <p class='para rdfs-comment'> Converts a JPEG file into a WBMP file. </p> </div> <a name='function.jpeg2wbmp.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'>jpegname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Path to JPEG file. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>wbmpname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Path to destination WBMP file. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dest_height</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination image height. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dest_width</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination image width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>threshold</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Threshold value, between 0 and 8 (inclusive). </p> </dd> </dl> <p> </p> </div> <a name='function.jpeg2wbmp.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.jpeg2wbmp.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>jpeg2wbmp()</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;Path&amp;nbsp;to&amp;nbsp;the&amp;nbsp;target&amp;nbsp;jpeg<br /></span><span style='color: #0000BB'>$path&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'./test.jpg'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;the&amp;nbsp;image&amp;nbsp;sizes<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>getimagesize</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$path</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Convert&amp;nbsp;image<br /></span><span style='color: #0000BB'>jpeg2wbmp</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$path</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./test.wbmp'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>5</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.jpeg2wbmp.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>WBMP support is only available if PHP was compiled against GD-1.8 or later.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>JPEG support is only available if PHP was compiled against GD-1.8 or later.</span></p></blockquote> </div> <a name='function.jpeg2wbmp.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.png2wbmp.php' class='function' rel='rdfs-seeAlso'>png2wbmp()</a> - Convert PNG image file to WBMP image file</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="join" value="<div id='function.join' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.join.php'>join</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>join</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.implode.php' class='function'>implode()</a></span></p> </div> <a name='function.join.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.implode.php' class='function'>implode()</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="iterator_to_array" value="<div id='function.iterator-to-array' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iterator-to-array.php'>iterator_to_array</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>iterator_to_array</span> &amp;mdash; <span class='dc-title'>Copy the iterator into an array</span></p> </div> <a name='function.iterator-to-array.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>iterator_to_array</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.traversable.php' class='type Traversable'>Traversable</a></span> <tt class='parameter'>$iterator</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$use_keys</tt><span class='initializer'> = true</span></span> ] )</div> <p class='para rdfs-comment'> Copy the elements of an iterator into an array. </p> </div> <a name='function.iterator-to-array.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'>iterator</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The iterator being copied. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>use_keys</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whether to use the iterator element keys as index. </p> </dd> </dl> <p> </p> </div> <a name='function.iterator-to-array.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> containing the elements of the <i><tt class='parameter'>iterator</tt></i> . </p> </div> <a name='function.iterator-to-array.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>iterator_to_array()</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 />$iterator&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>ArrayIterator</span><span style='color: #007700'>(array(</span><span style='color: #DD0000'>'recipe'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'pancakes'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'egg'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'milk'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'flour'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>iterator_to_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$iterator</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>iterator_to_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$iterator</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</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(4) { [&amp;quot;recipe&amp;quot;]=&amp;gt; string(8) &amp;quot;pancakes&amp;quot; [0]=&amp;gt; string(3) &amp;quot;egg&amp;quot; [1]=&amp;gt; string(4) &amp;quot;milk&amp;quot; [2]=&amp;gt; string(5) &amp;quot;flour&amp;quot; } array(4) { [0]=&amp;gt; string(8) &amp;quot;pancakes&amp;quot; [1]=&amp;gt; string(3) &amp;quot;egg&amp;quot; [2]=&amp;gt; string(4) &amp;quot;milk&amp;quot; [3]=&amp;gt; string(5) &amp;quot;flour&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="iterator_count" value="<div id='function.iterator-count' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iterator-count.php'>iterator_count</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>iterator_count</span> &amp;mdash; <span class='dc-title'>Count the elements in an iterator</span></p> </div> <a name='function.iterator-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>iterator_count</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.traversable.php' class='type Traversable'>Traversable</a></span> <tt class='parameter'>$iterator</tt></span> )</div> <p class='para rdfs-comment'> Count the elements in an iterator. </p> </div> <a name='function.iterator-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'>iterator</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The iterator being counted. </p> </dd> </dl> <p> </p> </div> <a name='function.iterator-count.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The number of elements in <i><tt class='parameter'>iterator</tt></i> . </p> </div> <a name='function.iterator-count.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>iterator_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 />$iterator&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>ArrayIterator</span><span style='color: #007700'>(array(</span><span style='color: #DD0000'>'recipe'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'pancakes'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'egg'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'milk'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'flour'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>iterator_count</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$iterator</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> int(4) </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="iterator_apply" value="<div id='function.iterator-apply' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iterator-apply.php'>iterator_apply</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>iterator_apply</span> &amp;mdash; <span class='dc-title'>Apply a user function to every element of an iterator</span></p> </div> <a name='function.iterator-apply.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>iterator_apply</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.traversable.php' class='type Traversable'>Traversable</a></span> <tt class='parameter'>$iterator</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'>$function</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$args</tt></span> ] )</div> <p class='para rdfs-comment'> Calls a function for every element in an iterator. </p> </div> <a name='function.iterator-apply.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'>iterator</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The class to walk through. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>function</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The callback function to call on every element. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>args</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Arguments to pass to the callback function. </p> </dd> </dl> <p> </p> </div> <a name='function.iterator-apply.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the iteration count. </p> </div> <a name='function.iterator-apply.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.array-walk.php' class='function' rel='rdfs-seeAlso'>array_walk()</a> - Apply a user function to every member of an array</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="IteratorIterator::__construct" value="<div id='iteratoriterator.construct' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iteratoriterator.construct.php'>IteratorIterator::__construct</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>IteratorIterator::__construct</span> &amp;mdash; <span class='dc-title'>Create an iterator from anything that is traversable</span></p> </div> <a name='iteratoriterator.construct.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='methodname'><b>IteratorIterator::__construct</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.traversable.php' class='type Traversable'>Traversable</a></span> <tt class='parameter'>$iterator</tt></span> )</div> <p class='para rdfs-comment'> Creates an iterator from anything that is traversable. </p> </div> <a name='iteratoriterator.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'>iterator</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The traversable iterator. </p> </dd> </dl> <p> </p> </div> <a name='iteratoriterator.construct.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='iteratoriterator.construct.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/class.traversable.php' class='classname'>Traversable</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="IteratorIterator::valid" value="<div id='iteratoriterator.valid' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iteratoriterator.valid.php'>IteratorIterator::valid</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>IteratorIterator::valid</span> &amp;mdash; <span class='dc-title'>Checks if the iterator is valid</span></p> </div> <a name='iteratoriterator.valid.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>bool</span> <span class='methodname'><b>IteratorIterator::valid</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Checks if the iterator is valid. </p> </div> <a name='iteratoriterator.valid.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iteratoriterator.valid.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 iterator is valid, otherwise <b><tt class='constant'>FALSE</tt></b> </p> </div> <a name='iteratoriterator.valid.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.iterator-count.php' class='function' rel='rdfs-seeAlso'>iterator_count()</a> - Count the elements in an iterator</li> <li class='member'> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.current.php' class='function' rel='rdfs-seeAlso'>IteratorIterator::current</a> - Get the current value</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="IteratorIterator::rewind" value="<div id='iteratoriterator.rewind' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iteratoriterator.rewind.php'>IteratorIterator::rewind</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>IteratorIterator::rewind</span> &amp;mdash; <span class='dc-title'>Rewind to the first element</span></p> </div> <a name='iteratoriterator.rewind.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>IteratorIterator::rewind</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Rewinds to the first element. </p> </div> <a name='iteratoriterator.rewind.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iteratoriterator.rewind.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='iteratoriterator.rewind.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.next.php' class='function' rel='rdfs-seeAlso'>IteratorIterator::next</a> - Forward to the next element</span></li> <li class='member'> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.valid.php' class='function' rel='rdfs-seeAlso'>IteratorIterator::valid</a> - Checks if the iterator is valid</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="IteratorIterator::next" value="<div id='iteratoriterator.next' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iteratoriterator.next.php'>IteratorIterator::next</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>IteratorIterator::next</span> &amp;mdash; <span class='dc-title'>Forward to the next element</span></p> </div> <a name='iteratoriterator.next.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>IteratorIterator::next</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Forward to the next element. </p> </div> <a name='iteratoriterator.next.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iteratoriterator.next.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='iteratoriterator.next.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.rewind.php' class='function' rel='rdfs-seeAlso'>IteratorIterator::rewind</a> - Rewind to the first element</span></li> <li class='member'> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.valid.php' class='function' rel='rdfs-seeAlso'>IteratorIterator::valid</a> - Checks if the iterator is valid</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="IteratorIterator::key" value="<div id='iteratoriterator.key' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iteratoriterator.key.php'>IteratorIterator::key</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>IteratorIterator::key</span> &amp;mdash; <span class='dc-title'>Get the key of the current element</span></p> </div> <a name='iteratoriterator.key.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>IteratorIterator::key</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Get the key of the current element. </p> </div> <a name='iteratoriterator.key.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iteratoriterator.key.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The key of the current element. </p> </div> <a name='iteratoriterator.key.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.current.php' class='function' rel='rdfs-seeAlso'>IteratorIterator::current</a> - Get the current value</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="IteratorIterator::getInnerIterator" value="<div id='iteratoriterator.getinneriterator' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iteratoriterator.getinneriterator.php'>IteratorIterator::getInnerIterator</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>IteratorIterator::getInnerIterator</span> &amp;mdash; <span class='dc-title'>Get the inner iterator</span></p> </div> <a name='iteratoriterator.getinneriterator.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>IteratorIterator::getInnerIterator</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Get the inner iterator. </p> </div> <a name='iteratoriterator.getinneriterator.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iteratoriterator.getinneriterator.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The inner iterator as passed to <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.construct.php' class='function'>IteratorIterator::__construct</a></span>. </p> </div> <a name='iteratoriterator.getinneriterator.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/class.iterator.php' class='classname'>Iterator</a></li> <li class='member'><a href='http://www.php.net/manual/en/class.outeriterator.php' class='classname'>OuterIterator</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="IteratorIterator::current" value="<div id='iteratoriterator.current' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iteratoriterator.current.php'>IteratorIterator::current</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>IteratorIterator::current</span> &amp;mdash; <span class='dc-title'>Get the current value</span></p> </div> <a name='iteratoriterator.current.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>IteratorIterator::current</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Get the value of the current element. </p> </div> <a name='iteratoriterator.current.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iteratoriterator.current.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The value of the current element. </p> </div> <a name='iteratoriterator.current.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.key.php' class='function' rel='rdfs-seeAlso'>IteratorIterator::key</a> - Get the key of the current element</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="IteratorIterator" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.iteratoriterator.php'>The IteratorIterator class</a></h1> <div class='partintro'> <div id='iteratoriterator.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> This iterator wrapper allows the conversion of anything that is <a href='http://www.php.net/manual/en/class.traversable.php' class='link'>Traversable</a> into an Iterator. It is important to understand that most classes that do not implement Iterators have reasons as most likely they do not allow the full Iterator feature set. If so, techniques should be provided to prevent misuse, otherwise expect exceptions or fatal errors. </p> </div> <div id='iteratoriterator.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>IteratorIterator</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>IteratorIterator</b> </span> <span class='oointerface'>implements <a href='http://www.php.net/manual/en/class.iterator.php' class='interfacename'>Iterator</a> </span> <span class='oointerface'>, <a href='http://www.php.net/manual/en/class.traversable.php' class='interfacename'>Traversable</a> </span> <span class='oointerface'>, <a href='http://www.php.net/manual/en/class.outeriterator.php' class='interfacename'>OuterIterator</a> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.construct.php' class='function'>__construct</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.traversable.php' class='type Traversable'>Traversable</a></span> <tt class='parameter'>$iterator</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.current.php' class='function'>current</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.getinneriterator.php' class='function'>getInnerIterator</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.key.php' class='function'>key</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.next.php' class='function'>next</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.rewind.php' class='function'>rewind</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.valid.php' class='function'>valid</a></span> ( <span class='methodparam'>void</span> )</div> }</div> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/iteratoriterator.construct.php'>IteratorIterator::__construct</a> &amp;acirc;&amp;#128;&amp;#148; Create an iterator from anything that is traversable</li><li><a href='http://www.php.net/manual/en/iteratoriterator.current.php'>IteratorIterator::current</a> &amp;acirc;&amp;#128;&amp;#148; Get the current value</li><li><a href='http://www.php.net/manual/en/iteratoriterator.getinneriterator.php'>IteratorIterator::getInnerIterator</a> &amp;acirc;&amp;#128;&amp;#148; Get the inner iterator</li><li><a href='http://www.php.net/manual/en/iteratoriterator.key.php'>IteratorIterator::key</a> &amp;acirc;&amp;#128;&amp;#148; Get the key of the current element</li><li><a href='http://www.php.net/manual/en/iteratoriterator.next.php'>IteratorIterator::next</a> &amp;acirc;&amp;#128;&amp;#148; Forward to the next element</li><li><a href='http://www.php.net/manual/en/iteratoriterator.rewind.php'>IteratorIterator::rewind</a> &amp;acirc;&amp;#128;&amp;#148; Rewind to the first element</li><li><a href='http://www.php.net/manual/en/iteratoriterator.valid.php'>IteratorIterator::valid</a> &amp;acirc;&amp;#128;&amp;#148; Checks if the iterator is valid</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="IteratorAggregate::getIterator" value="<div id='iteratoraggregate.getiterator' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iteratoraggregate.getiterator.php'>IteratorAggregate::getIterator</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>IteratorAggregate::getIterator</span> &amp;mdash; <span class='dc-title'>Retrieve an external iterator</span></p> </div> <a name='iteratoraggregate.getiterator.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'><a href='http://www.php.net/manual/en/class.traversable.php' class='type Traversable'>Traversable</a></span> <span class='methodname'><b>IteratorAggregate::getIterator</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns an external iterator. </p> </div> <a name='iteratoraggregate.getiterator.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iteratoraggregate.getiterator.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An instance of an object implementing <a href='http://www.php.net/manual/en/class.iterator.php' class='classname'>Iterator</a> or <a href='http://www.php.net/manual/en/class.traversable.php' class='classname'>Traversable</a> </p> </div> <a name='iteratoraggregate.getiterator.errors'></a><div class='refsect1 errors'> <h3 class='title'>Errors/Exceptions</h3> <p class='para'> Throws an <a href='http://www.php.net/manual/en/class.exception.php' class='classname'>Exception</a> 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="IteratorAggregate" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.iteratoraggregate.php'>The IteratorAggregate interface</a></h1> <div class='partintro'> <div id='iteratoraggregate.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> Interface to create an external Iterator. </p> </div> <div id='iteratoraggregate.synopsis' class='section'> <h2 class='title'>Interface synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>IteratorAggregate</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>IteratorAggregate</b> </span> <span class='ooclass'> <span class='modifier'>extends</span> <a href='http://www.php.net/manual/en/class.traversable.php' class='classname'>Traversable</a> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'>Traversable</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoraggregate.getiterator.php' class='function'>getIterator</a></span> ( <span class='methodparam'>void</span> )</div> }</div> </div> <div id='iteratoraggregate.examples' class='section'> <div class='example'> <p><b>Example #1 Basic usage</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'>class&amp;nbsp;</span><span style='color: #0000BB'>myData&amp;nbsp;</span><span style='color: #007700'>implements&amp;nbsp;</span><span style='color: #0000BB'>IteratorAggregate&amp;nbsp;</span><span style='color: #007700'>{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;public&amp;nbsp;</span><span style='color: #0000BB'>$property1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Public&amp;nbsp;property&amp;nbsp;one'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;public&amp;nbsp;</span><span style='color: #0000BB'>$property2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Public&amp;nbsp;property&amp;nbsp;two'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;public&amp;nbsp;</span><span style='color: #0000BB'>$property3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Public&amp;nbsp;property&amp;nbsp;three'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;public&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>__construct</span><span style='color: #007700'>()&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>property4&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'last&amp;nbsp;property'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;public&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>getIterator</span><span style='color: #007700'>()&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>ArrayIterator</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$this</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>$obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>myData</span><span style='color: #007700'>;<br /><br />foreach(</span><span style='color: #0000BB'>$obj&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'>$value</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$key</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$value</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&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 something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> string(9) &amp;quot;property1&amp;quot; string(19) &amp;quot;Public property one&amp;quot; string(9) &amp;quot;property2&amp;quot; string(19) &amp;quot;Public property two&amp;quot; string(9) &amp;quot;property3&amp;quot; string(21) &amp;quot;Public property three&amp;quot; string(9) &amp;quot;property4&amp;quot; string(13) &amp;quot;last property&amp;quot; </pre></div> </div> </div> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/iteratoraggregate.getiterator.php'>IteratorAggregate::getIterator</a> &amp;acirc;&amp;#128;&amp;#148; Retrieve an external iterator</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="Iterator::valid" value="<div id='iterator.valid' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iterator.valid.php'>Iterator::valid</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>Iterator::valid</span> &amp;mdash; <span class='dc-title'>Checks if current position is valid</span></p> </div> <a name='iterator.valid.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'>boolean</span> <span class='methodname'><b>Iterator::valid</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> This method is called after <span class='methodname'><a href='http://www.php.net/manual/en/iterator.rewind.php' class='function'>Iterator::rewind</a></span> and <span class='methodname'><a href='http://www.php.net/manual/en/iterator.next.php' class='function'>Iterator::next</a></span> to check if the current position is valid. </p> </div> <a name='iterator.valid.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iterator.valid.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The return value will be casted to <a href='http://www.php.net/manual/en/language.types.boolean.php' class='type boolean'>boolean</a> and then evaluated. 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="Iterator::rewind" value="<div id='iterator.rewind' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iterator.rewind.php'>Iterator::rewind</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>Iterator::rewind</span> &amp;mdash; <span class='dc-title'>Rewind the Iterator to the first element</span></p> </div> <a name='iterator.rewind.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>Iterator::rewind</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Rewinds back to the first element of the Iterator. </p> <blockquote><p><b class='note'>Note</b>: This is the <em class='emphasis'>first</em> method called when starting a <a href='http://www.php.net/manual/en/control-structures.foreach.php' class='link'>foreach</a> loop. It will <em class='emphasis'>not</em> be executed <em class='emphasis'>after</em> <a href='http://www.php.net/manual/en/control-structures.foreach.php' class='link'>foreach</a> loops. <br /> </p></blockquote> </div> <a name='iterator.rewind.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iterator.rewind.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Any returned value is ignored. </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="Iterator::next" value="<div id='iterator.next' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iterator.next.php'>Iterator::next</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>Iterator::next</span> &amp;mdash; <span class='dc-title'>Move forward to next element</span></p> </div> <a name='iterator.next.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>Iterator::next</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Moves the current position to the next element. </p> <blockquote><p><b class='note'>Note</b>: This method is called <em class='emphasis'>after</em> each <a href='http://www.php.net/manual/en/control-structures.foreach.php' class='link'>foreach</a> loop. <br /> </p></blockquote> </div> <a name='iterator.next.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iterator.next.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Any returned value is ignored. </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="Iterator::key" value="<div id='iterator.key' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iterator.key.php'>Iterator::key</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>Iterator::key</span> &amp;mdash; <span class='dc-title'>Return the key of the current element</span></p> </div> <a name='iterator.key.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'><span class='type scalar'>scalar</span></span> <span class='methodname'><b>Iterator::key</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns the key of the current element. </p> </div> <a name='iterator.key.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iterator.key.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <span class='type scalar'>scalar</span> on success, <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> <i>0</i> on failure. </p> </div> <a name='iterator.key.errors'></a><div class='refsect1 errors'> <h3 class='title'>Errors/Exceptions</h3> <p class='para'> Issues <b><tt class='constant'>E_WARNING</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="Iterator::current" value="<div id='iterator.current' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/iterator.current.php'>Iterator::current</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>Iterator::current</span> &amp;mdash; <span class='dc-title'>Return the current element</span></p> </div> <a name='iterator.current.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <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>Iterator::current</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns the current element. </p> </div> <a name='iterator.current.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='iterator.current.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Can return any type. </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="Iterator" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.iterator.php'>The Iterator interface</a></h1> <div class='partintro'> <div id='iterator.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> Interface for external iterators or objects that can be iterated themselves internally. </p> </div> <div id='iterator.synopsis' class='section'> <h2 class='title'>Interface synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>Iterator</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>Iterator</b> </span> <span class='ooclass'> <span class='modifier'>extends</span> <a href='http://www.php.net/manual/en/class.traversable.php' class='classname'>Traversable</a> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'>mixed</span> <span class='methodname'><a href='http://www.php.net/manual/en/iterator.current.php' class='function'>current</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'>scalar</span> <span class='methodname'><a href='http://www.php.net/manual/en/iterator.key.php' class='function'>key</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iterator.next.php' class='function'>next</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iterator.rewind.php' class='function'>rewind</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>abstract</span> <span class='modifier'>public</span> <span class='type'>boolean</span> <span class='methodname'><a href='http://www.php.net/manual/en/iterator.valid.php' class='function'>valid</a></span> ( <span class='methodparam'>void</span> )</div> }</div> </div> <div id='iterator.examples' class='section'> <div class='example'> <p><b>Example #1 Basic usage</b></p> <div class='example-contents para'><p> This example demonstrates in which order methods are called when using <a href='http://www.php.net/manual/en/control-structures.foreach.php' class='link'>foreach</a> with an iterator. </p></div> <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'>class&amp;nbsp;</span><span style='color: #0000BB'>myIterator&amp;nbsp;</span><span style='color: #007700'>implements&amp;nbsp;</span><span style='color: #0000BB'>Iterator&amp;nbsp;</span><span style='color: #007700'>{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;private&amp;nbsp;</span><span style='color: #0000BB'>$position&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;private&amp;nbsp;</span><span style='color: #0000BB'>$array&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'firstelement'</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: #DD0000'>'secondelement'</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: #DD0000'>'lastelement'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;);&amp;nbsp;&amp;nbsp;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;public&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>__construct</span><span style='color: #007700'>()&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>position&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>rewind</span><span style='color: #007700'>()&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>__METHOD__</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'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>position&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>current</span><span style='color: #007700'>()&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>__METHOD__</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>array</span><span style='color: #007700'>[</span><span style='color: #0000BB'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>position</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>key</span><span style='color: #007700'>()&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>__METHOD__</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>position</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>next</span><span style='color: #007700'>()&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>__METHOD__</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'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>position</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>valid</span><span style='color: #007700'>()&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>__METHOD__</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;isset(</span><span style='color: #0000BB'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>array</span><span style='color: #007700'>[</span><span style='color: #0000BB'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>position</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>$it&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>myIterator</span><span style='color: #007700'>;<br /><br />foreach(</span><span style='color: #0000BB'>$it&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'>$value</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$key</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$value</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&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 something similar to:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> string(18) &amp;quot;myIterator::rewind&amp;quot; string(17) &amp;quot;myIterator::valid&amp;quot; string(19) &amp;quot;myIterator::current&amp;quot; string(15) &amp;quot;myIterator::key&amp;quot; int(0) string(12) &amp;quot;firstelement&amp;quot; string(16) &amp;quot;myIterator::next&amp;quot; string(17) &amp;quot;myIterator::valid&amp;quot; string(19) &amp;quot;myIterator::current&amp;quot; string(15) &amp;quot;myIterator::key&amp;quot; int(1) string(13) &amp;quot;secondelement&amp;quot; string(16) &amp;quot;myIterator::next&amp;quot; string(17) &amp;quot;myIterator::valid&amp;quot; string(19) &amp;quot;myIterator::current&amp;quot; string(15) &amp;quot;myIterator::key&amp;quot; int(2) string(11) &amp;quot;lastelement&amp;quot; string(16) &amp;quot;myIterator::next&amp;quot; string(17) &amp;quot;myIterator::valid&amp;quot; </pre></div> </div> </div> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/iterator.current.php'>Iterator::current</a> &amp;acirc;&amp;#128;&amp;#148; Return the current element</li><li><a href='http://www.php.net/manual/en/iterator.key.php'>Iterator::key</a> &amp;acirc;&amp;#128;&amp;#148; Return the key of the current element</li><li><a href='http://www.php.net/manual/en/iterator.next.php'>Iterator::next</a> &amp;acirc;&amp;#128;&amp;#148; Move forward to next element</li><li><a href='http://www.php.net/manual/en/iterator.rewind.php'>Iterator::rewind</a> &amp;acirc;&amp;#128;&amp;#148; Rewind the Iterator to the first element</li><li><a href='http://www.php.net/manual/en/iterator.valid.php'>Iterator::valid</a> &amp;acirc;&amp;#128;&amp;#148; Checks if current position is valid</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="is_writeable" value="<div id='function.is-writeable' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-writeable.php'>is_writeable</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_writeable</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.is-writable.php' class='function'>is_writable()</a></span></p> </div> <a name='function.is-writeable.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.is-writable.php' class='function'>is_writable()</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="is_writable" value="<div id='function.is-writable' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-writable.php'>is_writable</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_writable</span> &amp;mdash; <span class='dc-title'>Tells whether the filename is writable</span></p> </div> <a name='function.is-writable.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>is_writable</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Returns <b><tt class='constant'>TRUE</tt></b> if the <i><tt class='parameter'>filename</tt></i> exists and is writable. The filename argument may be a directory name allowing you to check if a directory is writable. </p> <p class='para'> Keep in mind that PHP may be accessing the file as the user id that the web server runs as (often &amp;#039;nobody&amp;#039;). Safe mode limitations are not taken into account. </p> </div> <a name='function.is-writable.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 filename being checked. </p> </dd> </dl> <p> </p> </div> <a name='function.is-writable.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 <i><tt class='parameter'>filename</tt></i> exists and is writable. </p> </div> <a name='function.is-writable.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_writable()</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 />$filename&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'test.txt'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_writable</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</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;file&amp;nbsp;is&amp;nbsp;writable'</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'>'The&amp;nbsp;file&amp;nbsp;is&amp;nbsp;not&amp;nbsp;writable'</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.is-writable.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The results of this function are cached. See <a href='http://www.php.net/manual/en/function.clearstatcache.php' class='function'>clearstatcache()</a> for more details.</span></p></blockquote> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>As of PHP 5.0.0, this function can also be used with <em class='emphasis'>some</em> URL wrappers. Refer to <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for a listing of which wrappers support <a href='http://www.php.net/manual/en/function.stat.php' class='function'>stat()</a> family of functionality.</p></div> </div> <a name='function.is-writable.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.is-readable.php' class='function' rel='rdfs-seeAlso'>is_readable()</a> - Tells whether the filename is readable</li> <li class='member'><a href='http://www.php.net/manual/en/function.file-exists.php' class='function' rel='rdfs-seeAlso'>file_exists()</a> - Checks whether a file or directory exists</li> <li class='member'><a href='http://www.php.net/manual/en/function.fwrite.php' class='function' rel='rdfs-seeAlso'>fwrite()</a> - Binary-safe file write</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="is_uploaded_file" value="<div id='function.is-uploaded-file' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-uploaded-file.php'>is_uploaded_file</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.3, PHP 5)</p><p class='refpurpose'><span class='refname'>is_uploaded_file</span> &amp;mdash; <span class='dc-title'>Tells whether the file was uploaded via HTTP POST</span></p> </div> <a name='function.is-uploaded-file.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>is_uploaded_file</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Returns <b><tt class='constant'>TRUE</tt></b> if the file named by <i><tt class='parameter'>filename</tt></i> was uploaded via HTTP POST. This is useful to help ensure that a malicious user hasn&amp;#039;t tried to trick the script into working on files upon which it should not be working--for instance, <var class='filename'>/etc/passwd</var>. </p> <p class='para'> This sort of check is especially important if there is any chance that anything done with uploaded files could reveal their contents to the user, or even to other users on the same system. </p> <p class='para'> For proper working, the function <b>is_uploaded_file()</b> needs an argument like <var class='varname'><a href='http://www.php.net/manual/en/reserved.variables.files.php' class='classname'>$_FILES['userfile']['tmp_name']</a></var>, - the name of the uploaded file on the clients machine <var class='varname'><a href='http://www.php.net/manual/en/reserved.variables.files.php' class='classname'>$_FILES['userfile']['name']</a></var> does not work. </p> </div> <a name='function.is-uploaded-file.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 filename being checked. </p> </dd> </dl> <p> </p> </div> <a name='function.is-uploaded-file.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.is-uploaded-file.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_uploaded_file()</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'>if&amp;nbsp;(</span><span style='color: #0000BB'>is_uploaded_file</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$_FILES</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'userfile'</span><span style='color: #007700'>][</span><span style='color: #DD0000'>'tmp_name'</span><span style='color: #007700'>]))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'File&amp;nbsp;'</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$_FILES</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'userfile'</span><span style='color: #007700'>][</span><span style='color: #DD0000'>'name'</span><span style='color: #007700'>]&amp;nbsp;.</span><span style='color: #DD0000'>'&amp;nbsp;uploaded&amp;nbsp;successfully.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Displaying&amp;nbsp;contents\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>readfile</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$_FILES</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'userfile'</span><span style='color: #007700'>][</span><span style='color: #DD0000'>'tmp_name'</span><span style='color: #007700'>]);<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Possible&amp;nbsp;file&amp;nbsp;upload&amp;nbsp;attack:&amp;nbsp;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'filename&amp;nbsp;''</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$_FILES</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'userfile'</span><span style='color: #007700'>][</span><span style='color: #DD0000'>'tmp_name'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>''.'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.is-uploaded-file.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.move-uploaded-file.php' class='function' rel='rdfs-seeAlso'>move_uploaded_file()</a> - Moves an uploaded file to a new location</li> <li class='member'><var class='varname'><a href='http://www.php.net/manual/en/reserved.variables.files.php' class='classname'>$_FILES</a></var></li> <li class='member'>See <a href='http://www.php.net/manual/en/features.file-upload.php' class='link'>Handling file uploads</a>for a simple usage example.</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="is_subclass_of" value="<div id='function.is-subclass-of' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-subclass-of.php'>is_subclass_of</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_subclass_of</span> &amp;mdash; <span class='dc-title'>Checks if the object has this class as one of its parents</span></p> </div> <a name='function.is-subclass-of.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>is_subclass_of</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'>$object</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$class_name</tt></span> )</div> <p class='para rdfs-comment'> Checks if the given <i><tt class='parameter'>object</tt></i> has the class <i><tt class='parameter'>class_name</tt></i> as one of its parents. </p> </div> <a name='function.is-subclass-of.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'> A class name or an object instance </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>class_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The class name </p> </dd> </dl> <p> </p> </div> <a name='function.is-subclass-of.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 object <i><tt class='parameter'>object</tt></i> , belongs to a class which is a subclass of <i><tt class='parameter'>class_name</tt></i> , <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-subclass-of.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.3</td> <td align='left'> You may also specify the <i><tt class='parameter'>object</tt></i> parameter as a string (the name of the class) </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.is-subclass-of.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_subclass_of()</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;define&amp;nbsp;a&amp;nbsp;class<br /></span><span style='color: #007700'>class&amp;nbsp;</span><span style='color: #0000BB'>WidgetFactory<br /></span><span style='color: #007700'>{<br />&amp;nbsp;&amp;nbsp;var&amp;nbsp;</span><span style='color: #0000BB'>$oink&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'moo'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;define&amp;nbsp;a&amp;nbsp;child&amp;nbsp;class<br /></span><span style='color: #007700'>class&amp;nbsp;</span><span style='color: #0000BB'>WidgetFactory_Child&amp;nbsp;</span><span style='color: #007700'>extends&amp;nbsp;</span><span style='color: #0000BB'>WidgetFactory<br /></span><span style='color: #007700'>{<br />&amp;nbsp;&amp;nbsp;var&amp;nbsp;</span><span style='color: #0000BB'>$oink&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'oink'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;object<br /></span><span style='color: #0000BB'>$WF&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>WidgetFactory</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>$WFC&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>WidgetFactory_Child</span><span style='color: #007700'>();<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_subclass_of</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$WFC</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'WidgetFactory'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'yes,&amp;nbsp;\$WFC&amp;nbsp;is&amp;nbsp;a&amp;nbsp;subclass&amp;nbsp;of&amp;nbsp;WidgetFactory\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'>'no,&amp;nbsp;\$WFC&amp;nbsp;is&amp;nbsp;not&amp;nbsp;a&amp;nbsp;subclass&amp;nbsp;of&amp;nbsp;WidgetFactory\n'</span><span style='color: #007700'>;<br />}<br /><br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_subclass_of</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$WF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'WidgetFactory'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'yes,&amp;nbsp;\$WF&amp;nbsp;is&amp;nbsp;a&amp;nbsp;subclass&amp;nbsp;of&amp;nbsp;WidgetFactory\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'>'no,&amp;nbsp;\$WF&amp;nbsp;is&amp;nbsp;not&amp;nbsp;a&amp;nbsp;subclass&amp;nbsp;of&amp;nbsp;WidgetFactory\n'</span><span style='color: #007700'>;<br />}<br /><br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;usable&amp;nbsp;only&amp;nbsp;since&amp;nbsp;PHP&amp;nbsp;5.0.3<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>is_subclass_of</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'WidgetFactory_Child'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'WidgetFactory'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'yes,&amp;nbsp;WidgetFactory_Child&amp;nbsp;is&amp;nbsp;a&amp;nbsp;subclass&amp;nbsp;of&amp;nbsp;WidgetFactory\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'>'no,&amp;nbsp;WidgetFactory_Child&amp;nbsp;is&amp;nbsp;not&amp;nbsp;a&amp;nbsp;subclass&amp;nbsp;of&amp;nbsp;WidgetFactory\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> yes, $WFC is a subclass of WidgetFactory no, $WF is not a subclass of WidgetFactory yes, WidgetFactory_Child is a subclass of WidgetFactory </pre></div> </div> </div><p> </p> </div> <a name='function.is-subclass-of.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.get-class.php' class='function' rel='rdfs-seeAlso'>get_class()</a> - Returns the name of the class of an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.get-parent-class.php' class='function' rel='rdfs-seeAlso'>get_parent_class()</a> - Retrieves the parent class name for object or class</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-a.php' class='function' rel='rdfs-seeAlso'>is_a()</a> - Checks if the object is of this class or has this class as one of its parents</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="is_string" value="<div id='function.is-string' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-string.php'>is_string</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_string</span> &amp;mdash; <span class='dc-title'>Find whether the type of a variable is string</span></p> </div> <a name='function.is-string.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>is_string</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'>$var</tt></span> )</div> <p class='para rdfs-comment'> Finds whether the type given variable is string. </p> </div> <a name='function.is-string.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable being evaluated. </p> </dd> </dl> <p> </p> </div> <a name='function.is-string.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'>var</tt></i> is of type <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-string.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_string()</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'>is_string</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'23'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'is&amp;nbsp;string\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'is&amp;nbsp;not&amp;nbsp;an&amp;nbsp;string\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_string</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'abc'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_string</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'23'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>23.5</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>true</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> is string bool(true) bool(true) bool(false) bool(false) </pre></div> </div> </div><p> </p> </div> <a name='function.is-string.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.is-float.php' class='function' rel='rdfs-seeAlso'>is_float()</a> - Finds whether the type of a variable is float</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-int.php' class='function' rel='rdfs-seeAlso'>is_int()</a> - Find whether the type of a variable is integer</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-bool.php' class='function' rel='rdfs-seeAlso'>is_bool()</a> - Finds out whether a variable is a boolean</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-object.php' class='function' rel='rdfs-seeAlso'>is_object()</a> - Finds whether a variable is an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-array.php' class='function' rel='rdfs-seeAlso'>is_array()</a> - Finds whether a variable is an array</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="is_scalar" value="<div id='function.is-scalar' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-scalar.php'>is_scalar</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>is_scalar</span> &amp;mdash; <span class='dc-title'> Finds whether a variable is a scalar </span></p> </div> <a name='function.is-scalar.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>is_scalar</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'>$var</tt></span> )</div> <p class='para rdfs-comment'> Finds whether the given variable is a scalar. </p> <p class='para'> Scalar variables are those containing an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a>, <a href='http://www.php.net/manual/en/language.types.float.php' class='type float'>float</a>, <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> or <a href='http://www.php.net/manual/en/language.types.boolean.php' class='type boolean'>boolean</a>. Types <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>, <a href='http://www.php.net/manual/en/language.types.object.php' class='type object'>object</a> and <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> are not scalar. </p> <blockquote><p><b class='note'>Note</b>: <b>is_scalar()</b> does not consider <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> type values to be scalar as resources are abstract datatypes which are currently based on integers. This implementation detail should not be relied upon, as it may change. <br /> </p></blockquote> </div> <a name='function.is-scalar.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable being evaluated. </p> </dd> </dl> <p> </p> </div> <a name='function.is-scalar.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'>var</tt></i> is a scalar <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-scalar.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_scalar()</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'>function&amp;nbsp;</span><span style='color: #0000BB'>show_var</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$var</span><span style='color: #007700'>)&amp;nbsp;<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>is_scalar</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$var</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'>$var</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;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$var</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>$pi&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>3.1416</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$proteins&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'hemoglobin'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'cytochrome&amp;nbsp;c&amp;nbsp;oxidase'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ferredoxin'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>show_var</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pi</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>show_var</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$proteins</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> 3.1416 array(3) { [0]=&amp;gt; string(10) &amp;quot;hemoglobin&amp;quot; [1]=&amp;gt; string(20) &amp;quot;cytochrome c oxidase&amp;quot; [2]=&amp;gt; string(10) &amp;quot;ferredoxin&amp;quot; } </pre></div> </div> </div><p> </p> </div> <a name='function.is-scalar.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.is-float.php' class='function' rel='rdfs-seeAlso'>is_float()</a> - Finds whether the type of a variable is float</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-int.php' class='function' rel='rdfs-seeAlso'>is_int()</a> - Find whether the type of a variable is integer</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-numeric.php' class='function' rel='rdfs-seeAlso'>is_numeric()</a> - Finds whether a variable is a number or a numeric string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-real.php' class='function' rel='rdfs-seeAlso'>is_real()</a> - Alias of is_float</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-string.php' class='function' rel='rdfs-seeAlso'>is_string()</a> - Find whether the type of a variable is string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-bool.php' class='function' rel='rdfs-seeAlso'>is_bool()</a> - Finds out whether a variable is a boolean</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-object.php' class='function' rel='rdfs-seeAlso'>is_object()</a> - Finds whether a variable is an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-array.php' class='function' rel='rdfs-seeAlso'>is_array()</a> - Finds whether a variable is an array</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="is_resource" value="<div id='function.is-resource' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-resource.php'>is_resource</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_resource</span> &amp;mdash; <span class='dc-title'> Finds whether a variable is a resource </span></p> </div> <a name='function.is-resource.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>is_resource</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'>$var</tt></span> )</div> <p class='para rdfs-comment'> Finds whether the given variable is a resource. </p> </div> <a name='function.is-resource.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable being evaluated. </p> </dd> </dl> <p> </p> </div> <a name='function.is-resource.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'>var</tt></i> is a <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-resource.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_resource()</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 />$db_link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>mysql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mysql_pass'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>is_resource</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db_link</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Can\'t&amp;nbsp;connect&amp;nbsp;:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mysql_error</span><span style='color: #007700'>());<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.is-resource.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/language.types.resource.php' class='link'>The resource-type documentation</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.get-resource-type.php' class='function' rel='rdfs-seeAlso'>get_resource_type()</a> - Returns the resource type</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="is_real" value="<div id='function.is-real' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-real.php'>is_real</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_real</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.is-float.php' class='function'>is_float()</a></span></p> </div> <a name='function.is-real.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.is-float.php' class='function'>is_float()</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="is_readable" value="<div id='function.is-readable' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-readable.php'>is_readable</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_readable</span> &amp;mdash; <span class='dc-title'>Tells whether the filename is readable</span></p> </div> <a name='function.is-readable.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>is_readable</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Tells whether the filename is readable. </p> </div> <a name='function.is-readable.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 file. </p> </dd> </dl> <p> </p> </div> <a name='function.is-readable.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 file or directory specified by <i><tt class='parameter'>filename</tt></i> exists and is readable, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-readable.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_readable()</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 />$filename&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'test.txt'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_readable</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</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;file&amp;nbsp;is&amp;nbsp;readable'</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'>'The&amp;nbsp;file&amp;nbsp;is&amp;nbsp;not&amp;nbsp;readable'</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.is-readable.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <p class='para'> Keep in mind that PHP may be accessing the file as the user id that the web server runs as (often &amp;#039;nobody&amp;#039;). Safe mode limitations are not taken into account before PHP 5.1.5. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The results of this function are cached. See <a href='http://www.php.net/manual/en/function.clearstatcache.php' class='function'>clearstatcache()</a> for more details.</span></p></blockquote> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>As of PHP 5.0.0, this function can also be used with <em class='emphasis'>some</em> URL wrappers. Refer to <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for a listing of which wrappers support <a href='http://www.php.net/manual/en/function.stat.php' class='function'>stat()</a> family of functionality.</p></div> <blockquote><p><b class='note'>Note</b>: The check is done using the real UID/GID instead of the effective one. <br /> </p></blockquote> </div> <a name='function.is-readable.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.is-writable.php' class='function' rel='rdfs-seeAlso'>is_writable()</a> - Tells whether the filename is writable</li> <li class='member'><a href='http://www.php.net/manual/en/function.file-exists.php' class='function' rel='rdfs-seeAlso'>file_exists()</a> - Checks whether a file or directory exists</li> <li class='member'><a href='http://www.php.net/manual/en/function.fgets.php' class='function' rel='rdfs-seeAlso'>fgets()</a> - Gets line from file pointer</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="is_object" value="<div id='function.is-object' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-object.php'>is_object</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_object</span> &amp;mdash; <span class='dc-title'>Finds whether a variable is an object</span></p> </div> <a name='function.is-object.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>is_object</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'>$var</tt></span> )</div> <p class='para rdfs-comment'> Finds whether the given variable is an object. </p> </div> <a name='function.is-object.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable being evaluated. </p> </dd> </dl> <p> </p> </div> <a name='function.is-object.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'>var</tt></i> is an <a href='http://www.php.net/manual/en/language.types.object.php' class='type object'>object</a>, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-object.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_object()</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;Declare&amp;nbsp;a&amp;nbsp;simple&amp;nbsp;function&amp;nbsp;to&amp;nbsp;return&amp;nbsp;an&amp;nbsp;<br />//&amp;nbsp;array&amp;nbsp;from&amp;nbsp;our&amp;nbsp;object<br /></span><span style='color: #007700'>function&amp;nbsp;</span><span style='color: #0000BB'>get_students</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$obj</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if(!</span><span style='color: #0000BB'>is_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$obj</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return(</span><span style='color: #0000BB'>false</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return(</span><span style='color: #0000BB'>$obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>students</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Declare&amp;nbsp;a&amp;nbsp;new&amp;nbsp;class&amp;nbsp;instance&amp;nbsp;and&amp;nbsp;fill&amp;nbsp;up&amp;nbsp;<br />//&amp;nbsp;some&amp;nbsp;values<br /></span><span style='color: #0000BB'>$obj&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>stdClass</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$obj</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>students&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;Array(</span><span style='color: #DD0000'>'Kalle'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Ross'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Felipe'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>get_students</span><span style='color: #007700'>(</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>get_students</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$obj</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.is-object.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function will return <b><tt class='constant'>FALSE</tt></b> if used on an unserialized object where the class definition is not present (even though <a href='http://www.php.net/manual/en/function.gettype.php' class='function'>gettype()</a> returns <a href='http://www.php.net/manual/en/language.types.object.php' class='type object'>object</a>). <br /> </p></blockquote> </div> <a name='function.is-object.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.is-bool.php' class='function' rel='rdfs-seeAlso'>is_bool()</a> - Finds out whether a variable is a boolean</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-int.php' class='function' rel='rdfs-seeAlso'>is_int()</a> - Find whether the type of a variable is integer</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-float.php' class='function' rel='rdfs-seeAlso'>is_float()</a> - Finds whether the type of a variable is float</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-string.php' class='function' rel='rdfs-seeAlso'>is_string()</a> - Find whether the type of a variable is string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-array.php' class='function' rel='rdfs-seeAlso'>is_array()</a> - Finds whether a variable is an array</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="is_numeric" value="<div id='function.is-numeric' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-numeric.php'>is_numeric</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_numeric</span> &amp;mdash; <span class='dc-title'> Finds whether a variable is a number or a numeric string </span></p> </div> <a name='function.is-numeric.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>is_numeric</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'>$var</tt></span> )</div> <p class='para rdfs-comment'> Finds whether the given variable is numeric. Numeric strings consist of optional sign, any number of digits, optional decimal part and optional exponential part. Thus <i>+0123.45e6</i> is a valid numeric value. Hexadecimal notation (<i>0xFF</i>) is allowed too but only without sign, decimal and exponential part. </p> </div> <a name='function.is-numeric.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable being evaluated. </p> </dd> </dl> <p> </p> </div> <a name='function.is-numeric.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'>var</tt></i> is a number or a numeric string, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-numeric.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_numeric()</b> examples</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$tests&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;Array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'42'</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>1337</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'1e4'</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'not&amp;nbsp;numeric'</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;Array(),&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>9.1<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>);<br /><br />foreach(</span><span style='color: #0000BB'>$tests&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$element</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if(</span><span style='color: #0000BB'>is_numeric</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$element</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&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: #007700'>{</span><span style='color: #0000BB'>$element</span><span style='color: #007700'>}</span><span style='color: #DD0000'>'&amp;nbsp;is&amp;nbsp;numeric'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;else<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&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: #007700'>{</span><span style='color: #0000BB'>$element</span><span style='color: #007700'>}</span><span style='color: #DD0000'>'&amp;nbsp;is&amp;nbsp;NOT&amp;nbsp;numeric'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</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><p> </p> </div> <a name='function.is-numeric.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.ctype-digit.php' class='function' rel='rdfs-seeAlso'>ctype_digit()</a> - Check for numeric character(s)</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-bool.php' class='function' rel='rdfs-seeAlso'>is_bool()</a> - Finds out whether a variable is a boolean</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-null.php' class='function' rel='rdfs-seeAlso'>is_null()</a> - Finds whether a variable is NULL</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-float.php' class='function' rel='rdfs-seeAlso'>is_float()</a> - Finds whether the type of a variable is float</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-int.php' class='function' rel='rdfs-seeAlso'>is_int()</a> - Find whether the type of a variable is integer</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-string.php' class='function' rel='rdfs-seeAlso'>is_string()</a> - Find whether the type of a variable is string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-object.php' class='function' rel='rdfs-seeAlso'>is_object()</a> - Finds whether a variable is an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-array.php' class='function' rel='rdfs-seeAlso'>is_array()</a> - Finds whether a variable is an array</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="is_null" value="<div id='function.is-null' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-null.php'>is_null</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_null</span> &amp;mdash; <span class='dc-title'> Finds whether a variable is <b><tt class='constant'>NULL</tt></b> </span></p> </div> <a name='function.is-null.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>is_null</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'>$var</tt></span> )</div> <p class='para rdfs-comment'> Finds whether the given variable is <b><tt class='constant'>NULL</tt></b>. </p> </div> <a name='function.is-null.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable being evaluated. </p> </dd> </dl> <p> </p> </div> <a name='function.is-null.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'>var</tt></i> is <a href='http://www.php.net/manual/en/language.types.null.php' class='type null'>null</a>, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-null.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_null()</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 />error_reporting</span><span style='color: #007700'>(</span><span style='color: #0000BB'>E_ALL</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$foo&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'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_null</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$inexistent</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>is_null</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$foo</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents screen'> <div class='cdata'><pre> Notice: Undefined variable: inexistent in ... bool(true) bool(true) </pre></div> </div> </div><p> </p> </div> <a name='function.is-null.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'>The <a href='http://www.php.net/manual/en/language.types.null.php#language.types.null.syntax' class='link'><b><tt class='constant'>NULL</tt></b></a> type</li> <li class='member'><a href='http://www.php.net/manual/en/function.isset.php' class='function' rel='rdfs-seeAlso'>isset()</a> - Determine if a variable is set and is not NULL</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-bool.php' class='function' rel='rdfs-seeAlso'>is_bool()</a> - Finds out whether a variable is a boolean</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-numeric.php' class='function' rel='rdfs-seeAlso'>is_numeric()</a> - Finds whether a variable is a number or a numeric string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-float.php' class='function' rel='rdfs-seeAlso'>is_float()</a> - Finds whether the type of a variable is float</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-int.php' class='function' rel='rdfs-seeAlso'>is_int()</a> - Find whether the type of a variable is integer</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-string.php' class='function' rel='rdfs-seeAlso'>is_string()</a> - Find whether the type of a variable is string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-object.php' class='function' rel='rdfs-seeAlso'>is_object()</a> - Finds whether a variable is an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-array.php' class='function' rel='rdfs-seeAlso'>is_array()</a> - Finds whether a variable is an array</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="is_nan" value="<div id='function.is-nan' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-nan.php'>is_nan</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>is_nan</span> &amp;mdash; <span class='dc-title'>Finds whether a value is not a number</span></p> </div> <a name='function.is-nan.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>is_nan</b></span> ( <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$val</tt></span> )</div> <p class='para rdfs-comment'> Checks whether <i><tt class='parameter'>val</tt></i> is &amp;#039;not a number&amp;#039;, like the result of <i>acos(1.01)</i>. </p> </div> <a name='function.is-nan.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'>val</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value to check </p> </dd> </dl> <p> </p> </div> <a name='function.is-nan.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'>val</tt></i> is &amp;#039;not a number&amp;#039;, else <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.is-nan.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_nan()</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;Invalid&amp;nbsp;calculation,&amp;nbsp;will&amp;nbsp;return&amp;nbsp;a&amp;nbsp;<br />//&amp;nbsp;NaN&amp;nbsp;value<br /></span><span style='color: #0000BB'>$nan&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>acos</span><span style='color: #007700'>(</span><span style='color: #0000BB'>8</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$nan</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>is_nan</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$nan</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> float(NAN) bool(true) </pre></div> </div> </div><p> </p> </div> <a name='function.is-nan.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.is-finite.php' class='function' rel='rdfs-seeAlso'>is_finite()</a> - Finds whether a value is a legal finite number</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-infinite.php' class='function' rel='rdfs-seeAlso'>is_infinite()</a> - Finds whether a value is infinite</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="is_long" value="<div id='function.is-long' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-long.php'>is_long</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_long</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.is-int.php' class='function'>is_int()</a></span></p> </div> <a name='function.is-long.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.is-int.php' class='function'>is_int()</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="is_link" value="<div id='function.is-link' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-link.php'>is_link</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_link</span> &amp;mdash; <span class='dc-title'>Tells whether the filename is a symbolic link</span></p> </div> <a name='function.is-link.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>is_link</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Tells whether the given file is a symbolic link. </p> </div> <a name='function.is-link.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 file. </p> </dd> </dl> <p> </p> </div> <a name='function.is-link.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 filename exists and is a symbolic link, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-link.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Create and confirm if a file is a symbolic link</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'uploads'</span><span style='color: #007700'>;<br /><br />if(</span><span style='color: #0000BB'>is_link</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo(</span><span style='color: #0000BB'>readlink</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>));<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>symlink</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'uploads.php'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</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.is-link.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The results of this function are cached. See <a href='http://www.php.net/manual/en/function.clearstatcache.php' class='function'>clearstatcache()</a> for more details.</span></p></blockquote> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>As of PHP 5.0.0, this function can also be used with <em class='emphasis'>some</em> URL wrappers. Refer to <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for a listing of which wrappers support <a href='http://www.php.net/manual/en/function.stat.php' class='function'>stat()</a> family of functionality.</p></div> </div> <a name='function.is-link.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.is-dir.php' class='function' rel='rdfs-seeAlso'>is_dir()</a> - Tells whether the filename is a directory</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-file.php' class='function' rel='rdfs-seeAlso'>is_file()</a> - Tells whether the filename is a regular file</li> <li class='member'><a href='http://www.php.net/manual/en/function.readlink.php' class='function' rel='rdfs-seeAlso'>readlink()</a> - Returns the target of a symbolic link</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="is_integer" value="<div id='function.is-integer' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-integer.php'>is_integer</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_integer</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.is-int.php' class='function'>is_int()</a></span></p> </div> <a name='function.is-integer.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.is-int.php' class='function'>is_int()</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="is_int" value="<div id='function.is-int' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-int.php'>is_int</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_int</span> &amp;mdash; <span class='dc-title'>Find whether the type of a variable is integer</span></p> </div> <a name='function.is-int.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>is_int</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'>$var</tt></span> )</div> <p class='para rdfs-comment'> Finds whether the type of the given variable is integer. </p> <blockquote><p><b class='note'>Note</b>: To test if a variable is a number or a numeric string (such as form input, which is always a string), you must use <a href='http://www.php.net/manual/en/function.is-numeric.php' class='function'>is_numeric()</a>. <br /> </p></blockquote> </div> <a name='function.is-int.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable being evaluated. </p> </dd> </dl> <p> </p> </div> <a name='function.is-int.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'>var</tt></i> is an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a>, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-int.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_int()</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'>is_int</span><span style='color: #007700'>(</span><span style='color: #0000BB'>23</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'is&amp;nbsp;integer\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'is&amp;nbsp;not&amp;nbsp;an&amp;nbsp;integer\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_int</span><span style='color: #007700'>(</span><span style='color: #0000BB'>23</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_int</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'23'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_int</span><span style='color: #007700'>(</span><span style='color: #0000BB'>23.5</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_int</span><span style='color: #007700'>(</span><span style='color: #0000BB'>true</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> is integer bool(true) bool(false) bool(false) bool(false) </pre></div> </div> </div><p> </p> </div> <a name='function.is-int.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.is-bool.php' class='function' rel='rdfs-seeAlso'>is_bool()</a> - Finds out whether a variable is a boolean</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-float.php' class='function' rel='rdfs-seeAlso'>is_float()</a> - Finds whether the type of a variable is float</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-numeric.php' class='function' rel='rdfs-seeAlso'>is_numeric()</a> - Finds whether a variable is a number or a numeric string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-string.php' class='function' rel='rdfs-seeAlso'>is_string()</a> - Find whether the type of a variable is string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-array.php' class='function' rel='rdfs-seeAlso'>is_array()</a> - Finds whether a variable is an array</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-object.php' class='function' rel='rdfs-seeAlso'>is_object()</a> - Finds whether a variable is an object</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="is_infinite" value="<div id='function.is-infinite' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-infinite.php'>is_infinite</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>is_infinite</span> &amp;mdash; <span class='dc-title'>Finds whether a value is infinite</span></p> </div> <a name='function.is-infinite.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>is_infinite</b></span> ( <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$val</tt></span> )</div> <p class='para rdfs-comment'> Returns <b><tt class='constant'>TRUE</tt></b> if <i><tt class='parameter'>val</tt></i> is infinite (positive or negative), like the result of <i>log(0)</i> or any value too big to fit into a float on this platform. </p> </div> <a name='function.is-infinite.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'>val</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value to check </p> </dd> </dl> <p> </p> </div> <a name='function.is-infinite.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b><tt class='constant'>TRUE</tt></b> if <i><tt class='parameter'>val</tt></i> is infinite, else <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.is-infinite.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.is-finite.php' class='function' rel='rdfs-seeAlso'>is_finite()</a> - Finds whether a value is a legal finite number</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-nan.php' class='function' rel='rdfs-seeAlso'>is_nan()</a> - Finds whether a value is not a 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="is_float" value="<div id='function.is-float' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-float.php'>is_float</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_float</span> &amp;mdash; <span class='dc-title'>Finds whether the type of a variable is float</span></p> </div> <a name='function.is-float.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>is_float</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'>$var</tt></span> )</div> <p class='para rdfs-comment'> Finds whether the type of the given variable is float. </p> <blockquote><p><b class='note'>Note</b>: To test if a variable is a number or a numeric string (such as form input, which is always a string), you must use <a href='http://www.php.net/manual/en/function.is-numeric.php' class='function'>is_numeric()</a>. <br /> </p></blockquote> </div> <a name='function.is-float.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable being evaluated. </p> </dd> </dl> <p> </p> </div> <a name='function.is-float.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'>var</tt></i> is a <a href='http://www.php.net/manual/en/language.types.float.php' class='type float'>float</a>, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-float.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_float()</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(</span><span style='color: #0000BB'>is_float</span><span style='color: #007700'>(</span><span style='color: #0000BB'>27.25</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'is&amp;nbsp;float\n'</span><span style='color: #007700'>;<br />}else&amp;nbsp;{<br />&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'is&amp;nbsp;not&amp;nbsp;float\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_float</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'abc'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_float</span><span style='color: #007700'>(</span><span style='color: #0000BB'>23</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_float</span><span style='color: #007700'>(</span><span style='color: #0000BB'>23.5</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_float</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1e7</span><span style='color: #007700'>));&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//Scientific&amp;nbsp;Notation<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_float</span><span style='color: #007700'>(</span><span style='color: #0000BB'>true</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> is float bool(false) bool(false) bool(true) bool(true) bool(false) </pre></div> </div> </div><p> </p> </div> <a name='function.is-float.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.is-bool.php' class='function' rel='rdfs-seeAlso'>is_bool()</a> - Finds out whether a variable is a boolean</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-int.php' class='function' rel='rdfs-seeAlso'>is_int()</a> - Find whether the type of a variable is integer</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-numeric.php' class='function' rel='rdfs-seeAlso'>is_numeric()</a> - Finds whether a variable is a number or a numeric string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-string.php' class='function' rel='rdfs-seeAlso'>is_string()</a> - Find whether the type of a variable is string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-array.php' class='function' rel='rdfs-seeAlso'>is_array()</a> - Finds whether a variable is an array</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-object.php' class='function' rel='rdfs-seeAlso'>is_object()</a> - Finds whether a variable is an object</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="is_finite" value="<div id='function.is-finite' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-finite.php'>is_finite</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>is_finite</span> &amp;mdash; <span class='dc-title'>Finds whether a value is a legal finite number</span></p> </div> <a name='function.is-finite.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>is_finite</b></span> ( <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$val</tt></span> )</div> <p class='para rdfs-comment'> Checks whether <i><tt class='parameter'>val</tt></i> is a legal finite on this platform. </p> </div> <a name='function.is-finite.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'>val</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value to check </p> </dd> </dl> <p> </p> </div> <a name='function.is-finite.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b><tt class='constant'>TRUE</tt></b> if <i><tt class='parameter'>val</tt></i> is a legal finite number within the allowed range for a PHP float on this platform, else <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.is-finite.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.is-infinite.php' class='function' rel='rdfs-seeAlso'>is_infinite()</a> - Finds whether a value is infinite</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-nan.php' class='function' rel='rdfs-seeAlso'>is_nan()</a> - Finds whether a value is not a 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="is_file" value="<div id='function.is-file' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-file.php'>is_file</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_file</span> &amp;mdash; <span class='dc-title'>Tells whether the filename is a regular file</span></p> </div> <a name='function.is-file.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>is_file</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Tells whether the given file is a regular file. </p> </div> <a name='function.is-file.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 file. </p> </dd> </dl> <p> </p> </div> <a name='function.is-file.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 filename exists and is a regular file, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-file.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_file()</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 />var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_file</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'a_file.txt'</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'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_file</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'/usr/bin/'</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> bool(true) bool(false) </pre></div> </div> </div><p> </p> </div> <a name='function.is-file.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The results of this function are cached. See <a href='http://www.php.net/manual/en/function.clearstatcache.php' class='function'>clearstatcache()</a> for more details.</span></p></blockquote> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>As of PHP 5.0.0, this function can also be used with <em class='emphasis'>some</em> URL wrappers. Refer to <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for a listing of which wrappers support <a href='http://www.php.net/manual/en/function.stat.php' class='function'>stat()</a> family of functionality.</p></div> </div> <a name='function.is-file.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.is-dir.php' class='function' rel='rdfs-seeAlso'>is_dir()</a> - Tells whether the filename is a directory</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-link.php' class='function' rel='rdfs-seeAlso'>is_link()</a> - Tells whether the filename is a symbolic link</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="is_executable" value="<div id='function.is-executable' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-executable.php'>is_executable</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_executable</span> &amp;mdash; <span class='dc-title'>Tells whether the filename is executable</span></p> </div> <a name='function.is-executable.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>is_executable</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Tells whether the filename is executable. </p> </div> <a name='function.is-executable.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 file. </p> </dd> </dl> <p> </p> </div> <a name='function.is-executable.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 filename exists and is executable, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.is-executable.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'> <b>is_executable()</b> became available with <span class='productname'>Windows</span> </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.is-executable.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_executable()</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/vincent/somefile.sh'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_executable</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>.</span><span style='color: #DD0000'>'&amp;nbsp;is&amp;nbsp;executable'</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: #0000BB'>$file</span><span style='color: #007700'>.</span><span style='color: #DD0000'>'&amp;nbsp;is&amp;nbsp;not&amp;nbsp;executable'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.is-executable.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The results of this function are cached. See <a href='http://www.php.net/manual/en/function.clearstatcache.php' class='function'>clearstatcache()</a> for more details.</span></p></blockquote> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>As of PHP 5.0.0, this function can also be used with <em class='emphasis'>some</em> URL wrappers. Refer to <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for a listing of which wrappers support <a href='http://www.php.net/manual/en/function.stat.php' class='function'>stat()</a> family of functionality.</p></div> </div> <a name='function.is-executable.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.is-file.php' class='function' rel='rdfs-seeAlso'>is_file()</a> - Tells whether the filename is a regular file</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-link.php' class='function' rel='rdfs-seeAlso'>is_link()</a> - Tells whether the filename is a symbolic link</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="is_double" value="<div id='function.is-double' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-double.php'>is_double</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_double</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.is-float.php' class='function'>is_float()</a></span></p> </div> <a name='function.is-double.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.is-float.php' class='function'>is_float()</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="is_dir" value="<div id='function.is-dir' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-dir.php'>is_dir</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_dir</span> &amp;mdash; <span class='dc-title'>Tells whether the filename is a directory</span></p> </div> <a name='function.is-dir.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>is_dir</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Tells whether the given filename is a directory. </p> </div> <a name='function.is-dir.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 file. If <i><tt class='parameter'>filename</tt></i> is a relative filename, it will be checked relative to the current working directory. If <i><tt class='parameter'>filename</tt></i> is a symbolic or hard link then the link will be resolved and checked. </p> </dd> </dl> <p> </p> </div> <a name='function.is-dir.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 filename exists and is a directory, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-dir.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_dir()</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 />var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_dir</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'a_file.txt'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_dir</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'bogus_dir/abc'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_dir</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'..'</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//one&amp;nbsp;dir&amp;nbsp;up<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(false) bool(true) </pre></div> </div> </div><p> </p> </div> <a name='function.is-dir.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>The results of this function are cached. See <a href='http://www.php.net/manual/en/function.clearstatcache.php' class='function'>clearstatcache()</a> for more details.</span></p></blockquote> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>As of PHP 5.0.0, this function can also be used with <em class='emphasis'>some</em> URL wrappers. Refer to <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for a listing of which wrappers support <a href='http://www.php.net/manual/en/function.stat.php' class='function'>stat()</a> family of functionality.</p></div> </div> <a name='function.is-dir.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.chdir.php' class='function' rel='rdfs-seeAlso'>chdir()</a> - Change directory</li> <li class='member'><a href='http://www.php.net/manual/en/class.dir.php' class='link'>dir</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.opendir.php' class='function' rel='rdfs-seeAlso'>opendir()</a> - Open directory handle</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-file.php' class='function' rel='rdfs-seeAlso'>is_file()</a> - Tells whether the filename is a regular file</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-link.php' class='function' rel='rdfs-seeAlso'>is_link()</a> - Tells whether the filename is a symbolic link</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="is_callable" value="<div id='function.is-callable' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-callable.php'>is_callable</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>is_callable</span> &amp;mdash; <span class='dc-title'> Verify that the contents of a variable can be called as a function </span></p> </div> <a name='function.is-callable.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>is_callable</b></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'>$name</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$syntax_only</tt><span class='initializer'> = false</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter reference'>&amp;amp;$callable_name</tt></span> ]] )</div> <p class='para rdfs-comment'> Verify that the contents of a variable can be called as a function. This can check that a simple variable contains the name of a valid function, or that an array contains a properly encoded object and function name. </p> </div> <a name='function.is-callable.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'>name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be either the name of a function stored in a string variable, or an object and the name of a method within the object, like this: <div class='example-contents screen'>array($SomeObject, &amp;#039;MethodName&amp;#039;)</div> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>syntax_only</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If set to <b><tt class='constant'>TRUE</tt></b> the function only verifies that <i><tt class='parameter'>name</tt></i> might be a function or method. It will only reject simple variables that are not strings, or an array that does not have a valid structure to be used as a callback. The valid ones are supposed to have only 2 entries, the first of which is an object or a string, and the second a string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>callable_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Receives the &amp;quot;callable name&amp;quot;. In the example below it is &amp;quot;someClass::someMethod&amp;quot;. Note, however, that despite the implication that someClass::SomeMethod() is a callable static method, this is not the case. </p> </dd> </dl> <p> </p> </div> <a name='function.is-callable.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'>name</tt></i> is callable, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-callable.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_callable()</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;&amp;nbsp;How&amp;nbsp;to&amp;nbsp;check&amp;nbsp;a&amp;nbsp;variable&amp;nbsp;to&amp;nbsp;see&amp;nbsp;if&amp;nbsp;it&amp;nbsp;can&amp;nbsp;be&amp;nbsp;called<br />//&amp;nbsp;&amp;nbsp;as&amp;nbsp;a&amp;nbsp;function.<br /><br />//<br />//&amp;nbsp;&amp;nbsp;Simple&amp;nbsp;variable&amp;nbsp;containing&amp;nbsp;a&amp;nbsp;function<br />//<br /><br /></span><span style='color: #007700'>function&amp;nbsp;</span><span style='color: #0000BB'>someFunction</span><span style='color: #007700'>()&amp;nbsp;<br />{<br />}<br /><br /></span><span style='color: #0000BB'>$functionVariable&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'someFunction'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_callable</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$functionVariable</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'>$callable_name</span><span style='color: #007700'>));&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;bool(true)<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>$callable_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;someFunction<br /><br />//<br />//&amp;nbsp;&amp;nbsp;Array&amp;nbsp;containing&amp;nbsp;a&amp;nbsp;method<br />//<br /><br /></span><span style='color: #007700'>class&amp;nbsp;</span><span style='color: #0000BB'>someClass&amp;nbsp;</span><span style='color: #007700'>{<br /><br />&amp;nbsp;&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>someMethod</span><span style='color: #007700'>()&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;}<br /><br />}<br /><br /></span><span style='color: #0000BB'>$anObject&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>someClass</span><span style='color: #007700'>();<br /><br /></span><span style='color: #0000BB'>$methodVariable&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #0000BB'>$anObject</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'someMethod'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>is_callable</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$methodVariable</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$callable_name</span><span style='color: #007700'>));&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;&amp;nbsp;bool(true)<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>$callable_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;&amp;nbsp;someClass::someMethod<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.is-callable.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.function-exists.php' class='function' rel='rdfs-seeAlso'>function_exists()</a> - Return TRUE if the given function has been defined</li> <li class='member'><a href='http://www.php.net/manual/en/function.method-exists.php' class='function' rel='rdfs-seeAlso'>method_exists()</a> - Checks if the class method exists</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="is_bool" value="<div id='function.is-bool' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-bool.php'>is_bool</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_bool</span> &amp;mdash; <span class='dc-title'> Finds out whether a variable is a boolean </span></p> </div> <a name='function.is-bool.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>is_bool</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'>$var</tt></span> )</div> <p class='para rdfs-comment'> Finds whether the given variable is a boolean. </p> </div> <a name='function.is-bool.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable being evaluated. </p> </dd> </dl> <p> </p> </div> <a name='function.is-bool.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'>var</tt></i> is a <a href='http://www.php.net/manual/en/language.types.boolean.php' class='type boolean'>boolean</a>, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-bool.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_bool()</b> examples</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'>false</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'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Since&amp;nbsp;$a&amp;nbsp;is&amp;nbsp;a&amp;nbsp;boolean,&amp;nbsp;this&amp;nbsp;is&amp;nbsp;true<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>is_bool</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Yes,&amp;nbsp;this&amp;nbsp;is&amp;nbsp;a&amp;nbsp;boolean'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Since&amp;nbsp;$b&amp;nbsp;is&amp;nbsp;not&amp;nbsp;a&amp;nbsp;boolean,&amp;nbsp;this&amp;nbsp;is&amp;nbsp;not&amp;nbsp;true<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>is_bool</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Yes,&amp;nbsp;this&amp;nbsp;is&amp;nbsp;a&amp;nbsp;boolean'</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.is-bool.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.is-float.php' class='function' rel='rdfs-seeAlso'>is_float()</a> - Finds whether the type of a variable is float</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-int.php' class='function' rel='rdfs-seeAlso'>is_int()</a> - Find whether the type of a variable is integer</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-string.php' class='function' rel='rdfs-seeAlso'>is_string()</a> - Find whether the type of a variable is string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-object.php' class='function' rel='rdfs-seeAlso'>is_object()</a> - Finds whether a variable is an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-array.php' class='function' rel='rdfs-seeAlso'>is_array()</a> - Finds whether a variable is an array</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="is_array" value="<div id='function.is-array' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-array.php'>is_array</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>is_array</span> &amp;mdash; <span class='dc-title'>Finds whether a variable is an array</span></p> </div> <a name='function.is-array.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>is_array</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'>$var</tt></span> )</div> <p class='para rdfs-comment'> Finds whether the given variable is an array. </p> </div> <a name='function.is-array.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The variable being evaluated. </p> </dd> </dl> <p> </p> </div> <a name='function.is-array.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'>var</tt></i> is an <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-array.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Check that variable is an array</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$yes&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'this'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'is'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'an&amp;nbsp;array'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>is_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$yes</span><span style='color: #007700'>)&amp;nbsp;?&amp;nbsp;</span><span style='color: #DD0000'>'Array'&amp;nbsp;</span><span style='color: #007700'>:&amp;nbsp;</span><span style='color: #DD0000'>'not&amp;nbsp;an&amp;nbsp;Array'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$no&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'this&amp;nbsp;is&amp;nbsp;a&amp;nbsp;string'</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>is_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$no</span><span style='color: #007700'>)&amp;nbsp;?&amp;nbsp;</span><span style='color: #DD0000'>'Array'&amp;nbsp;</span><span style='color: #007700'>:&amp;nbsp;</span><span style='color: #DD0000'>'not&amp;nbsp;an&amp;nbsp;Array'</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 not an Array </pre></div> </div> </div><p> </p> </div> <a name='function.is-array.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.is-float.php' class='function' rel='rdfs-seeAlso'>is_float()</a> - Finds whether the type of a variable is float</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-int.php' class='function' rel='rdfs-seeAlso'>is_int()</a> - Find whether the type of a variable is integer</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-string.php' class='function' rel='rdfs-seeAlso'>is_string()</a> - Find whether the type of a variable is string</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-object.php' class='function' rel='rdfs-seeAlso'>is_object()</a> - Finds whether a variable is an object</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="is_a" value="<div id='function.is-a' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.is-a.php'>is_a</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>is_a</span> &amp;mdash; <span class='dc-title'>Checks if the object is of this class or has this class as one of its parents</span></p> </div> <a name='function.is-a.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>is_a</b></span> ( <span class='methodparam'><span class='type'>object</span> <tt class='parameter'>$object</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$class_name</tt></span> )</div> <p class='para rdfs-comment'> Checks if the given <i><tt class='parameter'>object</tt></i> is of this class or has this class as one of its parents. </p> </div> <a name='function.is-a.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 tested object </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>class_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The class name </p> </dd> </dl> <p> </p> </div> <a name='function.is-a.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 object is of this class or has this class as one of its parents, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.is-a.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.3.0</td> <td align='left'> This function is no longer deprecated, and will therefore no longer throw <b><tt class='constant'>E_STRICT</tt></b> warnings. </td> </tr> <tr valign='middle'> <td align='left'>5.0.0</td> <td align='left'> This function became deprecated in favour of the <a href='http://www.php.net/manual/en/language.operators.type.php' class='link'>instanceof</a> operator. Calling this function will result in an <b><tt class='constant'>E_STRICT</tt></b> warning. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.is-a.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>is_a()</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;define&amp;nbsp;a&amp;nbsp;class<br /></span><span style='color: #007700'>class&amp;nbsp;</span><span style='color: #0000BB'>WidgetFactory<br /></span><span style='color: #007700'>{<br />&amp;nbsp;&amp;nbsp;var&amp;nbsp;</span><span style='color: #0000BB'>$oink&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'moo'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;object<br /></span><span style='color: #0000BB'>$WF&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>WidgetFactory</span><span style='color: #007700'>();<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>is_a</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$WF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'WidgetFactory'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'yes,&amp;nbsp;\$WF&amp;nbsp;is&amp;nbsp;still&amp;nbsp;a&amp;nbsp;WidgetFactory\n'</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 Using the <em class='emphasis'>instanceof</em> operator in PHP 5</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'>$WF&amp;nbsp;</span><span style='color: #007700'>instanceof&amp;nbsp;</span><span style='color: #0000BB'>WidgetFactory</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Yes,&amp;nbsp;$WF&amp;nbsp;is&amp;nbsp;a&amp;nbsp;WidgetFactory'</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.is-a.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.get-class.php' class='function' rel='rdfs-seeAlso'>get_class()</a> - Returns the name of the class of an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.get-parent-class.php' class='function' rel='rdfs-seeAlso'>get_parent_class()</a> - Retrieves the parent class name for object or class</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-subclass-of.php' class='function' rel='rdfs-seeAlso'>is_subclass_of()</a> - Checks if the object has this class as one of its parents</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="iptcparse" value="<div id='function.iptcparse' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iptcparse.php'>iptcparse</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>iptcparse</span> &amp;mdash; <span class='dc-title'>Parse a binary IPTC block into single tags.</span></p> </div> <a name='function.iptcparse.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>iptcparse</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$iptcblock</tt></span> )</div> <p class='para rdfs-comment'> Parses an <a href='http://www.iptc.org/' class='link external'>&amp;raquo; IPTC</a> block into its single tags. </p> </div> <a name='function.iptcparse.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'>iptcblock</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A binary IPTC block. </p> </dd> </dl> <p> </p> </div> <a name='function.iptcparse.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array using the tagmarker as an index and the value as the value. It returns <b><tt class='constant'>FALSE</tt></b> on error or if no IPTC data was found. </p> </div> <a name='function.iptcparse.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 iptcparse() used together with <a href='http://www.php.net/manual/en/function.getimagesize.php' class='function'>getimagesize()</a></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$size&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>getimagesize</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./test.jpg'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>);<br />if(isset(</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'APP13'</span><span style='color: #007700'>]))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$iptc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>iptcparse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'APP13'</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$iptc</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.iptcparse.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function does not require the GD image library.<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="iptcembed" value="<div id='function.iptcembed' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.iptcembed.php'>iptcembed</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>iptcembed</span> &amp;mdash; <span class='dc-title'>Embeds binary IPTC data into a JPEG image</span></p> </div> <a name='function.iptcembed.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>iptcembed</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$iptcdata</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$jpeg_file_name</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$spool</tt></span> ] )</div> <p class='para rdfs-comment'> Embeds binary IPTC data into a JPEG image. </p> </div> <a name='function.iptcembed.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'>iptcdata</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The data to be written. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>jpeg_file_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Path to the JPEG image. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>spool</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Spool flag. If the spool flag is over 2 then the JPEG will be returned as a string. </p> </dd> </dl> <p> </p> </div> <a name='function.iptcembed.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If success and spool flag is lower than 2 then the JPEG will not be returned as a string, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.iptcembed.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Embedding IPTC data into a JPEG</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;iptc_make_tag()&amp;nbsp;function&amp;nbsp;by&amp;nbsp;Thies&amp;nbsp;C.&amp;nbsp;Arntzen<br /></span><span style='color: #007700'>function&amp;nbsp;</span><span style='color: #0000BB'>iptc_make_tag</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$rec</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$value</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$length&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'>$value</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$retval&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0x1C</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$rec</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if(</span><span style='color: #0000BB'>$length&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>0x8000</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$retval&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$length&amp;nbsp;</span><span style='color: #007700'>&amp;gt;&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>8</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$length&amp;nbsp;</span><span style='color: #007700'>&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;else<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$retval&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0x80</span><span style='color: #007700'>)&amp;nbsp;.&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;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0x04</span><span style='color: #007700'>)&amp;nbsp;.&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;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>((</span><span style='color: #0000BB'>$length&amp;nbsp;</span><span style='color: #007700'>&amp;gt;&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>24</span><span style='color: #007700'>)&amp;nbsp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>)&amp;nbsp;.&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;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>((</span><span style='color: #0000BB'>$length&amp;nbsp;</span><span style='color: #007700'>&amp;gt;&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>16</span><span style='color: #007700'>)&amp;nbsp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>)&amp;nbsp;.&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;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>((</span><span style='color: #0000BB'>$length&amp;nbsp;</span><span style='color: #007700'>&amp;gt;&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>8</span><span style='color: #007700'>)&amp;nbsp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>)&amp;nbsp;.&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;</span><span style='color: #0000BB'>chr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$length&amp;nbsp;</span><span style='color: #007700'>&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>$retval&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$value</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Path&amp;nbsp;to&amp;nbsp;jpeg&amp;nbsp;file<br /></span><span style='color: #0000BB'>$path&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'./phplogo.jpg'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;We&amp;nbsp;need&amp;nbsp;to&amp;nbsp;check&amp;nbsp;if&amp;nbsp;theres&amp;nbsp;any&amp;nbsp;IPTC&amp;nbsp;data&amp;nbsp;in&amp;nbsp;the&amp;nbsp;jpeg&amp;nbsp;image.&amp;nbsp;If&amp;nbsp;there&amp;nbsp;is&amp;nbsp;then&amp;nbsp;<br />//&amp;nbsp;bail&amp;nbsp;out&amp;nbsp;because&amp;nbsp;we&amp;nbsp;cannot&amp;nbsp;embed&amp;nbsp;any&amp;nbsp;image&amp;nbsp;that&amp;nbsp;already&amp;nbsp;has&amp;nbsp;some&amp;nbsp;IPTC&amp;nbsp;data!<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>getimagesize</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$path</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>);<br /><br />if(isset(</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'APP13'</span><span style='color: #007700'>]))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Error:&amp;nbsp;IPTC&amp;nbsp;data&amp;nbsp;found&amp;nbsp;in&amp;nbsp;source&amp;nbsp;image,&amp;nbsp;cannot&amp;nbsp;continue'</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;IPTC&amp;nbsp;tags<br /></span><span style='color: #0000BB'>$iptc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'2#120'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'Test&amp;nbsp;image'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'2#116'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'Copyright&amp;nbsp;2008-2009,&amp;nbsp;The&amp;nbsp;PHP&amp;nbsp;Group'<br /></span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Convert&amp;nbsp;the&amp;nbsp;IPTC&amp;nbsp;tags&amp;nbsp;into&amp;nbsp;binary&amp;nbsp;code<br /></span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>;<br /><br />foreach(</span><span style='color: #0000BB'>$iptc&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$tag&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$string</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$tag&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>substr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tag</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #0000BB'>iptc_make_tag</span><span style='color: #007700'>(</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>substr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tag</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'>$string</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Embed&amp;nbsp;the&amp;nbsp;IPTC&amp;nbsp;data<br /></span><span style='color: #0000BB'>$content&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>iptcembed</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$path</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.iptcembed.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function does not require the GD image library.<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="ip2long" value="<div id='function.ip2long' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ip2long.php'>ip2long</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ip2long</span> &amp;mdash; <span class='dc-title'>Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address</span></p> </div> <a name='function.ip2long.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>ip2long</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$ip_address</tt></span> )</div> <p class='para rdfs-comment'> The function <b>ip2long()</b> generates an IPv4 Internet network address from its Internet standard format (dotted string) representation. </p> <p class='para'> <b>ip2long()</b> will also work with non-complete IP addresses. Read <a href='http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/libs/commtrf2/inet_addr.htm' class='link external'>&amp;raquo; http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/libs/commtrf2/inet_addr.htm</a> for more info. </p> </div> <a name='function.ip2long.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'>ip_address</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A standard format address. </p> </dd> </dl> <p> </p> </div> <a name='function.ip2long.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the IPv4 address or <b><tt class='constant'>FALSE</tt></b> if <i><tt class='parameter'>ip_address</tt></i> is invalid. </p> </div> <a name='function.ip2long.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'> Prior to this version, <b>ip2long()</b> returned -1 on failure. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ip2long.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ip2long()</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 />$ip&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gethostbyname</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'www.example.com'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$out&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;following&amp;nbsp;URLs&amp;nbsp;are&amp;nbsp;equivalent:&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$out&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'http://www.example.com/,&amp;nbsp;http://'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$ip&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'/,&amp;nbsp;and&amp;nbsp;http://'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>sprintf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%u'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>ip2long</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ip</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 />echo&amp;nbsp;</span><span style='color: #0000BB'>$out</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 Displaying an IP address</b></p> <div class='example-contents para'><p> This second example shows how to print a converted address with the <a href='http://www.php.net/manual/en/function.printf.php' class='function'>printf()</a> function in both PHP 4 and PHP 5: </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$ip&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>gethostbyname</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'www.example.com'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$long&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ip2long</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ip</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$long&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;-</span><span style='color: #0000BB'>1&amp;nbsp;</span><span style='color: #007700'>||&amp;nbsp;</span><span style='color: #0000BB'>$long&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'>'Invalid&amp;nbsp;IP,&amp;nbsp;please&amp;nbsp;try&amp;nbsp;again'</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: #0000BB'>$ip&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;&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: #FF8000'>//&amp;nbsp;192.0.34.166<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>$long&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;&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: #FF8000'>//&amp;nbsp;-1073732954<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%u\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>ip2long</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ip</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;3221234342<br /></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 #3 IP validation</b></p> <div class='example-contents para'><p> <b>ip2long()</b> should not be used as the sole form of IP validation. Combine it with <a href='http://www.php.net/manual/en/function.long2ip.php' class='function'>long2ip()</a>: </p></div> <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;make&amp;nbsp;sure&amp;nbsp;IPs&amp;nbsp;are&amp;nbsp;valid.&amp;nbsp;also&amp;nbsp;converts&amp;nbsp;a&amp;nbsp;non-complete&amp;nbsp;IP&amp;nbsp;into<br />//&amp;nbsp;a&amp;nbsp;proper&amp;nbsp;dotted&amp;nbsp;quad&amp;nbsp;as&amp;nbsp;explained&amp;nbsp;below.<br /></span><span style='color: #0000BB'>$ip&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>long2ip</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ip2long</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'127.0.0.1'</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;'127.0.0.1'<br /></span><span style='color: #0000BB'>$ip&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>long2ip</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ip2long</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'10.0.0'</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;'10.0.0.0'<br /></span><span style='color: #0000BB'>$ip&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>long2ip</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ip2long</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'10.0.256'</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;'10.0.1.0'<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ip2long.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Because PHP&amp;#039;s integer type is signed, and many IP addresses will result in negative integers, you need to use the &amp;quot;%u&amp;quot; formatter of <a href='http://www.php.net/manual/en/function.sprintf.php' class='function'>sprintf()</a> or <a href='http://www.php.net/manual/en/function.printf.php' class='function'>printf()</a> to get the string representation of the unsigned IP address. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <b>ip2long()</b> will return <b><tt class='constant'>FALSE</tt></b> for the IP <i>255.255.255.255</i> in PHP 5 &amp;lt;= 5.0.2. It was fixed in PHP 5.0.3 where it returns <i>-1</i> (same as PHP 4). <br /> </p></blockquote> </div> <a name='function.ip2long.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.long2ip.php' class='function' rel='rdfs-seeAlso'>long2ip()</a> - Converts an (IPv4) Internet network address into a string in Internet standard dotted format</li> <li class='member'><a href='http://www.php.net/manual/en/function.sprintf.php' class='function' rel='rdfs-seeAlso'>sprintf()</a> - Return a formatted 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="in_array" value="<div id='function.in-array' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.in-array.php'>in_array</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>in_array</span> &amp;mdash; <span class='dc-title'>Checks if a value exists in an array</span></p> </div> <a name='function.in-array.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>in_array</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'>$needle</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$haystack</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$strict</tt></span> ] )</div> <p class='para rdfs-comment'> Searches <i><tt class='parameter'>haystack</tt></i> for <i><tt class='parameter'>needle</tt></i> . </p> </div> <a name='function.in-array.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'>needle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The searched value. </p> <blockquote><p><b class='note'>Note</b>: If <i><tt class='parameter'>needle</tt></i> is a string, the comparison is done in a case-sensitive manner. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>haystack</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The array. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>strict</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If the third parameter <i><tt class='parameter'>strict</tt></i> is set to <b><tt class='constant'>TRUE</tt></b> then the <b>in_array()</b> function will also check the <a href='http://www.php.net/manual/en/language.types.php' class='link'>types</a> of the <i><tt class='parameter'>needle</tt></i> in the <i><tt class='parameter'>haystack</tt></i> . </p> </dd> </dl> <p> </p> </div> <a name='function.in-array.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'>needle</tt></i> is found in the array, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.in-array.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'>needle</tt></i> may now be an array. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.in-array.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>in_array()</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 />$os&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'Mac'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'NT'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Irix'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Linux'</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>in_array</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Irix'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$os</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Got&amp;nbsp;Irix'</span><span style='color: #007700'>;<br />}<br />if&amp;nbsp;(</span><span style='color: #0000BB'>in_array</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'mac'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$os</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Got&amp;nbsp;mac'</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 second condition fails because <b>in_array()</b> is case-sensitive, so the program above will display: </p></div> <div class='example-contents screen'> <div class='cdata'><pre> Got Irix </pre></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 <b>in_array()</b> with strict 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;array(</span><span style='color: #DD0000'>'1.10'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>12.4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1.13</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>in_array</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'12.4'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>''12.4'&amp;nbsp;found&amp;nbsp;with&amp;nbsp;strict&amp;nbsp;check\n'</span><span style='color: #007700'>;<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>in_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1.13</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'1.13&amp;nbsp;found&amp;nbsp;with&amp;nbsp;strict&amp;nbsp;check\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> 1.13 found with strict check </pre></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #3 <b>in_array()</b> with an array as needle</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;array(array(</span><span style='color: #DD0000'>'p'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'h'</span><span style='color: #007700'>),&amp;nbsp;array(</span><span style='color: #DD0000'>'p'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'r'</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #DD0000'>'o'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>in_array</span><span style='color: #007700'>(array(</span><span style='color: #DD0000'>'p'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'h'</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>''ph'&amp;nbsp;was&amp;nbsp;found\n'</span><span style='color: #007700'>;<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>in_array</span><span style='color: #007700'>(array(</span><span style='color: #DD0000'>'f'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'i'</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>''fi'&amp;nbsp;was&amp;nbsp;found\n'</span><span style='color: #007700'>;<br />}<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>in_array</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'o'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>''o'&amp;nbsp;was&amp;nbsp;found\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> &amp;#039;ph&amp;#039; was found &amp;#039;o&amp;#039; was found </pre></div> </div> </div><p> </p> </div> <a name='function.in-array.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.array-search.php' class='function' rel='rdfs-seeAlso'>array_search()</a> - Searches the array for a given value and returns the corresponding key if successful</li> <li class='member'><a href='http://www.php.net/manual/en/function.isset.php' class='function' rel='rdfs-seeAlso'>isset()</a> - Determine if a variable is set and is not NULL</li> <li class='member'><a href='http://www.php.net/manual/en/function.array-key-exists.php' class='function' rel='rdfs-seeAlso'>array_key_exists()</a> - Checks if the given key or index exists in the array</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="InvalidArgumentException" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.invalidargumentexception.php'>The InvalidArgumentException class</a></h1> <div class='partintro'> <div id='invalidargumentexception.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> Exception thrown if a argument does not match with the expected value </p> </div> <div id='invalidargumentexception.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>InvalidArgumentException</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>InvalidArgumentException</b> </span> <span class='ooclass'> <span class='modifier'>extends</span> <a href='http://www.php.net/manual/en/class.logicexception.php' class='classname'>LogicException</a> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Inherited methods */</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getmessage.php' class='function'>Exception::getMessage</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>Exception</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getprevious.php' class='function'>Exception::getPrevious</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getcode.php' class='function'>Exception::getCode</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getfile.php' class='function'>Exception::getFile</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.getline.php' class='function'>Exception::getLine</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>array</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.gettrace.php' class='function'>Exception::getTrace</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.gettraceasstring.php' class='function'>Exception::getTraceAsString</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>string</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.tostring.php' class='function'>Exception::__toString</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>final</span> <span class='modifier'>private</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/exception.clone.php' class='function'>Exception::__clone</a></span> ( <span class='methodparam'>void</span> )</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="intval" value="<div id='function.intval' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.intval.php'>intval</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>intval</span> &amp;mdash; <span class='dc-title'>Get the integer value of a variable</span></p> </div> <a name='function.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>intval</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'>$var</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$base</tt><span class='initializer'> = 10</span></span> ] )</div> <p class='para rdfs-comment'> Returns the <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> value of <i><tt class='parameter'>var</tt></i> , using the specified <i><tt class='parameter'>base</tt></i> for the conversion (the default is base 10). </p> </div> <a name='function.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'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The scalar value being converted to an integer </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 for the conversion (default is base 10) </p> </dd> </dl> <p> </p> </div> <a name='function.intval.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The integer value of <i><tt class='parameter'>var</tt></i> on success, or 0 on failure. Empty arrays and objects return 0, non-empty arrays and objects return 1. </p> <p class='para'> The maximum value depends on the system. 32 bit systems have a maximum signed integer range of -2147483648 to 2147483647. So for example on such a system, <i>intval(&amp;#039;1000000000000&amp;#039;)</i> will return 2147483647. The maximum signed integer value for 64 bit systems is 9223372036854775807. </p> <p class='para'> Strings will most likely return 0 although this depends on the leftmost characters of the string. The common rules of <a href='http://www.php.net/manual/en/language.types.integer.php#language.types.integer.casting' class='link'>integer casting</a> apply. </p> </div> <a name='function.intval.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>intval()</b> examples</b></p> <div class='example-contents para'><p> The following examples are based on a 32 bit system. </p></div> <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'>intval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>42</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;42<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>4.2</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;4<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'42'</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;42<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'+42'</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;42<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'-42'</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;-42<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>042</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;34<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'042'</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;42<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1e10</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;1410065408<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1e10'</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;1<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0x1A</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;26<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>42000000</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;42000000<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>420000000000000000000</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;0<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'420000000000000000000'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;2147483647<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #0000BB'>42</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>8</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;42<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>intval</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'42'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>8</span><span style='color: #007700'>);&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: #FF8000'>//&amp;nbsp;34<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.intval.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The <i><tt class='parameter'>base</tt></i> parameter has no effect unless the <i><tt class='parameter'>var</tt></i> parameter is a string. <br /> </p></blockquote> </div> <a name='function.intval.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.floatval.php' class='function' rel='rdfs-seeAlso'>floatval()</a> - Get float value of a variable</li> <li class='member'><a href='http://www.php.net/manual/en/function.strval.php' class='function' rel='rdfs-seeAlso'>strval()</a> - Get string value of a variable</li> <li class='member'><a href='http://www.php.net/manual/en/function.settype.php' class='function' rel='rdfs-seeAlso'>settype()</a> - Set the type of a variable</li> <li class='member'><a href='http://www.php.net/manual/en/function.is-numeric.php' class='function' rel='rdfs-seeAlso'>is_numeric()</a> - Finds whether a variable is a number or a numeric string</li> <li class='member'><a href='http://www.php.net/manual/en/language.types.type-juggling.php' class='link'>Type juggling</a></li> <li class='member'><a href='http://www.php.net/manual/en/ref.bc.php' class='link'>BCMath Arbitrary Precision Mathematics 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="interface_exists" value="<div id='function.interface-exists' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.interface-exists.php'>interface_exists</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.0.2)</p><p class='refpurpose'><span class='refname'>interface_exists</span> &amp;mdash; <span class='dc-title'>Checks if the interface has been defined</span></p> </div> <a name='function.interface-exists.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>interface_exists</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$interface_name</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$autoload</tt><span class='initializer'> = true</span></span> ] )</div> <p class='para rdfs-comment'> Checks if the given interface has been defined. </p> </div> <a name='function.interface-exists.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'>interface_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The interface name </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>autoload</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whether to call <a href='http://www.php.net/manual/en/language.oop5.autoload.php' class='link'>__autoload</a> or not by default </p> </dd> </dl> <p> </p> </div> <a name='function.interface-exists.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 interface given by <i><tt class='parameter'>interface_name</tt></i> has been defined, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.interface-exists.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>interface_exists()</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;Check&amp;nbsp;the&amp;nbsp;interface&amp;nbsp;exists&amp;nbsp;before&amp;nbsp;trying&amp;nbsp;to&amp;nbsp;use&amp;nbsp;it<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>interface_exists</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MyInterface'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;class&amp;nbsp;</span><span style='color: #0000BB'>MyClass&amp;nbsp;</span><span style='color: #007700'>implements&amp;nbsp;</span><span style='color: #0000BB'>MyInterface<br />&amp;nbsp;&amp;nbsp;&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: #FF8000'>//&amp;nbsp;Methods<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>}<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.interface-exists.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.class-exists.php' class='function' rel='rdfs-seeAlso'>class_exists()</a> - Checks if the class has been defined</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="ini_set" value="<div id='function.ini-set' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ini-set.php'>ini_set</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ini_set</span> &amp;mdash; <span class='dc-title'>Sets the value of a configuration option</span></p> </div> <a name='function.ini-set.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>ini_set</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$varname</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$newvalue</tt></span> )</div> <p class='para rdfs-comment'> Sets the value of the given configuration option. The configuration option will keep this new value during the script&amp;#039;s execution, and will be restored at the script&amp;#039;s ending. </p> </div> <a name='function.ini-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'>varname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> <p class='para'> Not all the available options can be changed using <b>ini_set()</b>. There is a list of all available options in the <a href='http://www.php.net/manual/en/ini.list.php' class='link'>appendix</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>newvalue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new value for the option. </p> </dd> </dl> <p> </p> </div> <a name='function.ini-set.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the old value on success, <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ini-set.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Setting an ini option</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'>ini_get</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'display_errors'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'display_errors'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>ini_set</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'display_errors'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'display_errors'</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.ini-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.get-cfg-var.php' class='function' rel='rdfs-seeAlso'>get_cfg_var()</a> - Gets the value of a PHP configuration option</li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-get.php' class='function' rel='rdfs-seeAlso'>ini_get()</a> - Gets the value of a configuration option</li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-get-all.php' class='function' rel='rdfs-seeAlso'>ini_get_all()</a> - Gets all configuration options</li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-restore.php' class='function' rel='rdfs-seeAlso'>ini_restore()</a> - Restores the value of a configuration option</li> <li class='member'> <a href='http://www.php.net/manual/en/configuration.changes.php' class='link'>How to change configuration settings</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="ini_restore" value="<div id='function.ini-restore' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ini-restore.php'>ini_restore</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ini_restore</span> &amp;mdash; <span class='dc-title'>Restores the value of a configuration option</span></p> </div> <a name='function.ini-restore.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>ini_restore</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$varname</tt></span> )</div> <p class='para rdfs-comment'> Restores a given configuration option to its original value. </p> </div> <a name='function.ini-restore.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'>varname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The configuration option name. </p> </dd> </dl> <p> </p> </div> <a name='function.ini-restore.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.ini-restore.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ini_restore()</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 />$setting&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'y2k_compliance'</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Current&amp;nbsp;value&amp;nbsp;for&amp;nbsp;\''&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$setting&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\':&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$setting</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'>ini_set</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$setting</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$setting</span><span style='color: #007700'>)&amp;nbsp;?&amp;nbsp;</span><span style='color: #0000BB'>0&amp;nbsp;</span><span style='color: #007700'>:&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'New&amp;nbsp;value&amp;nbsp;for&amp;nbsp;\''&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$setting&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\':&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$setting</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'>ini_restore</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$setting</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Original&amp;nbsp;value&amp;nbsp;for&amp;nbsp;\''&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$setting&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\':&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$setting</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>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Current value for &amp;#039;y2k_compliance&amp;#039;: 1 New value for &amp;#039;y2k_compliance&amp;#039;: 0 Original value for &amp;#039;y2k_compliance&amp;#039;: 1 </pre></div> </div> </div><p> </p> </div> <a name='function.ini-restore.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.ini-get.php' class='function' rel='rdfs-seeAlso'>ini_get()</a> - Gets the value of a configuration option</li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-get-all.php' class='function' rel='rdfs-seeAlso'>ini_get_all()</a> - Gets all configuration options</li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-set.php' class='function' rel='rdfs-seeAlso'>ini_set()</a> - Sets the value of a configuration option</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="ini_get_all" value="<div id='function.ini-get-all' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ini-get-all.php'>ini_get_all</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ini_get_all</span> &amp;mdash; <span class='dc-title'>Gets all configuration options</span></p> </div> <a name='function.ini-get-all.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>ini_get_all</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$extension</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$details</tt><span class='initializer'> = true</span></span> ]] )</div> <p class='para rdfs-comment'> Returns all the registered configuration options. </p> </div> <a name='function.ini-get-all.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'>extension</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional extension name. If set, the function return only options specific for that extension. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>details</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Retrieve details settings or only the current value for each setting. Default is <b><tt class='constant'>TRUE</tt></b> (retrieve details). </p> </dd> </dl> <p> </p> </div> <a name='function.ini-get-all.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array with directive name as the array key. </p> <p class='para'> When <i><tt class='parameter'>details</tt></i> is <b><tt class='constant'>TRUE</tt></b> (default) the array will contain <i>global_value</i> (set in <var class='filename'>php.ini</var>), <i>local_value</i> (perhaps set with <a href='http://www.php.net/manual/en/function.ini-set.php' class='function'>ini_set()</a> or <var class='filename'>.htaccess</var>), and <i>access</i> (the access level). </p> <p class='para'> When <i><tt class='parameter'>details</tt></i> is <b><tt class='constant'>FALSE</tt></b> the value will be the current value of the option. </p> <p class='para'> See the manual section for information on what access levels mean. </p> <blockquote><p><b class='note'>Note</b>: It&amp;#039;s possible for a directive to have multiple access levels, which is why <i>access</i> shows the appropriate bitmask values. <br /> </p></blockquote> </div> <a name='function.ini-get-all.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.3.0</td> <td align='left'> Added <i><tt class='parameter'>details</tt></i> . </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ini-get-all.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>ini_get_all()</b> examples</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ini_get_all</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'pcre'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ini_get_all</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 ( [pcre.backtrack_limit] =&amp;gt; Array ( [global_value] =&amp;gt; 100000 [local_value] =&amp;gt; 100000 [access] =&amp;gt; 7 ) [pcre.recursion_limit] =&amp;gt; Array ( [global_value] =&amp;gt; 100000 [local_value] =&amp;gt; 100000 [access] =&amp;gt; 7 ) ) Array ( [allow_call_time_pass_reference] =&amp;gt; Array ( [global_value] =&amp;gt; 0 [local_value] =&amp;gt; 0 [access] =&amp;gt; 6 ) [allow_url_fopen] =&amp;gt; Array ( [global_value] =&amp;gt; 1 [local_value] =&amp;gt; 1 [access] =&amp;gt; 4 ) ... ) </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Disabling <i><tt class='parameter'>details</tt></i> </b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ini_get_all</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'pcre'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Added&amp;nbsp;in&amp;nbsp;PHP&amp;nbsp;5.3.0<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ini_get_all</span><span style='color: #007700'>(</span><span style='color: #0000BB'>null</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Added&amp;nbsp;in&amp;nbsp;PHP&amp;nbsp;5.3.0<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 ( [pcre.backtrack_limit] =&amp;gt; 100000 [pcre.recursion_limit] =&amp;gt; 100000 ) Array ( [allow_call_time_pass_reference] =&amp;gt; 0 [allow_url_fopen] =&amp;gt; 1 ... ) </pre></div> </div> </div><p> </p> </div> <a name='function.ini-get-all.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/configuration.changes.php' class='xref'>How to change configuration settings</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-get.php' class='function' rel='rdfs-seeAlso'>ini_get()</a> - Gets the value of a configuration option</li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-restore.php' class='function' rel='rdfs-seeAlso'>ini_restore()</a> - Restores the value of a configuration option</li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-set.php' class='function' rel='rdfs-seeAlso'>ini_set()</a> - Sets the value of a configuration option</li> <li class='member'><a href='http://www.php.net/manual/en/function.get-loaded-extensions.php' class='function' rel='rdfs-seeAlso'>get_loaded_extensions()</a> - Returns an array with the names of all modules compiled and loaded</li> <li class='member'><a href='http://www.php.net/manual/en/function.phpinfo.php' class='function' rel='rdfs-seeAlso'>phpinfo()</a> - Outputs lots of PHP 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="ini_get" value="<div id='function.ini-get' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ini-get.php'>ini_get</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ini_get</span> &amp;mdash; <span class='dc-title'>Gets the value of a configuration option</span></p> </div> <a name='function.ini-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>ini_get</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$varname</tt></span> )</div> <p class='para rdfs-comment'> Returns the value of the configuration option on success. </p> </div> <a name='function.ini-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'>varname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The configuration option name. </p> </dd> </dl> <p> </p> </div> <a name='function.ini-get.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the value of the configuration option as a string on success, or an empty string on failure or for <i>null</i> values. </p> </div> <a name='function.ini-get.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A few <b>ini_get()</b> examples</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'>/*<br />Our&amp;nbsp;php.ini&amp;nbsp;contains&amp;nbsp;the&amp;nbsp;following&amp;nbsp;settings:<br /><br />display_errors&amp;nbsp;=&amp;nbsp;On<br />register_globals&amp;nbsp;=&amp;nbsp;Off<br />post_max_size&amp;nbsp;=&amp;nbsp;8M<br />*/<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'display_errors&amp;nbsp;=&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'display_errors'</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: #DD0000'>'register_globals&amp;nbsp;=&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'register_globals'</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: #DD0000'>'post_max_size&amp;nbsp;=&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'post_max_size'</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: #DD0000'>'post_max_size+1&amp;nbsp;=&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;(</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'post_max_size'</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'>'\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'post_max_size&amp;nbsp;in&amp;nbsp;bytes&amp;nbsp;=&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>return_bytes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>ini_get</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'post_max_size'</span><span style='color: #007700'>));<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>return_bytes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>trim</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$last&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>strtolower</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>[</span><span style='color: #0000BB'>strlen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$val</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;switch(</span><span style='color: #0000BB'>$last</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;The&amp;nbsp;'G'&amp;nbsp;modifier&amp;nbsp;is&amp;nbsp;available&amp;nbsp;since&amp;nbsp;PHP&amp;nbsp;5.1.0<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>case&amp;nbsp;</span><span style='color: #DD0000'>'g'</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'>$val&amp;nbsp;</span><span style='color: #007700'>*=&amp;nbsp;</span><span style='color: #0000BB'>1024</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;case&amp;nbsp;</span><span style='color: #DD0000'>'m'</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'>$val&amp;nbsp;</span><span style='color: #007700'>*=&amp;nbsp;</span><span style='color: #0000BB'>1024</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;case&amp;nbsp;</span><span style='color: #DD0000'>'k'</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'>$val&amp;nbsp;</span><span style='color: #007700'>*=&amp;nbsp;</span><span style='color: #0000BB'>1024</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>$val</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> display_errors = 1 register_globals = 0 post_max_size = 8M post_max_size+1 = 9 post_max_size in bytes = 8388608 </pre></div> </div> </div><p> </p> </div> <a name='function.ini-get.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <b>When querying boolean values</b><br /> A boolean ini value of <i>off</i> will be returned as an empty string or &amp;quot;0&amp;quot; while a boolean ini value of <i>on</i> will be returned as &amp;quot;1&amp;quot;. The function can also return the literal string of INI value. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <b>When querying memory size values</b><br /> Many ini memory size values, such as <a href='http://www.php.net/manual/en/ini.core.php#ini.upload-max-filesize' class='link'>upload_max_filesize</a>, are stored in the <var class='filename'>php.ini</var> file in shorthand notation. <b>ini_get()</b> will return the exact string stored in the <var class='filename'>php.ini</var> file and <em class='emphasis'>NOT</em> its <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> equivalent. Attempting normal arithmetic functions on these values will not have otherwise expected results. The example above shows one way to convert shorthand notation into bytes, much like how the PHP source does it. <br /> </p></blockquote> </div> <a name='function.ini-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.get-cfg-var.php' class='function' rel='rdfs-seeAlso'>get_cfg_var()</a> - Gets the value of a PHP configuration option</li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-get-all.php' class='function' rel='rdfs-seeAlso'>ini_get_all()</a> - Gets all configuration options</li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-restore.php' class='function' rel='rdfs-seeAlso'>ini_restore()</a> - Restores the value of a configuration option</li> <li class='member'><a href='http://www.php.net/manual/en/function.ini-set.php' class='function' rel='rdfs-seeAlso'>ini_set()</a> - Sets the value of a configuration option</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="ini_alter" value="<div id='function.ini-alter' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ini-alter.php'>ini_alter</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ini_alter</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.ini-set.php' class='function'>ini_set()</a></span></p> </div> <a name='function.ini-alter.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.ini-set.php' class='function'>ini_set()</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="InfiniteIterator::__construct" value="<div id='infiniteiterator.construct' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/infiniteiterator.construct.php'>InfiniteIterator::__construct</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>InfiniteIterator::__construct</span> &amp;mdash; <span class='dc-title'>Constructs an infiniteIterator</span></p> </div> <a name='infiniteiterator.construct.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='methodname'><b>InfiniteIterator::__construct</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.iterator.php' class='type Iterator'>Iterator</a></span> <tt class='parameter'>$iterator</tt></span> )</div> <p class='para rdfs-comment'> Constructs an infinite iterator. </p> <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='infiniteiterator.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'>iterator</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The passed in iterator. </p> </dd> </dl> <p> </p> </div> <a name='infiniteiterator.construct.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An infinite iterator. </p> </div> <a name='infiniteiterator.construct.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'> <span class='methodname'><a href='http://www.php.net/manual/en/infiniteiterator.next.php' class='function' rel='rdfs-seeAlso'>InfiniteIterator::next</a> - Moves the Iterator forward</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="InfiniteIterator::next" value="<div id='infiniteiterator.next' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/infiniteiterator.next.php'>InfiniteIterator::next</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>InfiniteIterator::next</span> &amp;mdash; <span class='dc-title'>Moves the Iterator forward</span></p> </div> <a name='infiniteiterator.next.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>InfiniteIterator::next</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Moves the inner Iterator forward to its next element, or rewind it. </p> <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='infiniteiterator.next.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='infiniteiterator.next.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='infiniteiterator.next.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'> <span class='methodname'><b>Infinite::Iterator</b></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="InfiniteIterator" value="<div> <h1 class='title'><a class='info-url' href='http://www.php.net/manual/en/class.infiniteiterator.php'>The InfiniteIterator class</a></h1> <div class='partintro'> <div id='infiniteiterator.intro' class='section'> <h2 class='title'>Introduction</h2> <p class='para'> This Iterator takes another Iterator and infinitely iterates it by rewinding it when its end is reached. </p> </div> <div id='infiniteiterator.synopsis' class='section'> <h2 class='title'>Class synopsis</h2> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>InfiniteIterator</b></div> <div class='classsynopsisinfo'> <span class='ooclass'> <b class='classname'>InfiniteIterator</b> </span> <span class='ooclass'> <span class='modifier'>extends</span> <a href='http://www.php.net/manual/en/class.iteratoriterator.php' class='classname'>IteratorIterator</a> </span> <span class='oointerface'>implements <a href='http://www.php.net/manual/en/class.outeriterator.php' class='interfacename'>OuterIterator</a> </span> <span class='oointerface'>, <a href='http://www.php.net/manual/en/class.traversable.php' class='interfacename'>Traversable</a> </span> <span class='oointerface'>, <a href='http://www.php.net/manual/en/class.iterator.php' class='interfacename'>Iterator</a> </span> {</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Methods */</div> <div class='methodsynopsis dc-description'> <span class='methodname'><a href='http://www.php.net/manual/en/infiniteiterator.construct.php' class='function'>__construct</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.iterator.php' class='type Iterator'>Iterator</a></span> <tt class='parameter'>$iterator</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/infiniteiterator.next.php' class='function'>next</a></span> ( <span class='methodparam'>void</span> )</div> <div class='classsynopsisinfo classsynopsisinfo_comment'>/* Inherited methods */</div> <div class='methodsynopsis dc-description'> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.construct.php' class='function'>IteratorIterator::__construct</a></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/class.traversable.php' class='type Traversable'>Traversable</a></span> <tt class='parameter'>$iterator</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.current.php' class='function'>IteratorIterator::current</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.getinneriterator.php' class='function'>IteratorIterator::getInnerIterator</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.key.php' class='function'>IteratorIterator::key</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.next.php' class='function'>IteratorIterator::next</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>void</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.rewind.php' class='function'>IteratorIterator::rewind</a></span> ( <span class='methodparam'>void</span> )</div> <div class='methodsynopsis dc-description'> <span class='modifier'>public</span> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/iteratoriterator.valid.php' class='function'>IteratorIterator::valid</a></span> ( <span class='methodparam'>void</span> )</div> }</div> </div> </div> <h2>Table of Contents</h2><ul class='chunklist chunklist_reference'><li><a href='http://www.php.net/manual/en/infiniteiterator.construct.php'>InfiniteIterator::__construct</a> &amp;acirc;&amp;#128;&amp;#148; Constructs an infiniteIterator</li><li><a href='http://www.php.net/manual/en/infiniteiterator.next.php'>InfiniteIterator::next</a> &amp;acirc;&amp;#128;&amp;#148; Moves the Iterator forward</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="import_request_variables" value="<div id='function.import-request-variables' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.import-request-variables.php'>import_request_variables</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>import_request_variables</span> &amp;mdash; <span class='dc-title'>Import GET/POST/Cookie variables into the global scope</span></p> </div> <a name='function.import-request-variables.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>import_request_variables</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$types</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$prefix</tt></span> ] )</div> <p class='para rdfs-comment'> Imports GET/POST/Cookie variables into the global scope. It is useful if you disabled <a href='http://www.php.net/manual/en/ini.core.php#ini.register-globals' class='link'>register_globals</a>, but would like to see some variables in the global scope. </p> <p class='para'> If you&amp;#039;re interested in importing other variables into the global scope, such as <var class='varname'><a href='http://www.php.net/manual/en/reserved.variables.server.php' class='classname'>$_SERVER</a></var>, consider using <a href='http://www.php.net/manual/en/function.extract.php' class='function'>extract()</a>. </p> </div> <a name='function.import-request-variables.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'>types</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Using the <i><tt class='parameter'>types</tt></i> parameter, you can specify which request variables to import. You can use &amp;#039;G&amp;#039;, &amp;#039;P&amp;#039; and &amp;#039;C&amp;#039; characters respectively for GET, POST and Cookie. These characters are not case sensitive, so you can also use any combination of &amp;#039;g&amp;#039;, &amp;#039;p&amp;#039; and &amp;#039;c&amp;#039;. POST includes the POST uploaded file information. </p> <blockquote><p><b class='note'>Note</b>: Note that the order of the letters matters, as when using &amp;quot;<i>GP</i>&amp;quot;, the POST variables will overwrite GET variables with the same name. Any other letters than GPC are discarded. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>prefix</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Variable name prefix, prepended before all variable&amp;#039;s name imported into the global scope. So if you have a GET value named &amp;quot;<i>userid</i>&amp;quot;, and provide a prefix &amp;quot;<i>pref_</i>&amp;quot;, then you&amp;#039;ll get a global variable named <var class='varname'>$pref_userid</var>. </p> <blockquote><p><b class='note'>Note</b>: Although the <i><tt class='parameter'>prefix</tt></i> parameter is optional, you will get an <a href='http://www.php.net/manual/en/errorfunc.constants.php#errorfunc.constants.errorlevels.e-notice' class='link'><b><tt class='constant'>E_NOTICE</tt></b></a> level error if you specify no prefix, or specify an empty string as a prefix. This is a possible security hazard. Notice level errors are not displayed using the default <a href='http://www.php.net/manual/en/errorfunc.configuration.php#ini.error-reporting' class='link'>error reporting</a> level. <br /> </p></blockquote> </dd> </dl> <p> </p> </div> <a name='function.import-request-variables.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.import-request-variables.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>import_request_variables()</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;will&amp;nbsp;import&amp;nbsp;GET&amp;nbsp;and&amp;nbsp;POST&amp;nbsp;vars<br />//&amp;nbsp;with&amp;nbsp;an&amp;nbsp;'rvar_'&amp;nbsp;prefix<br /></span><span style='color: #0000BB'>import_request_variables</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'gp'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'rvar_'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$rvar_foo</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.import-request-variables.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><var class='varname'><a href='http://www.php.net/manual/en/reserved.variables.request.php' class='classname'>$_REQUEST</a></var></li> <li class='member'><a href='http://www.php.net/manual/en/ini.core.php#ini.register-globals' class='link'>register_globals</a></li> <li class='member'><a href='http://www.php.net/manual/en/language.variables.predefined.php' class='link'>Predefined Variables</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.extract.php' class='function' rel='rdfs-seeAlso'>extract()</a> - Import variables into the current symbol table from an array</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="implode" value="<div id='function.implode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.implode.php'>implode</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>implode</span> &amp;mdash; <span class='dc-title'>Join array elements with a string</span></p> </div> <a name='function.implode.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>implode</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$glue</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$pieces</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>implode</b></span> ( <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$pieces</tt></span> )</div> <p class='para rdfs-comment'> Join array elements with a <i><tt class='parameter'>glue</tt></i> string. </p> <blockquote><p><b class='note'>Note</b>: <b>implode()</b> can, for historical reasons, accept its parameters in either order. For consistency with <a href='http://www.php.net/manual/en/function.explode.php' class='function'>explode()</a>, however, it may be less confusing to use the documented order of arguments. <br /> </p></blockquote> </div> <a name='function.implode.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'>glue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Defaults to an empty string. This is not the preferred usage of <b>implode()</b> as <i><tt class='parameter'>glue</tt></i> would be the second parameter and thus, the bad prototype would be used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pieces</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The array of strings to implode. </p> </dd> </dl> <p> </p> </div> <a name='function.implode.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string containing a string representation of all the array elements in the same order, with the glue string between each element. </p> </div> <a name='function.implode.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 <i><tt class='parameter'>glue</tt></i> parameter became optional. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.implode.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>implode()</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 />$array&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'lastname'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'email'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'phone'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$comma_separated&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'>','</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$array</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$comma_separated</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;lastname,email,phone<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.implode.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function is binary-safe.</span></p></blockquote> </div> <a name='function.implode.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.explode.php' class='function' rel='rdfs-seeAlso'>explode()</a> - Split a string by string</li> <li class='member'><a href='http://www.php.net/manual/en/function.split.php' class='function' rel='rdfs-seeAlso'>split()</a> - Split string into array by regular expression</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="image_type_to_mime_type" value="<div id='function.image-type-to-mime-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.image-type-to-mime-type.php'>image_type_to_mime_type</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>image_type_to_mime_type</span> &amp;mdash; <span class='dc-title'>Get Mime-Type for image-type returned by getimagesize, exif_read_data, exif_thumbnail, exif_imagetype</span></p> </div> <a name='function.image-type-to-mime-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>image_type_to_mime_type</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$imagetype</tt></span> )</div> <p class='para rdfs-comment'> The <b>image_type_to_mime_type()</b> function will determine the Mime-Type for an IMAGETYPE constant. </p> </div> <a name='function.image-type-to-mime-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'>imagetype</tt></i> </span> </dt><dd class='listitem'> <p class='para'> One of the <i>IMAGETYPE_XXX</i> constants. </p> </dd> </dl> <p> </p> </div> <a name='function.image-type-to-mime-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The returned values are as follows </p><table class='doctable table'> <caption><b>Returned values Constants</b></caption> <thead valign='middle'> <tr valign='middle'> <th><i><tt class='parameter'>imagetype</tt></i> </th> <th>Returned value</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_GIF</tt></b></td> <td align='left'><i>image/gif</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_JPEG</tt></b></td> <td align='left'><i>image/jpeg</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_PNG</tt></b></td> <td align='left'><i>image/png</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_SWF</tt></b></td> <td align='left'><i>application/x-shockwave-flash</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_PSD</tt></b></td> <td align='left'><i>image/psd</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_BMP</tt></b></td> <td align='left'><i>image/bmp</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_TIFF_II</tt></b> (intel byte order)</td> <td align='left'><i>image/tiff</i></td> </tr> <tr valign='middle'> <td align='left'> <b><tt class='constant'>IMAGETYPE_TIFF_MM</tt></b> (motorola byte order) </td> <td align='left'><i>image/tiff</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_JPC</tt></b></td> <td align='left'><i>application/octet-stream</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_JP2</tt></b></td> <td align='left'><i>image/jp2</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_JPX</tt></b></td> <td align='left'><i>application/octet-stream</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_JB2</tt></b></td> <td align='left'><i>application/octet-stream</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_SWC</tt></b></td> <td align='left'><i>application/x-shockwave-flash</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_IFF</tt></b></td> <td align='left'><i>image/iff</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_WBMP</tt></b></td> <td align='left'><i>image/vnd.wap.wbmp</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_XBM</tt></b></td> <td align='left'><i>image/xbm</i></td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>IMAGETYPE_ICO</tt></b></td> <td align='left'><i>image/vnd.microsoft.icon</i></td> </tr> </tbody> </table> <p> </p> </div> <a name='function.image-type-to-mime-type.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>image_type_to_mime_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 />header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>image_type_to_mime_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>IMAGETYPE_PNG</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.image-type-to-mime-type.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function does not require the GD image library.<br /></p></blockquote> </div> <a name='function.image-type-to-mime-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/function.getimagesize.php' class='function' rel='rdfs-seeAlso'>getimagesize()</a> - Get the size of an image</li> <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> <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.exif-thumbnail.php' class='function' rel='rdfs-seeAlso'>exif_thumbnail()</a> - Retrieve the embedded thumbnail of a TIFF or JPEG 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="image_type_to_extension" value="<div id='function.image-type-to-extension' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.image-type-to-extension.php'>image_type_to_extension</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>image_type_to_extension</span> &amp;mdash; <span class='dc-title'>Get file extension for image type</span></p> </div> <a name='function.image-type-to-extension.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>image_type_to_extension</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$imagetype</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$include_dot</tt></span> ] )</div> <p class='para rdfs-comment'> Returns the extension for the given <i>IMAGETYPE_XXX</i> constant. </p> </div> <a name='function.image-type-to-extension.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'>imagetype</tt></i> </span> </dt><dd class='listitem'> <p class='para'> One of the <i>IMAGETYPE_XXX</i> constant. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>include_dot</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whether to prepend a dot to the extension or not. Default to <b><tt class='constant'>TRUE</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.image-type-to-extension.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A string with the extension corresponding to the given image type. </p> </div> <a name='function.image-type-to-extension.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>image_type_to_extension()</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;Create&amp;nbsp;image&amp;nbsp;instance<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./test'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>image_type_to_extension</span><span style='color: #007700'>(</span><span style='color: #0000BB'>IMAGETYPE_PNG</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.image-type-to-extension.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function does not require the GD image library.<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="imagexbm" value="<div id='function.imagexbm' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagexbm.php'>imagexbm</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>imagexbm</span> &amp;mdash; <span class='dc-title'>Output XBM image to browser or file</span></p> </div> <a name='function.imagexbm.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>imagexbm</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></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'>$foreground</tt></span> ] )</div> <p class='para rdfs-comment'> Outputs or save an <acronym title='X Bitmap'>XBM</acronym> version of the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagexbm.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path to save the file to. If not set or <b><tt class='constant'>NULL</tt></b>, the raw image stream will be outputted directly. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>foreground</tt></i> </span> </dt><dd class='listitem'> <p class='para'> You can set the foreground color with this parameter by setting an identifier obtained from <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. The default foreground color is black. </p> </dd> </dl> <p> </p> </div> <a name='function.imagexbm.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.imagexbm.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Saving an XBM file</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagexbm</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'simpletext.xbm'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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 Saving an XBM file with a different foreground color</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;a&amp;nbsp;replacement&amp;nbsp;foreground&amp;nbsp;color<br /></span><span style='color: #0000BB'>$foreground_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagexbm</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$foreground_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagexbm.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 if PHP is compiled with the bundled version of the GD library.</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="imagewbmp" value="<div id='function.imagewbmp' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagewbmp.php'>imagewbmp</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.1, PHP 5)</p><p class='refpurpose'><span class='refname'>imagewbmp</span> &amp;mdash; <span class='dc-title'>Output image to browser or file</span></p> </div> <a name='function.imagewbmp.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>imagewbmp</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></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'>$foreground</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>imagewbmp()</b> outputs or save a <acronym title='Wireless Bitmap'>WBMP</acronym> version of the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagewbmp.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path to save the file to. If not set or <b><tt class='constant'>NULL</tt></b>, the raw image stream will be outputted directly. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>foreground</tt></i> </span> </dt><dd class='listitem'> <p class='para'> You can set the foreground color with this parameter by setting an identifier obtained from <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. The default foreground color is black. </p> </dd> </dl> <p> </p> </div> <a name='function.imagewbmp.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.imagewbmp.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Outputting a WBMP image</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;content&amp;nbsp;type&amp;nbsp;header&amp;nbsp;-&amp;nbsp;in&amp;nbsp;this&amp;nbsp;case&amp;nbsp;image/vnd.wap.wbmp<br />//&amp;nbsp;Hint:&amp;nbsp;see&amp;nbsp;image_type_to_mime_type()&amp;nbsp;for&amp;nbsp;content-types<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/vnd.wap.wbmp'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagewbmp</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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 Saving the WBMP image</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagewbmp</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'simpletext.wbmp'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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 #3 Outputting the image with a different foreground</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> //&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br />$im&amp;nbsp;=&amp;nbsp;imagecreatetruecolor(120,&amp;nbsp;20);<br />$text_color&amp;nbsp;=&amp;nbsp;imagecolorallocate($im,&amp;nbsp;233,&amp;nbsp;14,&amp;nbsp;91);<br />imagestring($im,&amp;nbsp;1,&amp;nbsp;5,&amp;nbsp;5,&amp;nbsp;&amp;nbsp;'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String',&amp;nbsp;$text_color);<br /><br />//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;content&amp;nbsp;type&amp;nbsp;header&amp;nbsp;-&amp;nbsp;in&amp;nbsp;this&amp;nbsp;case&amp;nbsp;image/vnd.wap.wbmp<br />//&amp;nbsp;Hint:&amp;nbsp;see&amp;nbsp;image_type_to_mime_type()&amp;nbsp;for&amp;nbsp;content-types<br />header('Content-type:&amp;nbsp;image/vnd.wap.wbmp');<br /><br />//&amp;nbsp;Set&amp;nbsp;a&amp;nbsp;replacement&amp;nbsp;foreground&amp;nbsp;color<br />$foreground_color&amp;nbsp;=&amp;nbsp;imagecolorallocate($im,&amp;nbsp;255,&amp;nbsp;0,&amp;nbsp;0);<br /><br />imagewbmp($im,&amp;nbsp;NULL,&amp;nbsp;$foreground_color);<br /><br />//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br />imagedestroy($im);</span> </code></div> </div> </div><p> </p> </div> <a name='function.imagewbmp.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: WBMP support is only available if PHP was compiled against GD-1.8 or later. <br /> </p></blockquote> </div> <a name='function.imagewbmp.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.image2wbmp.php' class='function' rel='rdfs-seeAlso'>image2wbmp()</a> - Output image to browser or file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagepng.php' class='function' rel='rdfs-seeAlso'>imagepng()</a> - Output a PNG image to either the browser or a file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagegif.php' class='function' rel='rdfs-seeAlso'>imagegif()</a> - Output image to browser or file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagejpeg.php' class='function' rel='rdfs-seeAlso'>imagejpeg()</a> - Output image to browser or file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagetypes.php' class='function' rel='rdfs-seeAlso'>imagetypes()</a> - Return the image types supported by this PHP build</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="imagetypes" value="<div id='function.imagetypes' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagetypes.php'>imagetypes</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.2, PHP 5)</p><p class='refpurpose'><span class='refname'>imagetypes</span> &amp;mdash; <span class='dc-title'>Return the image types supported by this PHP build</span></p> </div> <a name='function.imagetypes.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>imagetypes</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Returns the image types supported by the current PHP installation. </p> </div> <a name='function.imagetypes.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a bit-field corresponding to the image formats supported by the version of GD linked into PHP. The following bits are returned, <b><tt class='constant'>IMG_GIF</tt></b> | <b><tt class='constant'>IMG_JPG</tt></b> | <b><tt class='constant'>IMG_PNG</tt></b> | <b><tt class='constant'>IMG_WBMP</tt></b> | <b><tt class='constant'>IMG_XPM</tt></b>. </p> </div> <a name='function.imagetypes.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Checking for PNG support</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'>imagetypes</span><span style='color: #007700'>()&amp;nbsp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>IMG_PNG</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'PNG&amp;nbsp;Support&amp;nbsp;is&amp;nbsp;enabled'</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="imagettftext" value="<div id='function.imagettftext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagettftext.php'>imagettftext</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagettftext</span> &amp;mdash; <span class='dc-title'>Write text to the image using TrueType fonts</span></p> </div> <a name='function.imagettftext.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>imagettftext</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$size</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$angle</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$fontfile</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text</tt></span> )</div> <p class='para rdfs-comment'> Writes the given <i><tt class='parameter'>text</tt></i> into the image using TrueType fonts. </p> </div> <a name='function.imagettftext.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>size</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The font size. Depending on your version of GD, this should be specified as the pixel size (GD1) or point size (GD2). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>angle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The angle in degrees, with 0 degrees being left-to-right reading text. Higher values represent a counter-clockwise rotation. For example, a value of 90 would result in bottom-to-top reading text. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The coordinates given by <i><tt class='parameter'>x</tt></i> and <i><tt class='parameter'>y</tt></i> will define the basepoint of the first character (roughly the lower-left corner of the character). This is different from the <a href='http://www.php.net/manual/en/function.imagestring.php' class='function'>imagestring()</a>, where <i><tt class='parameter'>x</tt></i> and <i><tt class='parameter'>y</tt></i> define the upper-left corner of the first character. For example, &amp;quot;top left&amp;quot; is 0, 0. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The y-ordinate. This sets the position of the fonts baseline, not the very bottom of the character. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The color index. Using the negative of a color index has the effect of turning off antialiasing. See <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fontfile</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path to the TrueType font you wish to use. </p> <p class='para'> Depending on which version of the GD library PHP is using, <em class='emphasis'>when <i><tt class='parameter'>fontfile</tt></i> does not begin with a leading <i>/</i> then <i>.ttf</i> will be appended</em> to the filename and the library will attempt to search for that filename along a library-defined font path. </p> <p class='para'> When using versions of the GD library lower than 2.0.18, a <i>space</i> character, rather than a semicolon, was used as the &amp;#039;path separator&amp;#039; for different font files. Unintentional use of this feature will result in the warning message: <i>Warning: Could not find/open font</i>. For these affected versions, the only solution is moving the font to a path which does not contain spaces. </p> <p class='para'> In many cases where a font resides in the same directory as the script using it the following trick will alleviate any include problems. </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;enviroment&amp;nbsp;variable&amp;nbsp;for&amp;nbsp;GD<br /></span><span style='color: #0000BB'>putenv</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'GDFONTPATH='&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>realpath</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Name&amp;nbsp;the&amp;nbsp;font&amp;nbsp;to&amp;nbsp;be&amp;nbsp;used&amp;nbsp;(note&amp;nbsp;the&amp;nbsp;lack&amp;nbsp;of&amp;nbsp;the&amp;nbsp;.ttf&amp;nbsp;extension)<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SomeFont'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The text string in UTF-8 encoding. </p> <p class='para'> May include decimal numeric character references (of the form: &amp;amp;#8364;) to access characters in a font beyond position 127. The hexadecimal format (like &amp;amp;#xA9;) is supported. Strings in UTF-8 encoding can be passed directly. </p> <p class='para'> Named entities, such as &amp;amp;copy;, are not supported. Consider using <a href='http://www.php.net/manual/en/function.html-entity-decode.php' class='function'>html_entity_decode()</a> to decode these named entities into UTF-8 strings (html_entity_decode() supports this as of PHP 5.0.0). </p> <p class='para'> If a character is used in the string which is not supported by the font, a hollow rectangle will replace the character. </p> </dd> </dl> <p> </p> </div> <a name='function.imagettftext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array with 8 elements representing four points making the bounding box of the text. The order of the points is lower left, lower right, upper right, upper left. The points are relative to the text regardless of the angle, so &amp;quot;upper left&amp;quot; means in the top left-hand corner when you see the text horizontally. </p> </div> <a name='function.imagettftext.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'> It is now possible to specify an hexadecimal entity in <i><tt class='parameter'>text</tt></i> . </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imagettftext.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagettftext()</b> example</b></p> <div class='example-contents para'><p> This example script will produce a white PNG 400x30 pixels, with the words &amp;quot;Testing...&amp;quot; in black (with grey shadow), in the font Arial. </p></div> <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;content-type<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>400</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;Create&amp;nbsp;some&amp;nbsp;colors<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$grey&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>128</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>128</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>128</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>399</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>29</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;The&amp;nbsp;text&amp;nbsp;to&amp;nbsp;draw<br /></span><span style='color: #0000BB'>$text&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Testing...'</span><span style='color: #007700'>;<br /></span><span style='color: #FF8000'>//&amp;nbsp;Replace&amp;nbsp;path&amp;nbsp;by&amp;nbsp;your&amp;nbsp;own&amp;nbsp;font&amp;nbsp;path<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'arial.ttf'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Add&amp;nbsp;some&amp;nbsp;shadow&amp;nbsp;to&amp;nbsp;the&amp;nbsp;text<br /></span><span style='color: #0000BB'>imagettftext</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</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'>11</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>21</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$grey</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Add&amp;nbsp;the&amp;nbsp;text<br /></span><span style='color: #0000BB'>imagettftext</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</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'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$black</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Using&amp;nbsp;imagepng()&amp;nbsp;results&amp;nbsp;in&amp;nbsp;clearer&amp;nbsp;text&amp;nbsp;compared&amp;nbsp;with&amp;nbsp;imagejpeg()<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagettftext.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagettftext.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function requires both the GD library and the <a href='http://www.freetype.org/' class='link external'>&amp;raquo; FreeType</a> library. <br /> </p></blockquote> </div> <a name='function.imagettftext.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.imagettfbbox.php' class='function' rel='rdfs-seeAlso'>imagettfbbox()</a> - Give the bounding box of a text using TrueType fonts</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="imagettfbbox" value="<div id='function.imagettfbbox' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagettfbbox.php'>imagettfbbox</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagettfbbox</span> &amp;mdash; <span class='dc-title'>Give the bounding box of a text using TrueType fonts</span></p> </div> <a name='function.imagettfbbox.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>imagettfbbox</b></span> ( <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$size</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$angle</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$fontfile</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text</tt></span> )</div> <p class='para rdfs-comment'> This function calculates and returns the bounding box in pixels for a TrueType text. </p> </div> <a name='function.imagettfbbox.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'>size</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The font size. Depending on your version of GD, this should be specified as the pixel size (GD1) or point size (GD2). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>angle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Angle in degrees in which <i><tt class='parameter'>text</tt></i> will be measured. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fontfile</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the TrueType font file (can be a URL). Depending on which version of the GD library that PHP is using, it may attempt to search for files that do not begin with a leading &amp;#039;/&amp;#039; by appending &amp;#039;.ttf&amp;#039; to the filename and searching along a library-defined font path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to be measured. </p> </dd> </dl> <p> </p> </div> <a name='function.imagettfbbox.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>imagettfbbox()</b> returns an array with 8 elements representing four points making the bounding box of the text: </p><table class='doctable informaltable'> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0</td> <td align='left'>lower left corner, X position</td> </tr> <tr valign='middle'> <td align='left'>1</td> <td align='left'>lower left corner, Y position</td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'>lower right corner, X position</td> </tr> <tr valign='middle'> <td align='left'>3</td> <td align='left'>lower right corner, Y position</td> </tr> <tr valign='middle'> <td align='left'>4</td> <td align='left'>upper right corner, X position</td> </tr> <tr valign='middle'> <td align='left'>5</td> <td align='left'>upper right corner, Y position</td> </tr> <tr valign='middle'> <td align='left'>6</td> <td align='left'>upper left corner, X position</td> </tr> <tr valign='middle'> <td align='left'>7</td> <td align='left'>upper left corner, Y position</td> </tr> </tbody> </table> <p> </p> <p class='para'> The points are relative to the <em class='emphasis'>text</em> regardless of the <i><tt class='parameter'>angle</tt></i> , so &amp;quot;upper left&amp;quot; means in the top left-hand corner seeing the text horizontally. </p> </div> <a name='function.imagettfbbox.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagettfbbox()</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;Create&amp;nbsp;a&amp;nbsp;300x150&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>300</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>150</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;background&amp;nbsp;to&amp;nbsp;be&amp;nbsp;white<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>299</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>299</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Path&amp;nbsp;to&amp;nbsp;our&amp;nbsp;font&amp;nbsp;file<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'./arial.ttf'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;First&amp;nbsp;we&amp;nbsp;create&amp;nbsp;our&amp;nbsp;bounding&amp;nbsp;box&amp;nbsp;for&amp;nbsp;the&amp;nbsp;first&amp;nbsp;text<br /></span><span style='color: #0000BB'>$bbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagettfbbox</span><span style='color: #007700'>(</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>45</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Powered&amp;nbsp;by&amp;nbsp;PHP&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>phpversion</span><span style='color: #007700'>());<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;is&amp;nbsp;our&amp;nbsp;cordinates&amp;nbsp;for&amp;nbsp;X&amp;nbsp;and&amp;nbsp;Y<br /></span><span style='color: #0000BB'>$x&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$bbox</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;+&amp;nbsp;(</span><span style='color: #0000BB'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;(</span><span style='color: #0000BB'>$bbox</span><span style='color: #007700'>[</span><span style='color: #0000BB'>4</span><span style='color: #007700'>]&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>25</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$y&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$bbox</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'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;(</span><span style='color: #0000BB'>$bbox</span><span style='color: #007700'>[</span><span style='color: #0000BB'>5</span><span style='color: #007700'>]&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Write&amp;nbsp;it<br /></span><span style='color: #0000BB'>imagettftext</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>45</span><span style='color: #007700'>,&amp;nbsp;</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'>$black</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Powered&amp;nbsp;by&amp;nbsp;PHP&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>phpversion</span><span style='color: #007700'>());<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;next&amp;nbsp;bounding&amp;nbsp;box&amp;nbsp;for&amp;nbsp;the&amp;nbsp;second&amp;nbsp;text<br /></span><span style='color: #0000BB'>$bbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagettfbbox</span><span style='color: #007700'>(</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>45</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'and&amp;nbsp;Zend&amp;nbsp;Engine&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>zend_version</span><span style='color: #007700'>());<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;cordinates&amp;nbsp;so&amp;nbsp;its&amp;nbsp;next&amp;nbsp;to&amp;nbsp;the&amp;nbsp;first&amp;nbsp;text<br /></span><span style='color: #0000BB'>$x&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$bbox</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;+&amp;nbsp;(</span><span style='color: #0000BB'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;(</span><span style='color: #0000BB'>$bbox</span><span style='color: #007700'>[</span><span style='color: #0000BB'>4</span><span style='color: #007700'>]&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;+&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$y&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$bbox</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'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;(</span><span style='color: #0000BB'>$bbox</span><span style='color: #007700'>[</span><span style='color: #0000BB'>5</span><span style='color: #007700'>]&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Write&amp;nbsp;it<br /></span><span style='color: #0000BB'>imagettftext</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>45</span><span style='color: #007700'>,&amp;nbsp;</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'>$black</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'and&amp;nbsp;Zend&amp;nbsp;Engine&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>zend_version</span><span style='color: #007700'>());<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;to&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagettfbbox.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function requires both the GD library and the <a href='http://www.freetype.org/' class='link external'>&amp;raquo; FreeType</a> library. <br /> </p></blockquote> </div> <a name='function.imagettfbbox.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.imagettftext.php' class='function' rel='rdfs-seeAlso'>imagettftext()</a> - Write text to the image using TrueType fonts</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="imagetruecolortopalette" value="<div id='function.imagetruecolortopalette' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagetruecolortopalette.php'>imagetruecolortopalette</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagetruecolortopalette</span> &amp;mdash; <span class='dc-title'>Convert a true color image to a palette image</span></p> </div> <a name='function.imagetruecolortopalette.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>imagetruecolortopalette</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$dither</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$ncolors</tt></span> )</div> <p class='para rdfs-comment'> <b>imagetruecolortopalette()</b> converts a truecolor image to a palette image. The code for this function was originally drawn from the Independent JPEG Group library code, which is excellent. The code has been modified to preserve as much alpha channel information as possible in the resulting palette, in addition to preserving colors as well as possible. This does not work as well as might be hoped. It is usually best to simply produce a truecolor output image instead, which guarantees the highest output quality. </p> </div> <a name='function.imagetruecolortopalette.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dither</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Indicates if the image should be dithered - if it is <b><tt class='constant'>TRUE</tt></b> then dithering will be used which will result in a more speckled image but with better color approximation. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ncolors</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Sets the maximum number of colors that should be retained in the palette. </p> </dd> </dl> <p> </p> </div> <a name='function.imagetruecolortopalette.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.imagetruecolortopalette.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Converting a true color image to a palette-based image</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;true&amp;nbsp;color&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Convert&amp;nbsp;to&amp;nbsp;palette-based&amp;nbsp;with&amp;nbsp;no&amp;nbsp;dithering&amp;nbsp;and&amp;nbsp;255&amp;nbsp;colors<br /></span><span style='color: #0000BB'>imagetruecolortopalette</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./paletteimage.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagetruecolortopalette.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</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="imagesy" value="<div id='function.imagesy' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagesy.php'>imagesy</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagesy</span> &amp;mdash; <span class='dc-title'>Get image height</span></p> </div> <a name='function.imagesy.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>imagesy</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> )</div> <p class='para rdfs-comment'> Returns the height of the given <i><tt class='parameter'>image</tt></i> resource. </p> </div> <a name='function.imagesy.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imagesy.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Return the height of the <i><tt class='parameter'>image</tt></i> or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagesy.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>imagesy()</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;create&amp;nbsp;a&amp;nbsp;300*200&amp;nbsp;image<br /></span><span style='color: #0000BB'>$img&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>300</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;200<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imagesy.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.imagecreatetruecolor.php' class='function' rel='rdfs-seeAlso'>imagecreatetruecolor()</a> - Create a new true color 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> <li class='member'><a href='http://www.php.net/manual/en/function.imagesx.php' class='function' rel='rdfs-seeAlso'>imagesx()</a> - Get image width</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="imagesx" value="<div id='function.imagesx' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagesx.php'>imagesx</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagesx</span> &amp;mdash; <span class='dc-title'>Get image width</span></p> </div> <a name='function.imagesx.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>imagesx</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> )</div> <p class='para rdfs-comment'> Returns the width of the given <i><tt class='parameter'>image</tt></i> resource. </p> </div> <a name='function.imagesx.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imagesx.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Return the width of the <i><tt class='parameter'>image</tt></i> or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagesx.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>imagesx()</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;create&amp;nbsp;a&amp;nbsp;300*200&amp;nbsp;image<br /></span><span style='color: #0000BB'>$img&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>300</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;300<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imagesx.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.imagecreatetruecolor.php' class='function' rel='rdfs-seeAlso'>imagecreatetruecolor()</a> - Create a new true color 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> <li class='member'><a href='http://www.php.net/manual/en/function.imagesy.php' class='function' rel='rdfs-seeAlso'>imagesy()</a> - Get image height</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="imagestringup" value="<div id='function.imagestringup' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagestringup.php'>imagestringup</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagestringup</span> &amp;mdash; <span class='dc-title'>Draw a string vertically</span></p> </div> <a name='function.imagestringup.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>imagestringup</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$font</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> Draws a <i><tt class='parameter'>string</tt></i> vertically at the given coordinates. </p> </div> <a name='function.imagestringup.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> font</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Can be 1, 2, 3, 4, 5 for built-in fonts in latin2 encoding (where higher numbers corresponding to larger fonts) or any of your own font identifiers registered with <a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function'>imageloadfont()</a>. </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of the upper left corner. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of the upper left corner. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to be written. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagestringup.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.imagestringup.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.imagestring.php' class='function'>imagestring()</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 /></span><span style='color: #FF8000'>//&amp;nbsp;create&amp;nbsp;a&amp;nbsp;100*100&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Write&amp;nbsp;the&amp;nbsp;text<br /></span><span style='color: #0000BB'>$textcolor&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestringup</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>40</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>80</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'gd&amp;nbsp;library'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$textcolor</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./stringup.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagestringup.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagestringup.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.imageloadfont.php' class='function' rel='rdfs-seeAlso'>imageloadfont()</a> - Load a new font</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="imagestring" value="<div id='function.imagestring' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagestring.php'>imagestring</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagestring</span> &amp;mdash; <span class='dc-title'>Draw a string horizontally</span></p> </div> <a name='function.imagestring.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>imagestring</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$font</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> Draws a <i><tt class='parameter'>string</tt></i> at the given coordinates. </p> </div> <a name='function.imagestring.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> font</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Can be 1, 2, 3, 4, 5 for built-in fonts in latin2 encoding (where higher numbers corresponding to larger fonts) or any of your own font identifiers registered with <a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function'>imageloadfont()</a>. </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of the upper left corner. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of the upper left corner. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to be written. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagestring.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.imagestring.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagestring()</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;Create&amp;nbsp;a&amp;nbsp;100*30&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</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;White&amp;nbsp;background&amp;nbsp;and&amp;nbsp;blue&amp;nbsp;text<br /></span><span style='color: #0000BB'>$bg&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$textcolor&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Write&amp;nbsp;the&amp;nbsp;string&amp;nbsp;at&amp;nbsp;the&amp;nbsp;top&amp;nbsp;left<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>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: #DD0000'>'Hello&amp;nbsp;world!'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$textcolor</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagestring.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagestring.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.imageloadfont.php' class='function' rel='rdfs-seeAlso'>imageloadfont()</a> - Load a new font</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagettftext.php' class='function' rel='rdfs-seeAlso'>imagettftext()</a> - Write text to the image using TrueType fonts</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="imagesettile" value="<div id='function.imagesettile' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagesettile.php'>imagesettile</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagesettile</span> &amp;mdash; <span class='dc-title'>Set the tile image for filling</span></p> </div> <a name='function.imagesettile.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>imagesettile</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$tile</tt></span> )</div> <p class='para rdfs-comment'> <b>imagesettile()</b> sets the tile image to be used by all region filling functions (such as <a href='http://www.php.net/manual/en/function.imagefill.php' class='function'>imagefill()</a> and <a href='http://www.php.net/manual/en/function.imagefilledpolygon.php' class='function'>imagefilledpolygon()</a>) when filling with the special color <b><tt class='constant'>IMG_COLOR_TILED</tt></b>. </p> <p class='para'> A tile is an image used to fill an area with a repeated pattern. <em class='emphasis'>Any</em> GD image can be used as a tile, and by setting the transparent color index of the tile image with <a href='http://www.php.net/manual/en/function.imagecolortransparent.php' class='function'>imagecolortransparent()</a>, a tile allows certain parts of the underlying area to shine through can be created. </p> <blockquote><p><b class='note'>Note</b>: You need not take special action when you are finished with a tile, but if you destroy the tile image, you must not use the <b><tt class='constant'>IMG_COLOR_TILED</tt></b> color until you have set a new tile image! <br /> </p></blockquote> </div> <a name='function.imagesettile.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>tile</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The image resource to be used as a tile. </p> </dd> </dl> <p> </p> </div> <a name='function.imagesettile.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.imagesettile.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagesettile()</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;Load&amp;nbsp;an&amp;nbsp;external&amp;nbsp;image<br /></span><span style='color: #0000BB'>$zend&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./zend.gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;200x200&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;tile<br /></span><span style='color: #0000BB'>imagesettile</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$zend</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Make&amp;nbsp;the&amp;nbsp;image&amp;nbsp;repeat<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>199</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>199</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_COLOR_TILED</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;image&amp;nbsp;to&amp;nbsp;the&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$zend</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagesettile.png' /> </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="imagesetthickness" value="<div id='function.imagesetthickness' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagesetthickness.php'>imagesetthickness</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagesetthickness</span> &amp;mdash; <span class='dc-title'>Set the thickness for line drawing</span></p> </div> <a name='function.imagesetthickness.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>imagesetthickness</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$thickness</tt></span> )</div> <p class='para rdfs-comment'> <b>imagesetthickness()</b> sets the thickness of the lines drawn when drawing rectangles, polygons, ellipses etc. etc. to <i><tt class='parameter'>thickness</tt></i> pixels. </p> </div> <a name='function.imagesetthickness.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>thickness</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Thickness, in pixels. </p> </dd> </dl> <p> </p> </div> <a name='function.imagesetthickness.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.imagesetthickness.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagesetthickness()</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;Create&amp;nbsp;a&amp;nbsp;200x100&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;background&amp;nbsp;to&amp;nbsp;be&amp;nbsp;white<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>299</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>99</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;line&amp;nbsp;thickness&amp;nbsp;to&amp;nbsp;5<br /></span><span style='color: #0000BB'>imagesetthickness</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;the&amp;nbsp;rectangle<br /></span><span style='color: #0000BB'>imagerectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>185</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>85</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$black</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;image&amp;nbsp;to&amp;nbsp;the&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagesetthickness.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagesetthickness.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</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="imagesetstyle" value="<div id='function.imagesetstyle' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagesetstyle.php'>imagesetstyle</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagesetstyle</span> &amp;mdash; <span class='dc-title'>Set the style for line drawing</span></p> </div> <a name='function.imagesetstyle.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>imagesetstyle</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$style</tt></span> )</div> <p class='para rdfs-comment'> <b>imagesetstyle()</b> sets the style to be used by all line drawing functions (such as <a href='http://www.php.net/manual/en/function.imageline.php' class='function'>imageline()</a> and <a href='http://www.php.net/manual/en/function.imagepolygon.php' class='function'>imagepolygon()</a>) when drawing with the special color <b><tt class='constant'>IMG_COLOR_STYLED</tt></b> or lines of images with color <b><tt class='constant'>IMG_COLOR_STYLEDBRUSHED</tt></b>. </p> </div> <a name='function.imagesetstyle.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>style</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array of pixel colors. You can use the <b><tt class='constant'>IMG_COLOR_TRANSPARENT</tt></b> constant to add a transparent pixel. </p> </dd> </dl> <p> </p> </div> <a name='function.imagesetstyle.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.imagesetstyle.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> Following example script draws a dashed line from upper left to lower right corner of the canvas: </p><div class='example'> <p><b>Example #1 <b>imagesetstyle()</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 />header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$im&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$w&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$red&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Draw&amp;nbsp;a&amp;nbsp;dashed&amp;nbsp;line,&amp;nbsp;5&amp;nbsp;red&amp;nbsp;pixels,&amp;nbsp;5&amp;nbsp;white&amp;nbsp;pixels&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$style&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red</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'>$w</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'>$w</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$w</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagesetstyle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$style</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imageline</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_COLOR_STYLED</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Draw&amp;nbsp;a&amp;nbsp;line&amp;nbsp;of&amp;nbsp;happy&amp;nbsp;faces&amp;nbsp;using&amp;nbsp;imagesetbrush()&amp;nbsp;with&amp;nbsp;imagesetstyle&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$style&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #0000BB'>$w</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'>$w</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'>$w</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'>$w</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'>$w</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'>$w</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'>$red</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagesetstyle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$style</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$brush&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'http://www.libpng.org/pub/png/images/smile.happy.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$w2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$brush</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagecolortransparent</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$brush</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$w2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagesetbrush</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$brush</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imageline</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</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'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_COLOR_STYLEDBRUSHED</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagesetstyle.jpg' /> </div> </div> </div><p> </p> </div> <a name='function.imagesetstyle.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.imagesetbrush.php' class='function' rel='rdfs-seeAlso'>imagesetbrush()</a> - Set the brush image for line drawing</li> <li class='member'><a href='http://www.php.net/manual/en/function.imageline.php' class='function' rel='rdfs-seeAlso'>imageline()</a> - Draw a line</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="imagesetpixel" value="<div id='function.imagesetpixel' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagesetpixel.php'>imagesetpixel</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagesetpixel</span> &amp;mdash; <span class='dc-title'>Set a single pixel</span></p> </div> <a name='function.imagesetpixel.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>imagesetpixel</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> <b>imagesetpixel()</b> draws a pixel at the specified coordinate. </p> </div> <a name='function.imagesetpixel.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagesetpixel.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.imagesetpixel.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagesetpixel()</b> example</b></p> <div class='example-contents para'><p> A random drawing that ends with a regular picture. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$x&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$y&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$gd&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</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'>);<br />&amp;nbsp;<br /></span><span style='color: #0000BB'>$corners</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;array(</span><span style='color: #DD0000'>'x'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'y'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$corners</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;array(</span><span style='color: #DD0000'>'x'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'y'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>190</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$corners</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;array(</span><span style='color: #DD0000'>'x'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'y'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>190</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$red&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$gd</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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;<br /><br />for&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</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'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>100000</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;</span><span style='color: #0000BB'>imagesetpixel</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$gd</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$x</span><span style='color: #007700'>),</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$y</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>rand</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$x&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;(</span><span style='color: #0000BB'>$x&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>$corners</span><span style='color: #007700'>[</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>][</span><span style='color: #DD0000'>'x'</span><span style='color: #007700'>])&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$y&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;(</span><span style='color: #0000BB'>$y&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>$corners</span><span style='color: #007700'>[</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>][</span><span style='color: #DD0000'>'y'</span><span style='color: #007700'>])&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>;<br />}<br />&amp;nbsp;<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$gd</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagesetpixel.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagesetpixel.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.imagecreatetruecolor.php' class='function' rel='rdfs-seeAlso'>imagecreatetruecolor()</a> - Create a new true color image</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function' rel='rdfs-seeAlso'>imagecolorallocate()</a> - Allocate a color for 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="imagesetbrush" value="<div id='function.imagesetbrush' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagesetbrush.php'>imagesetbrush</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagesetbrush</span> &amp;mdash; <span class='dc-title'>Set the brush image for line drawing</span></p> </div> <a name='function.imagesetbrush.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>imagesetbrush</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$brush</tt></span> )</div> <p class='para rdfs-comment'> <b>imagesetbrush()</b> sets the brush image to be used by all line drawing functions (such as <a href='http://www.php.net/manual/en/function.imageline.php' class='function'>imageline()</a> and <a href='http://www.php.net/manual/en/function.imagepolygon.php' class='function'>imagepolygon()</a>) when drawing with the special colors <b><tt class='constant'>IMG_COLOR_BRUSHED</tt></b> or <b><tt class='constant'>IMG_COLOR_STYLEDBRUSHED</tt></b>. </p> </div> <a name='function.imagesetbrush.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>brush</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An image resource. </p> </dd> </dl> <p> </p> </div> <a name='function.imagesetbrush.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.imagesetbrush.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagesetbrush()</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;Load&amp;nbsp;a&amp;nbsp;mini&amp;nbsp;php&amp;nbsp;logo<br /></span><span style='color: #0000BB'>$php&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./php.png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;main&amp;nbsp;image,&amp;nbsp;100x100<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Fill&amp;nbsp;the&amp;nbsp;background&amp;nbsp;with&amp;nbsp;white<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>299</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>99</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;brush<br /></span><span style='color: #0000BB'>imagesetbrush</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$php</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;a&amp;nbsp;couple&amp;nbsp;of&amp;nbsp;brushes,&amp;nbsp;each&amp;nbsp;overlaying&amp;nbsp;each<br /></span><span style='color: #0000BB'>imageline</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>60</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_COLOR_BRUSHED</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;image&amp;nbsp;to&amp;nbsp;the&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$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 something similar to:</p></div> <div class='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagesetbrush.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagesetbrush.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: You need not take special action when you are finished with a brush, but if you destroy the brush image, you must not use the <b><tt class='constant'>IMG_COLOR_BRUSHED</tt></b> or <b><tt class='constant'>IMG_COLOR_STYLEDBRUSHED</tt></b> colors until you have set a new brush image! <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="imagesavealpha" value="<div id='function.imagesavealpha' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagesavealpha.php'>imagesavealpha</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.2, PHP 5)</p><p class='refpurpose'><span class='refname'>imagesavealpha</span> &amp;mdash; <span class='dc-title'>Set the flag to save full alpha channel information (as opposed to single-color transparency) when saving PNG images</span></p> </div> <a name='function.imagesavealpha.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>imagesavealpha</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$saveflag</tt></span> )</div> <p class='para rdfs-comment'> <b>imagesavealpha()</b> sets the flag to attempt to save full alpha channel information (as opposed to single-color transparency) when saving PNG images. </p> <p class='para'> You have to unset alphablending (<i>imagealphablending($im, false)</i>), to use it. </p> <p class='para'> Alpha channel is not supported by all browsers, if you have problem with your browser, try to load your script with an alpha channel compliant browser, e.g. latest Mozilla. </p> </div> <a name='function.imagesavealpha.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>saveflag</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whether to save the alpha channel or not. Default to <b><tt class='constant'>FALSE</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagesavealpha.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.imagesavealpha.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagesavealpha()</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;Load&amp;nbsp;a&amp;nbsp;png&amp;nbsp;image&amp;nbsp;with&amp;nbsp;alpha&amp;nbsp;channels<br /></span><span style='color: #0000BB'>$png&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./alphachannel_example.png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;required&amp;nbsp;operations<br /><br />//&amp;nbsp;Turn&amp;nbsp;off&amp;nbsp;alpha&amp;nbsp;blending&amp;nbsp;and&amp;nbsp;set&amp;nbsp;alpha&amp;nbsp;flag<br /></span><span style='color: #0000BB'>imagealphablending</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$png</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagesavealpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$png</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;Output&amp;nbsp;image&amp;nbsp;to&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$png</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$png</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.imagesavealpha.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> </div> <a name='function.imagesavealpha.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.imagealphablending.php' class='function' rel='rdfs-seeAlso'>imagealphablending()</a> - Set the blending mode for 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="imagerotate" value="<div id='function.imagerotate' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagerotate.php'>imagerotate</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>imagerotate</span> &amp;mdash; <span class='dc-title'>Rotate an image with a given angle</span></p> </div> <a name='function.imagerotate.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>imagerotate</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$angle</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$bgd_color</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$ignore_transparent</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Rotates the <i><tt class='parameter'>image</tt></i> image using the given <i><tt class='parameter'>angle</tt></i> in degrees. </p> <p class='para'> The center of rotation is the center of the image, and the rotated image may have different dimensions than the original image. </p> <p class='para'> </p> </div> <a name='function.imagerotate.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>angle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Rotation angle, in degrees. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>bgd_color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the color of the uncovered zone after the rotation </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ignore_transparent</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If set and non-zero, transparent colors are ignored (otherwise kept). </p> </dd> </dl> <p> </p> </div> <a name='function.imagerotate.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> </p> </div> <a name='function.imagerotate.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.1.0</td> <td align='left'> <i><tt class='parameter'>ignore_transparent</tt></i> was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imagerotate.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Rotate an image 180 degrees</b></p> <div class='example-contents para'><p> This example rotates an image 180 degrees - upside down. </p></div> <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;File&amp;nbsp;and&amp;nbsp;rotation<br /></span><span style='color: #0000BB'>$filename&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'test.jpg'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$degrees&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>180</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Content&amp;nbsp;type<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Load<br /></span><span style='color: #0000BB'>$source&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromjpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Rotate<br /></span><span style='color: #0000BB'>$rotate&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagerotate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$source</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$degrees</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;Output<br /></span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$rotate</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagerotate.jpg' /> </div> </div> </div><p> </p> </div> <a name='function.imagerotate.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 if PHP is compiled with the bundled version of the GD library.</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="imagerectangle" value="<div id='function.imagerectangle' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagerectangle.php'>imagerectangle</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagerectangle</span> &amp;mdash; <span class='dc-title'>Draw a rectangle</span></p> </div> <a name='function.imagerectangle.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>imagerectangle</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x1</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y1</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> <b>imagerectangle()</b> creates a rectangle starting at the specified coordinates. </p> </div> <a name='function.imagerectangle.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Upper left x coordinate. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Upper left y coordinate 0, 0 is the top left corner of the image. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Bottom right x coordinate. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Bottom right y coordinate. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagerectangle.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.imagerectangle.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Simple <b>imagerectangle()</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;Create&amp;nbsp;a&amp;nbsp;200&amp;nbsp;x&amp;nbsp;200&amp;nbsp;image<br /></span><span style='color: #0000BB'>$canvas&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Allocate&amp;nbsp;colors<br /></span><span style='color: #0000BB'>$pink&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$canvas</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>105</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>180</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$canvas</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$green&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$canvas</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>132</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>135</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>28</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;three&amp;nbsp;rectangles&amp;nbsp;each&amp;nbsp;with&amp;nbsp;its&amp;nbsp;own&amp;nbsp;color<br /></span><span style='color: #0000BB'>imagerectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$canvas</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$pink</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagerectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$canvas</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>45</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>60</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagerectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$canvas</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>160</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$green</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;and&amp;nbsp;free&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$canvas</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$canvas</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagerectangle.jpg' /> </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="imagepstext" value="<div id='function.imagepstext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagepstext.php'>imagepstext</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagepstext</span> &amp;mdash; <span class='dc-title'>Draws a text over an image using PostScript Type1 fonts</span></p> </div> <a name='function.imagepstext.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>imagepstext</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$font_index</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$size</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$foreground</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$background</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$space</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$tightness</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$angle</tt><span class='initializer'> = 0.0</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$antialias_steps</tt><span class='initializer'> = 4</span></span> ]]]] )</div> <p class='para rdfs-comment'> Draws a text on an image using PostScript Type1 fonts. </p> <p class='para'> Refer to PostScript documentation about fonts and their measuring system if you have trouble understanding how this works. </p> </div> <a name='function.imagepstext.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The text to be written. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>font_index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A font resource, returned by <a href='http://www.php.net/manual/en/function.imagepsloadfont.php' class='function'>imagepsloadfont()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>size</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>size</tt></i> is expressed in pixels. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>foreground</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The color in which the text will be painted. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>background</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The color to which the text will try to fade in with antialiasing. No pixels with the color <i><tt class='parameter'>background</tt></i> are actually painted, so the background image does not need to be of solid color. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate for the lower-left corner of the first character. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate for the lower-left corner of the first character. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>space</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Allows you to change the default value of a space in a font. This amount is added to the normal value and can also be negative. Expressed in character space units, where 1 unit is 1/1000th of an em-square. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>tightness</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>tightness</tt></i> allows you to control the amount of white space between characters. This amount is added to the normal character width and can also be negative. Expressed in character space units, where 1 unit is 1/1000th of an em-square. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>angle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>angle</tt></i> is in degrees. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>antialias_steps</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Allows you to control the number of colours used for antialiasing text. Allowed values are 4 and 16. The higher value is recommended for text sizes lower than 20, where the effect in text quality is quite visible. With bigger sizes, use 4. It&amp;#039;s less computationally intensive. </p> </dd> </dl> <p> </p> </div> <a name='function.imagepstext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> This function returns an array containing the following elements: </p><table class='doctable informaltable'> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0</td> <td align='left'>lower left x-coordinate</td> </tr> <tr valign='middle'> <td align='left'>1</td> <td align='left'>lower left y-coordinate</td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'>upper right x-coordinate</td> </tr> <tr valign='middle'> <td align='left'>3</td> <td align='left'>upper right y-coordinate</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imagepstext.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>imagepstext()</b> usage</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;image&amp;nbsp;handle<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Allocate&amp;nbsp;colors<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Load&amp;nbsp;the&amp;nbsp;PostScript&amp;nbsp;Font<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagepsloadfont</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'font.pfm'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Write&amp;nbsp;the&amp;nbsp;font&amp;nbsp;to&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagepstext</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Sample&amp;nbsp;text&amp;nbsp;is&amp;nbsp;simple'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</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'>$black</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;and&amp;nbsp;free&amp;nbsp;memory<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.imagepstext.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 if PHP is compiled using <span class='option'>--with-t1lib[=DIR]</span>. </span></p></blockquote> </div> <a name='function.imagepstext.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.imagepsbbox.php' class='function' rel='rdfs-seeAlso'>imagepsbbox()</a> - Give the bounding box of a text rectangle using PostScript Type1 fonts</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="imagepsslantfont" value="<div id='function.imagepsslantfont' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagepsslantfont.php'>imagepsslantfont</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagepsslantfont</span> &amp;mdash; <span class='dc-title'>Slant a font</span></p> </div> <a name='function.imagepsslantfont.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>imagepsslantfont</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$font_index</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$slant</tt></span> )</div> <p class='para rdfs-comment'> Slant a given font given. </p> </div> <a name='function.imagepsslantfont.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'>font_index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A font resource, returned by <a href='http://www.php.net/manual/en/function.imagepsloadfont.php' class='function'>imagepsloadfont()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>slant</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Slant level. </p> </dd> </dl> <p> </p> </div> <a name='function.imagepsslantfont.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.imagepsslantfont.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagepsslantfont()</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;Load&amp;nbsp;a&amp;nbsp;.pfb&amp;nbsp;font&amp;nbsp;file<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagepsloadfont</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./px3l.pfb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Slant&amp;nbsp;the&amp;nbsp;font&amp;nbsp;by&amp;nbsp;22.5<br /></span><span style='color: #0000BB'>imagepsslantfont</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>22.5</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;any&amp;nbsp;operations&amp;nbsp;with&amp;nbsp;the&amp;nbsp;font&amp;nbsp;here<br /><br />//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;font&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagepsfreefont</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$font</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.imagepsslantfont.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 if PHP is compiled using <span class='option'>--with-t1lib[=DIR]</span>. </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="imagepsloadfont" value="<div id='function.imagepsloadfont' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagepsloadfont.php'>imagepsloadfont</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagepsloadfont</span> &amp;mdash; <span class='dc-title'>Load a PostScript Type 1 font from file</span></p> </div> <a name='function.imagepsloadfont.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>imagepsloadfont</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Load a PostScript Type 1 font from the given <i><tt class='parameter'>filename</tt></i> . </p> </div> <a name='function.imagepsloadfont.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 Postscript font file. </p> </dd> </dl> <p> </p> </div> <a name='function.imagepsloadfont.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> In the case everything went right, a valid font index will be returned and can be used for further purposes. Otherwise the function returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.imagepsloadfont.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagepsloadfont()</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;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;image&amp;nbsp;instance<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>350</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>45</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Allocate&amp;nbsp;colors&amp;nbsp;and&amp;nbsp;fill&amp;nbsp;the&amp;nbsp;background<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>349</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>44</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Load&amp;nbsp;a&amp;nbsp;font,&amp;nbsp;write&amp;nbsp;to&amp;nbsp;the&amp;nbsp;image&amp;nbsp;and&amp;nbsp;free&amp;nbsp;the&amp;nbsp;font&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagepsloadfont</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'bchbi.pfb'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepstext</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Testing...&amp;nbsp;It&amp;nbsp;worked!'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>32</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$black</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>32</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>32</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepsfreefont</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagepsloadfont.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 if PHP is compiled using <span class='option'>--with-t1lib[=DIR]</span>. </span></p></blockquote> </div> <a name='function.imagepsloadfont.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.imagepsfreefont.php' class='function' rel='rdfs-seeAlso'>imagepsfreefont()</a> - Free memory used by a PostScript Type 1 font</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="imagepsfreefont" value="<div id='function.imagepsfreefont' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagepsfreefont.php'>imagepsfreefont</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagepsfreefont</span> &amp;mdash; <span class='dc-title'>Free memory used by a PostScript Type 1 font</span></p> </div> <a name='function.imagepsfreefont.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>imagepsfreefont</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$font_index</tt></span> )</div> <p class='para rdfs-comment'> <b>imagepsfreefont()</b> frees memory used by a PostScript Type 1 font. </p> </div> <a name='function.imagepsfreefont.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'>font_index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A font resource, returned by <a href='http://www.php.net/manual/en/function.imagepsloadfont.php' class='function'>imagepsloadfont()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagepsfreefont.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.imagepsfreefont.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagepsfreefont()</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;Load&amp;nbsp;a&amp;nbsp;.pfb&amp;nbsp;font&amp;nbsp;file<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagepsloadfont</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./bchbi.pfb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;any&amp;nbsp;operations&amp;nbsp;with&amp;nbsp;the&amp;nbsp;font&amp;nbsp;here<br /><br />//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;font&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagepsfreefont</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$font</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.imagepsfreefont.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 if PHP is compiled using <span class='option'>--with-t1lib[=DIR]</span>. </span></p></blockquote> </div> <a name='function.imagepsfreefont.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.imagepsloadfont.php' class='function' rel='rdfs-seeAlso'>imagepsloadfont()</a> - Load a PostScript Type 1 font from file</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="imagepsextendfont" value="<div id='function.imagepsextendfont' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagepsextendfont.php'>imagepsextendfont</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagepsextendfont</span> &amp;mdash; <span class='dc-title'>Extend or condense a font</span></p> </div> <a name='function.imagepsextendfont.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>imagepsextendfont</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$font_index</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$extend</tt></span> )</div> <p class='para rdfs-comment'> Extend or condense a font (<i><tt class='parameter'>font_index</tt></i> ), if the value of the <i><tt class='parameter'>extend</tt></i> parameter is less than one you will be condensing the font. </p> </div> <a name='function.imagepsextendfont.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'>font_index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A font resource, returned by <a href='http://www.php.net/manual/en/function.imagepsloadfont.php' class='function'>imagepsloadfont()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>extend</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Extension value, must be greater than 0. </p> </dd> </dl> <p> </p> </div> <a name='function.imagepsextendfont.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.imagepsextendfont.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagepsextendfont()</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;Load&amp;nbsp;a&amp;nbsp;.pfb&amp;nbsp;font&amp;nbsp;file<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagepsloadfont</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./px3l.pfb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Extend&amp;nbsp;the&amp;nbsp;font&amp;nbsp;by&amp;nbsp;2.5<br /></span><span style='color: #0000BB'>imagepsextendfont</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2.5</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;any&amp;nbsp;operations&amp;nbsp;with&amp;nbsp;the&amp;nbsp;font&amp;nbsp;here<br /><br />//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;font&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagepsfreefont</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$font</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.imagepsextendfont.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 if PHP is compiled using <span class='option'>--with-t1lib[=DIR]</span>. </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="imagepsencodefont" value="<div id='function.imagepsencodefont' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagepsencodefont.php'>imagepsencodefont</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagepsencodefont</span> &amp;mdash; <span class='dc-title'>Change the character encoding vector of a font</span></p> </div> <a name='function.imagepsencodefont.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>imagepsencodefont</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$font_index</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encodingfile</tt></span> )</div> <p class='para rdfs-comment'> Loads a character encoding vector from a file and changes the fonts encoding vector to it. As a PostScript fonts default vector lacks most of the character positions above 127, you&amp;#039;ll definitely want to change this if you use an other language than English. </p> <p class='para'> If you find yourself using this function all the time, a much better way to define the encoding is to set ps.default_encoding in the <a href='http://www.php.net/manual/en/configuration.file.php' class='link'>configuration file</a> to point to the right encoding file and all fonts you load will automatically have the right encoding. </p> </div> <a name='function.imagepsencodefont.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'>font_index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A font resource, returned by <a href='http://www.php.net/manual/en/function.imagepsloadfont.php' class='function'>imagepsloadfont()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encodingfile</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The exact format of this file is described in T1libs documentation. T1lib comes with two ready-to-use files, <var class='filename'>IsoLatin1.enc</var> and <var class='filename'>IsoLatin2.enc</var>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagepsencodefont.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.imagepsencodefont.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagepsencodefont()</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;Load&amp;nbsp;a&amp;nbsp;.pfb&amp;nbsp;font&amp;nbsp;file<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagepsloadfont</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./px3l.pfb'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Tell&amp;nbsp;T1lib&amp;nbsp;to&amp;nbsp;use&amp;nbsp;ISO&amp;nbsp;Latin&amp;nbsp;1&amp;nbsp;encoding<br /></span><span style='color: #0000BB'>imagepsencode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./IsoLatin1.enc'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;any&amp;nbsp;operations&amp;nbsp;with&amp;nbsp;the&amp;nbsp;font&amp;nbsp;here<br /><br />//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;font&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagepsfreefont</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$font</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.imagepsencodefont.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 if PHP is compiled using <span class='option'>--with-t1lib[=DIR]</span>. </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="imagepsbbox" value="<div id='function.imagepsbbox' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagepsbbox.php'>imagepsbbox</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagepsbbox</span> &amp;mdash; <span class='dc-title'>Give the bounding box of a text rectangle using PostScript Type1 fonts</span></p> </div> <a name='function.imagepsbbox.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>imagepsbbox</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$font</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$size</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>imagepsbbox</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$font</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$size</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$space</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$tightness</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$angle</tt></span> )</div> <p class='para rdfs-comment'> Gives the bounding box of a text rectangle using PostScript Type1 fonts. </p> <p class='para'> The bounding box is calculated using information available from character metrics, and unfortunately tends to differ slightly from the results achieved by actually rasterizing the text. If the angle is 0 degrees, you can expect the text to need 1 pixel more to every direction. </p> </div> <a name='function.imagepsbbox.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 text to be written. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>font_index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A font resource, returned by <a href='http://www.php.net/manual/en/function.imagepsloadfont.php' class='function'>imagepsloadfont()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>size</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>size</tt></i> is expressed in pixels. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>space</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Allows you to change the default value of a space in a font. This amount is added to the normal value and can also be negative. Expressed in character space units, where 1 unit is 1/1000th of an em-square. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>tightness</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>tightness</tt></i> allows you to control the amount of white space between characters. This amount is added to the normal character width and can also be negative. Expressed in character space units, where 1 unit is 1/1000th of an em-square. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>angle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>angle</tt></i> is in degrees. </p> </dd> </dl> <p> </p> </div> <a name='function.imagepsbbox.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array containing the following elements: </p><table class='doctable informaltable'> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0</td> <td align='left'>left x-coordinate</td> </tr> <tr valign='middle'> <td align='left'>1</td> <td align='left'>upper y-coordinate</td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'>right x-coordinate</td> </tr> <tr valign='middle'> <td align='left'>3</td> <td align='left'>lower y-coordinate</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imagepsbbox.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>imagepsbbox()</b> usage</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;image&amp;nbsp;handle<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Allocate&amp;nbsp;colors<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Load&amp;nbsp;the&amp;nbsp;PostScript&amp;nbsp;Font<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagepsloadfont</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'font.pfm'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Make&amp;nbsp;a&amp;nbsp;bounding&amp;nbsp;box&amp;nbsp;for&amp;nbsp;the&amp;nbsp;font<br /></span><span style='color: #0000BB'>$bbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagepsbbox</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Sample&amp;nbsp;text&amp;nbsp;is&amp;nbsp;simple'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>12</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Define&amp;nbsp;our&amp;nbsp;X&amp;nbsp;and&amp;nbsp;Y&amp;nbsp;cordinates<br /></span><span style='color: #0000BB'>$x&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;(</span><span style='color: #0000BB'>$bbox</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'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$y&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;(</span><span style='color: #0000BB'>$bbox</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'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Write&amp;nbsp;the&amp;nbsp;font&amp;nbsp;to&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagepstext</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Sample&amp;nbsp;text&amp;nbsp;is&amp;nbsp;simple'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</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'>$black</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$x</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$y</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;and&amp;nbsp;free&amp;nbsp;memory<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.imagepsbbox.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 if PHP is compiled using <span class='option'>--with-t1lib[=DIR]</span>. </span></p></blockquote> </div> <a name='function.imagepsbbox.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.imagepstext.php' class='function' rel='rdfs-seeAlso'>imagepstext()</a> - Draws a text over an image using PostScript Type1 fonts</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="imagepolygon" value="<div id='function.imagepolygon' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagepolygon.php'>imagepolygon</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagepolygon</span> &amp;mdash; <span class='dc-title'>Draws a polygon</span></p> </div> <a name='function.imagepolygon.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>imagepolygon</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$points</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$num_points</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> <b>imagepolygon()</b> creates a polygon in the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagepolygon.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>points</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array containing the polygon&amp;#039;s vertices, e.g.: </p><table class='doctable informaltable'> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>points[0]</td> <td align='left'>= x0</td> </tr> <tr valign='middle'> <td align='left'>points[1]</td> <td align='left'>= y0</td> </tr> <tr valign='middle'> <td align='left'>points[2]</td> <td align='left'>= x1</td> </tr> <tr valign='middle'> <td align='left'>points[3]</td> <td align='left'>= y1</td> </tr> </tbody> </table> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>num_points</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Total number of points (vertices). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagepolygon.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.imagepolygon.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagepolygon()</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;Create&amp;nbsp;a&amp;nbsp;blank&amp;nbsp;image<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>400</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>300</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Allocate&amp;nbsp;a&amp;nbsp;color&amp;nbsp;for&amp;nbsp;the&amp;nbsp;polygon<br /></span><span style='color: #0000BB'>$col_poly&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;the&amp;nbsp;polygon<br /></span><span style='color: #0000BB'>imagepolygon</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;array(<br />&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;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</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'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</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'>300</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$col_poly</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;the&amp;nbsp;picture&amp;nbsp;to&amp;nbsp;the&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagepolygon.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagepolygon.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.imagecreate.php' class='function' rel='rdfs-seeAlso'>imagecreate()</a> - Create a new palette based image</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function' rel='rdfs-seeAlso'>imagecreatetruecolor()</a> - Create a new true color 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="imagepng" value="<div id='function.imagepng' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagepng.php'>imagepng</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagepng</span> &amp;mdash; <span class='dc-title'>Output a PNG image to either the browser or a file</span></p> </div> <a name='function.imagepng.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>imagepng</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></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'>$quality</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$filters</tt></span> ]]] )</div> <p class='para rdfs-comment'> Outputs or saves a <acronym title='Portable Network Graphics'>PNG</acronym> image from the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagepng.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path to save the file to. If not set or <b><tt class='constant'>NULL</tt></b>, the raw image stream will be outputted directly. </p> <blockquote><p><b class='note'>Note</b>: <b><tt class='constant'>NULL</tt></b> is invalid if the <i><tt class='parameter'>quality</tt></i> and <i><tt class='parameter'>filters</tt></i> arguments are not used. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>quality</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Compression level: from 0 (no compression) to 9. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filters</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Allows reducing the PNG file size. It is a bitmask field which may be set to any combination of the <i>PNG_FILTER_XXX</i> constants. <b><tt class='constant'>PNG_NO_FILTER</tt></b> or <b><tt class='constant'>PNG_ALL_FILTERS</tt></b> may also be used to respectively disable or activate all filters. </p> </dd> </dl> <p> </p> </div> <a name='function.imagepng.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.imagepng.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.1.3</td> <td align='left'> Added the <i><tt class='parameter'>filters</tt></i> parameter. </td> </tr> <tr valign='middle'> <td align='left'>5.1.2</td> <td align='left'> Added the <i><tt class='parameter'>quality</tt></i> parameter. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imagepng.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </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 />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'test.png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagepng.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.imagegif.php' class='function' rel='rdfs-seeAlso'>imagegif()</a> - Output image to browser or file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagewbmp.php' class='function' rel='rdfs-seeAlso'>imagewbmp()</a> - Output image to browser or file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagejpeg.php' class='function' rel='rdfs-seeAlso'>imagejpeg()</a> - Output image to browser or file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagetypes.php' class='function' rel='rdfs-seeAlso'>imagetypes()</a> - Return the image types supported by this PHP build</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagesavealpha.php' class='function' rel='rdfs-seeAlso'>imagesavealpha()</a> - Set the flag to save full alpha channel information (as opposed to single-color transparency) when saving PNG images</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="imagepalettecopy" value="<div id='function.imagepalettecopy' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagepalettecopy.php'>imagepalettecopy</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.1, PHP 5)</p><p class='refpurpose'><span class='refname'>imagepalettecopy</span> &amp;mdash; <span class='dc-title'>Copy the palette from one image to another</span></p> </div> <a name='function.imagepalettecopy.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>imagepalettecopy</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$destination</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$source</tt></span> )</div> <p class='para rdfs-comment'> <b>imagepalettecopy()</b> copies the palette from the <i><tt class='parameter'>source</tt></i> image to the <i><tt class='parameter'>destination</tt></i> image. </p> </div> <a name='function.imagepalettecopy.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'>destination</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The destination image resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>source</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The source image resource. </p> </dd> </dl> <p> </p> </div> <a name='function.imagepalettecopy.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.imagepalettecopy.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagepalettecopy()</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;Create&amp;nbsp;two&amp;nbsp;palette&amp;nbsp;images<br /></span><span style='color: #0000BB'>$palette1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$palette2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Allocate&amp;nbsp;the&amp;nbsp;background&amp;nbsp;to&amp;nbsp;be&amp;nbsp;<br />//&amp;nbsp;green&amp;nbsp;in&amp;nbsp;the&amp;nbsp;first&amp;nbsp;palette&amp;nbsp;image<br /></span><span style='color: #0000BB'>$green&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$palette1</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'>255</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;Copy&amp;nbsp;the&amp;nbsp;palette&amp;nbsp;from&amp;nbsp;image&amp;nbsp;1&amp;nbsp;to&amp;nbsp;image&amp;nbsp;2<br /></span><span style='color: #0000BB'>imagepalettecopy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$palette2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$palette1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Since&amp;nbsp;the&amp;nbsp;palette&amp;nbsp;is&amp;nbsp;now&amp;nbsp;copied&amp;nbsp;we&amp;nbsp;can&amp;nbsp;use&amp;nbsp;the&amp;nbsp;<br />//&amp;nbsp;green&amp;nbsp;color&amp;nbsp;allocated&amp;nbsp;to&amp;nbsp;image&amp;nbsp;1&amp;nbsp;without&amp;nbsp;using&amp;nbsp;<br />//&amp;nbsp;imagecolorallocate()&amp;nbsp;twice<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$palette2</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'>99</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>99</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$green</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;image&amp;nbsp;to&amp;nbsp;the&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$palette2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$palette1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$palette2</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="imageloadfont" value="<div id='function.imageloadfont' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imageloadfont.php'>imageloadfont</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imageloadfont</span> &amp;mdash; <span class='dc-title'>Load a new font</span></p> </div> <a name='function.imageloadfont.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>imageloadfont</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$file</tt></span> )</div> <p class='para rdfs-comment'> <b>imageloadfont()</b> loads a user-defined bitmap and returns its identifier. </p> </div> <a name='function.imageloadfont.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'>file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The font file format is currently binary and architecture dependent. This means you should generate the font files on the same type of CPU as the machine you are running PHP on. </p> <p class='para'> </p><table class='doctable table'> <caption><b>Font file format</b></caption> <thead valign='middle'> <tr valign='middle'> <th>byte position</th> <th>C data type</th> <th>description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>byte 0-3</td> <td align='left'>int</td> <td align='left'>number of characters in the font</td> </tr> <tr valign='middle'> <td align='left'>byte 4-7</td> <td align='left'>int</td> <td align='left'> value of first character in the font (often 32 for space) </td> </tr> <tr valign='middle'> <td align='left'>byte 8-11</td> <td align='left'>int</td> <td align='left'>pixel width of each character</td> </tr> <tr valign='middle'> <td align='left'>byte 12-15</td> <td align='left'>int</td> <td align='left'>pixel height of each character</td> </tr> <tr valign='middle'> <td align='left'>byte 16-</td> <td align='left'>char</td> <td align='left'> array with character data, one byte per pixel in each character, for a total of (nchars*width*height) bytes. </td> </tr> </tbody> </table> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.imageloadfont.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The font identifier which is always bigger than 5 to avoid conflicts with built-in fonts or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imageloadfont.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imageloadfont()</b> usage 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;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;image&amp;nbsp;instance<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Make&amp;nbsp;the&amp;nbsp;background&amp;nbsp;white<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>49</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>19</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Load&amp;nbsp;the&amp;nbsp;gd&amp;nbsp;font&amp;nbsp;and&amp;nbsp;write&amp;nbsp;'Hello'<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imageloadfont</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./04b.gdf'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</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: #DD0000'>'Hello'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$black</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;to&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imageloadfont.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.imagefontwidth.php' class='function' rel='rdfs-seeAlso'>imagefontwidth()</a> - Get font width</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagefontheight.php' class='function' rel='rdfs-seeAlso'>imagefontheight()</a> - Get font height</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="imageline" value="<div id='function.imageline' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imageline.php'>imageline</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imageline</span> &amp;mdash; <span class='dc-title'>Draw a line</span></p> </div> <a name='function.imageline.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>imageline</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x1</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y1</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> Draws a line between the two given points. </p> </div> <a name='function.imageline.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate for first point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate for first point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate for second point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate for second point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The line color. A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imageline.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.imageline.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Drawing a thick line</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'>imagelinethick</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$x1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$y1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$x2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$y2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$color</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$thick&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;this&amp;nbsp;way&amp;nbsp;it&amp;nbsp;works&amp;nbsp;well&amp;nbsp;only&amp;nbsp;for&amp;nbsp;orthogonal&amp;nbsp;lines<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;imagesetthickness($image,&amp;nbsp;$thick);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;imageline($image,&amp;nbsp;$x1,&amp;nbsp;$y1,&amp;nbsp;$x2,&amp;nbsp;$y2,&amp;nbsp;$color);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$thick&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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>imageline</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$x1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$y1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$x2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$y2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$color</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'>$t&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$thick&amp;nbsp;</span><span style='color: #007700'>/&amp;nbsp;</span><span style='color: #0000BB'>2&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;</span><span style='color: #0000BB'>0.5</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$x1&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>$x2&amp;nbsp;</span><span style='color: #007700'>||&amp;nbsp;</span><span style='color: #0000BB'>$y1&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>$y2</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>min</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$x1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$x2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>$t</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>min</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$y1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$y2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>$t</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>max</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$x1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$x2</span><span style='color: #007700'>)&amp;nbsp;+&amp;nbsp;</span><span style='color: #0000BB'>$t</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>max</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$y1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$y2</span><span style='color: #007700'>)&amp;nbsp;+&amp;nbsp;</span><span style='color: #0000BB'>$t</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>$color</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'>$k&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;(</span><span style='color: #0000BB'>$y2&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;</span><span style='color: #0000BB'>$y1</span><span style='color: #007700'>)&amp;nbsp;/&amp;nbsp;(</span><span style='color: #0000BB'>$x2&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;</span><span style='color: #0000BB'>$x1</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//y&amp;nbsp;=&amp;nbsp;kx&amp;nbsp;+&amp;nbsp;q<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$t&amp;nbsp;</span><span style='color: #007700'>/&amp;nbsp;</span><span style='color: #0000BB'>sqrt</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>pow</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$k</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$points&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$x1&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>+</span><span style='color: #0000BB'>$k</span><span style='color: #007700'>)*</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$y1&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>-</span><span style='color: #0000BB'>$k</span><span style='color: #007700'>)*</span><span style='color: #0000BB'>$a</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'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$x1&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>-</span><span style='color: #0000BB'>$k</span><span style='color: #007700'>)*</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$y1&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>+</span><span style='color: #0000BB'>$k</span><span style='color: #007700'>)*</span><span style='color: #0000BB'>$a</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'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$x2&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>+</span><span style='color: #0000BB'>$k</span><span style='color: #007700'>)*</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$y2&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>-</span><span style='color: #0000BB'>$k</span><span style='color: #007700'>)*</span><span style='color: #0000BB'>$a</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'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$x2&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>-</span><span style='color: #0000BB'>$k</span><span style='color: #007700'>)*</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>round</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$y2&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>+</span><span style='color: #0000BB'>$k</span><span style='color: #007700'>)*</span><span style='color: #0000BB'>$a</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'>imagefilledpolygon</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$points</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$color</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>imagepolygon</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$points</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$color</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imageline.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.imagecreatetruecolor.php' class='function' rel='rdfs-seeAlso'>imagecreatetruecolor()</a> - Create a new true color image</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function' rel='rdfs-seeAlso'>imagecolorallocate()</a> - Allocate a color for 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="imagelayereffect" value="<div id='function.imagelayereffect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagelayereffect.php'>imagelayereffect</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>imagelayereffect</span> &amp;mdash; <span class='dc-title'>Set the alpha blending flag to use the bundled libgd layering effects</span></p> </div> <a name='function.imagelayereffect.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>imagelayereffect</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$effect</tt></span> )</div> <p class='para rdfs-comment'> Set the alpha blending flag to use the bundled libgd layering effects. </p> </div> <a name='function.imagelayereffect.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>effect</tt></i> </span> </dt><dd class='listitem'> <p class='para'> One of the following constants: </p><dl> <dt class='varlistentry'> <br /><span class='term'><b><tt class='constant'>IMG_EFFECT_REPLACE</tt></b></span> </dt><dd class='listitem'> <span class='simpara'> Use pixel replacement (equivalent of passing <b><tt class='constant'>TRUE</tt></b> to <a href='http://www.php.net/manual/en/function.imagealphablending.php' class='function'>imagealphablending()</a>) </span> </dd> <dt class='varlistentry'> <span class='term'><b><tt class='constant'>IMG_EFFECT_ALPHABLEND</tt></b></span> </dt><dd class='listitem'> <span class='simpara'> Use normal pixel blending (equivalent of passing <b><tt class='constant'>FALSE</tt></b> to <a href='http://www.php.net/manual/en/function.imagealphablending.php' class='function'>imagealphablending()</a>) </span> </dd> <dt class='varlistentry'> <span class='term'><b><tt class='constant'>IMG_EFFECT_NORMAL</tt></b></span> </dt><dd class='listitem'> <span class='simpara'> Same as <b><tt class='constant'>IMG_EFFECT_ALPHABLEND</tt></b>. </span> </dd> <dt class='varlistentry'> <span class='term'><b><tt class='constant'>IMG_EFFECT_OVERLAY</tt></b></span> </dt><dd class='listitem'> <span class='simpara'> Overlay has the effect that black background pixels will remain black, white background pixels will remain white, but grey background pixels will take the colour of the foreground pixel. </span> </dd> </dl> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.imagelayereffect.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.imagelayereffect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>imagelayereffect()</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;Setup&amp;nbsp;an&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;a&amp;nbsp;background<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>220</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>220</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>220</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Apply&amp;nbsp;the&amp;nbsp;overlay&amp;nbsp;alpha&amp;nbsp;blending&amp;nbsp;flag<br /></span><span style='color: #0000BB'>imagelayereffect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_EFFECT_OVERLAY</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;two&amp;nbsp;grey&amp;nbsp;ellipses<br /></span><span style='color: #0000BB'>imagefilledellipse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>40</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>40</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>imagefilledellipse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>80</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>imagefilledellipse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>80</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagelayereffect.png' /> </div> </div> </div> </div> <a name='function.imagelayereffect.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 if PHP is compiled with the bundled version of the GD library.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</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="imagejpeg" value="<div id='function.imagejpeg' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagejpeg.php'>imagejpeg</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagejpeg</span> &amp;mdash; <span class='dc-title'>Output image to browser or file</span></p> </div> <a name='function.imagejpeg.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>imagejpeg</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></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'>$quality</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>imagejpeg()</b> creates a <acronym title='Joint Photographic Experts Group'>JPEG</acronym> file from the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagejpeg.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path to save the file to. If not set or <b><tt class='constant'>NULL</tt></b>, the raw image stream will be outputted directly. </p> <p class='para'> To skip this argument in order to provide the <i><tt class='parameter'>quality</tt></i> parameter, use <b><tt class='constant'>NULL</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>quality</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>quality</tt></i> is optional, and ranges from 0 (worst quality, smaller file) to 100 (best quality, biggest file). The default is the default IJG quality value (about 75). </p> </dd> </dl> <p> </p> </div> <a name='function.imagejpeg.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.imagejpeg.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Outputting a JPEG image</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;content&amp;nbsp;type&amp;nbsp;header&amp;nbsp;-&amp;nbsp;in&amp;nbsp;this&amp;nbsp;case&amp;nbsp;image/jpeg<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagejpeg.jpg' /> </div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 Saving a JPEG image</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image&amp;nbsp;as&amp;nbsp;'simpletext.jpg'<br /></span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'simpletext.jpg'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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 #3 Outputting the image at 75% quality</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;content&amp;nbsp;type&amp;nbsp;header&amp;nbsp;-&amp;nbsp;in&amp;nbsp;this&amp;nbsp;case&amp;nbsp;image/jpeg<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Skip&amp;nbsp;the&amp;nbsp;filename&amp;nbsp;parameter&amp;nbsp;using&amp;nbsp;NULL,&amp;nbsp;then&amp;nbsp;set&amp;nbsp;the&amp;nbsp;quality&amp;nbsp;to&amp;nbsp;75%<br /></span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagejpeg.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>JPEG support is only available if PHP was compiled against GD-1.8 or later.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: If you want to output Progressive JPEGs, you need to set interlacing on with <a href='http://www.php.net/manual/en/function.imageinterlace.php' class='function'>imageinterlace()</a>. <br /> </p></blockquote> </div> <a name='function.imagejpeg.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.imagepng.php' class='function' rel='rdfs-seeAlso'>imagepng()</a> - Output a PNG image to either the browser or a file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagegif.php' class='function' rel='rdfs-seeAlso'>imagegif()</a> - Output image to browser or file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagewbmp.php' class='function' rel='rdfs-seeAlso'>imagewbmp()</a> - Output image to browser or file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imageinterlace.php' class='function' rel='rdfs-seeAlso'>imageinterlace()</a> - Enable or disable interlace</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagetypes.php' class='function' rel='rdfs-seeAlso'>imagetypes()</a> - Return the image types supported by this PHP build</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="imageistruecolor" value="<div id='function.imageistruecolor' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imageistruecolor.php'>imageistruecolor</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.2, PHP 5)</p><p class='refpurpose'><span class='refname'>imageistruecolor</span> &amp;mdash; <span class='dc-title'>Finds whether an image is a truecolor image</span></p> </div> <a name='function.imageistruecolor.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>imageistruecolor</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> )</div> <p class='para rdfs-comment'> <b>imageistruecolor()</b> finds whether the image <i><tt class='parameter'>image</tt></i> is a truecolor image. </p> </div> <a name='function.imageistruecolor.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imageistruecolor.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 <i><tt class='parameter'>image</tt></i> is truecolor, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.imageistruecolor.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Simple detection of true color image instances using <b>imageistruecolor()</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;$im&amp;nbsp;is&amp;nbsp;an&amp;nbsp;image&amp;nbsp;instance<br /><br />//&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;image&amp;nbsp;is&amp;nbsp;a&amp;nbsp;true&amp;nbsp;color&amp;nbsp;image&amp;nbsp;or&amp;nbsp;not<br /></span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>imageistruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;true&amp;nbsp;color&amp;nbsp;image&amp;nbsp;instance<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$tc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagecopy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$im</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'>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'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$tc</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$tc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Continue&amp;nbsp;working&amp;nbsp;with&amp;nbsp;image&amp;nbsp;instance<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.imageistruecolor.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> </div> <a name='function.imageistruecolor.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.imagecreatetruecolor.php' class='function' rel='rdfs-seeAlso'>imagecreatetruecolor()</a> - Create a new true color 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="imageinterlace" value="<div id='function.imageinterlace' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imageinterlace.php'>imageinterlace</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imageinterlace</span> &amp;mdash; <span class='dc-title'>Enable or disable interlace</span></p> </div> <a name='function.imageinterlace.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>imageinterlace</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$interlace</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>imageinterlace()</b> turns the interlace bit on or off. </p> <p class='para'> If the interlace bit is set and the image is used as a <acronym title='Joint Photographic Experts Group'>JPEG</acronym> image, the image is created as a progressive <acronym title='Joint Photographic Experts Group'>JPEG</acronym>. </p> </div> <a name='function.imageinterlace.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>interlace</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If non-zero, the image will be interlaced, else the interlace bit is turned off. </p> </dd> </dl> <p> </p> </div> <a name='function.imageinterlace.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns 1 if the interlace bit is set for the image, 0 otherwise. </p> </div> <a name='function.imageinterlace.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Turn on interlacing using <b>imageinterlace()</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;Create&amp;nbsp;an&amp;nbsp;image&amp;nbsp;instance<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrom</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Enable&amp;nbsp;interlancing<br /></span><span style='color: #0000BB'>imageinterlace</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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;Save&amp;nbsp;the&amp;nbsp;interfaced&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagegif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./php_interlaced.gif'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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="imagegrabwindow" value="<div id='function.imagegrabwindow' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagegrabwindow.php'>imagegrabwindow</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.2)</p><p class='refpurpose'><span class='refname'>imagegrabwindow</span> &amp;mdash; <span class='dc-title'>Captures a window</span></p> </div> <a name='function.imagegrabwindow.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>imagegrabwindow</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$window</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$client_area</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Grabs a window or its client area using a windows handle (HWND property in COM instance) </p> </div> <a name='function.imagegrabwindow.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'>window</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The HWND window ID. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>client_area</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Include the client area of the application window. </p> </dd> </dl> <p> </p> </div> <a name='function.imagegrabwindow.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imagegrabwindow.errors'></a><div class='refsect1 errors'> <h3 class='title'>Errors/Exceptions</h3> <p class='para'> E_NOTICE is issued if <i><tt class='parameter'>window_handle</tt></i> is invalid window handle. E_WARNING is issued if the Windows API is too old. </p> </div> <a name='function.imagegrabwindow.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagegrabwindow()</b> example</b></p> <div class='example-contents para'><p> Capture a window (IE for example) </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$browser&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>COM</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'InternetExplorer.Application'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$browser</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>HWND</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$browser</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Visible&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagegrabwindow</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$browser</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Quit</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'iesnap.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p> Capture a window (IE for example) but with its content </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$browser&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>COM</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'InternetExplorer.Application'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$browser</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>HWND</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$browser</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Visible&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$browser</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Navigate</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'http://www.libgd.org'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Still&amp;nbsp;working?&amp;nbsp;*/<br /></span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$browser</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Busy</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>com_message_pump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>4000</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagegrabwindow</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$browser</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>Quit</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'iesnap.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagegrabwindow.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function is only available on Windows. <br /> </p></blockquote> </div> <a name='function.imagegrabwindow.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.imagegrabscreen.php' class='function' rel='rdfs-seeAlso'>imagegrabscreen()</a> - Captures the whole screen</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="imagegrabscreen" value="<div id='function.imagegrabscreen' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagegrabscreen.php'>imagegrabscreen</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.2)</p><p class='refpurpose'><span class='refname'>imagegrabscreen</span> &amp;mdash; <span class='dc-title'>Captures the whole screen</span></p> </div> <a name='function.imagegrabscreen.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>imagegrabscreen</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Grabs a screenshot of the whole screen. </p> </div> <a name='function.imagegrabscreen.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.imagegrabscreen.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagegrabscreen()</b> example</b></p> <div class='example-contents para'><p> This example demonstrates how to take a screenshot of the current screen and save it as a png image. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagegrabscreen</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'myscreenshot.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagegrabscreen.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function is only available on Windows. <br /> </p></blockquote> </div> <a name='function.imagegrabscreen.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.imagegrabwindow.php' class='function' rel='rdfs-seeAlso'>imagegrabwindow()</a> - Captures a window</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="imagegif" value="<div id='function.imagegif' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagegif.php'>imagegif</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagegif</span> &amp;mdash; <span class='dc-title'>Output image to browser or file</span></p> </div> <a name='function.imagegif.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>imagegif</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> ] )</div> <p class='para rdfs-comment'> <b>imagegif()</b> creates the <acronym title='Graphic Interchange Format'>GIF</acronym> file in filename from the image <i><tt class='parameter'>image</tt></i> . The <i><tt class='parameter'>image</tt></i> argument is the return from the <a href='http://www.php.net/manual/en/function.imagecreate.php' class='function'>imagecreate()</a> or <i>imagecreatefrom*</i> function. </p> <p class='para'> The image format will be <acronym>GIF87a</acronym> unless the image has been made transparent with <a href='http://www.php.net/manual/en/function.imagecolortransparent.php' class='function'>imagecolortransparent()</a>, in which case the image format will be <acronym>GIF89a</acronym>. </p> </div> <a name='function.imagegif.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path to save the file to. If not set or <b><tt class='constant'>NULL</tt></b>, the raw image stream will be outputted directly. </p> </dd> </dl> <p> </p> </div> <a name='function.imagegif.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.imagegif.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Outputting an image using <b>imagegif()</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;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;image&amp;nbsp;instance<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Make&amp;nbsp;the&amp;nbsp;background&amp;nbsp;white<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>99</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>99</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFFFFFF</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;a&amp;nbsp;text&amp;nbsp;string&amp;nbsp;on&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>40</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'GD&amp;nbsp;Library'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFFBA00</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;the&amp;nbsp;image&amp;nbsp;to&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagegif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Converting a PNG image to GIF using <b>imagegif()</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;Load&amp;nbsp;the&amp;nbsp;PNG<br /></span><span style='color: #0000BB'>$png&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./php.png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image&amp;nbsp;as&amp;nbsp;a&amp;nbsp;GIF<br /></span><span style='color: #0000BB'>imagegif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$png</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./php.gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$png</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;We're&amp;nbsp;done<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'Converted&amp;nbsp;PNG&amp;nbsp;image&amp;nbsp;to&amp;nbsp;GIF&amp;nbsp;with&amp;nbsp;success!'</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.imagegif.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Since all <acronym title='Graphic Interchange Format'>GIF</acronym> support was removed from the <acronym title='Graphics Draw'>GD</acronym> library in version 1.6, this function is not available if you are using that version of the GD library. Support is expected to return in a version subsequent to the rerelease of <acronym title='Graphic Interchange Format'>GIF</acronym> support in the GD library in mid 2004. For more information, see the <a href='http://www.libgd.org/' class='link external'>&amp;raquo; GD Project</a> site. <br /> The following code snippet allows you to write more portable PHP applications by auto-detecting the type of GD support which is available. Replace the sequence <i>header (&amp;quot;Content-type: image/gif&amp;quot;); imagegif ($im);</i> by the more flexible sequence: </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 /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;image&amp;nbsp;instance<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;some&amp;nbsp;image&amp;nbsp;operations&amp;nbsp;here<br /><br />//&amp;nbsp;Handle&amp;nbsp;output<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>function_exists</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'imagegif'</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;For&amp;nbsp;GIF<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;image/gif'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagegif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br />}<br />elseif(</span><span style='color: #0000BB'>function_exists</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'imagejpeg'</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;For&amp;nbsp;JPEG<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;image/jpeg'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br />}<br />elseif(</span><span style='color: #0000BB'>function_exists</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'imagepng'</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;For&amp;nbsp;PNG<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;image/png'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br />}<br />elseif(</span><span style='color: #0000BB'>function_exists</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'imagewbmp'</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;For&amp;nbsp;WBMP<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;image/vnd.wap.wbmp'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagewbmp</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'No&amp;nbsp;image&amp;nbsp;support&amp;nbsp;in&amp;nbsp;this&amp;nbsp;PHP&amp;nbsp;server'</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;If&amp;nbsp;image&amp;nbsp;support&amp;nbsp;was&amp;nbsp;found&amp;nbsp;for&amp;nbsp;one&amp;nbsp;of&amp;nbsp;these<br />//&amp;nbsp;formats,&amp;nbsp;then&amp;nbsp;free&amp;nbsp;it&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: As of PHP 4.0.2 you can use the function <a href='http://www.php.net/manual/en/function.imagetypes.php' class='function'>imagetypes()</a> in place of <a href='http://www.php.net/manual/en/function.function-exists.php' class='function'>function_exists()</a> for checking the presence of the various supported image formats: </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 /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>imagetypes</span><span style='color: #007700'>()&amp;nbsp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>IMG_GIF</span><span style='color: #007700'>)<br />{<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;image/gif'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagegif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br />}<br />elseif(</span><span style='color: #0000BB'>imagetypes</span><span style='color: #007700'>()&amp;nbsp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>IMG_JPG</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;...&amp;nbsp;etc.&amp;nbsp;*/<br /></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.imagegif.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.imagepng.php' class='function' rel='rdfs-seeAlso'>imagepng()</a> - Output a PNG image to either the browser or a file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagewbmp.php' class='function' rel='rdfs-seeAlso'>imagewbmp()</a> - Output image to browser or file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagejpeg.php' class='function' rel='rdfs-seeAlso'>imagejpeg()</a> - Output image to browser or file</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagetypes.php' class='function' rel='rdfs-seeAlso'>imagetypes()</a> - Return the image types supported by this PHP build</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="imagegd2" value="<div id='function.imagegd2' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagegd2.php'>imagegd2</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5)</p><p class='refpurpose'><span class='refname'>imagegd2</span> &amp;mdash; <span class='dc-title'>Output GD2 image to browser or file</span></p> </div> <a name='function.imagegd2.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>imagegd2</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></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'>$chunk_size</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$type</tt></span> ]]] )</div> <p class='para rdfs-comment'> Outputs a GD2 image to the given <i><tt class='parameter'>filename</tt></i> . </p> </div> <a name='function.imagegd2.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path to save the file to. If not set or <b><tt class='constant'>NULL</tt></b>, the raw image stream will be outputted directly. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>chunk_size</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Chunk size. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Either <b><tt class='constant'>IMG_GD2_RAW</tt></b> or <b><tt class='constant'>IMG_GD2_COMPRESSED</tt></b>. Default is <b><tt class='constant'>IMG_GD2_RAW</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagegd2.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.imagegd2.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Outputting a GD2 image</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagegd2</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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 Saving a GD2 image</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;gd2&amp;nbsp;image<br />//&amp;nbsp;The&amp;nbsp;file&amp;nbsp;format&amp;nbsp;for&amp;nbsp;GD2&amp;nbsp;images&amp;nbsp;is&amp;nbsp;.gd2,&amp;nbsp;see&amp;nbsp;http://www.libgd.org/GdFileFormats<br /></span><span style='color: #0000BB'>imagegd2</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'simple.gd'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagegd2.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: The GD2 format is commonly used to allow fast loading of parts of images. Note that the GD2 format is only usable in GD2-compatible applications. <br /> </p></blockquote> </div> <a name='function.imagegd2.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'> <i><tt class='parameter'>chunk_size</tt></i> and <i><tt class='parameter'>type</tt></i> were added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imagegd2.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.imagegd.php' class='function' rel='rdfs-seeAlso'>imagegd()</a> - Output GD image to browser or file</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="imagegd" value="<div id='function.imagegd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagegd.php'>imagegd</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5)</p><p class='refpurpose'><span class='refname'>imagegd</span> &amp;mdash; <span class='dc-title'>Output GD image to browser or file</span></p> </div> <a name='function.imagegd.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>imagegd</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> ] )</div> <p class='para rdfs-comment'> Outputs a GD image to the given <i><tt class='parameter'>filename</tt></i> . </p> </div> <a name='function.imagegd.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path to save the file to. If not set or <b><tt class='constant'>NULL</tt></b>, the raw image stream will be outputted directly. </p> </dd> </dl> <p> </p> </div> <a name='function.imagegd.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.imagegd.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Outputting a GD image</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagegd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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 Saving a GD image</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;blank&amp;nbsp;image&amp;nbsp;and&amp;nbsp;add&amp;nbsp;some&amp;nbsp;text<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;gd&amp;nbsp;image<br />//&amp;nbsp;The&amp;nbsp;file&amp;nbsp;format&amp;nbsp;for&amp;nbsp;GD&amp;nbsp;images&amp;nbsp;is&amp;nbsp;.gd,&amp;nbsp;see&amp;nbsp;http://www.libgd.org/GdFileFormats<br /></span><span style='color: #0000BB'>imagegd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'simple.gd'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;up&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagegd.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: The GD format is commonly used to allow fast loading of parts of images. Note that the GD format is only usable in GD-compatible applications. <br /> </p></blockquote> </div> <a name='function.imagegd.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.imagegd2.php' class='function' rel='rdfs-seeAlso'>imagegd2()</a> - Output GD2 image to browser or file</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="imagegammacorrect" value="<div id='function.imagegammacorrect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagegammacorrect.php'>imagegammacorrect</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagegammacorrect</span> &amp;mdash; <span class='dc-title'>Apply a gamma correction to a GD image</span></p> </div> <a name='function.imagegammacorrect.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>imagegammacorrect</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$inputgamma</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$outputgamma</tt></span> )</div> <p class='para rdfs-comment'> Applies gamma correction to the given gd <i><tt class='parameter'>image</tt></i> given an input and an output gamma. </p> </div> <a name='function.imagegammacorrect.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>inputgamma</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The input gamma. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>outputgamma</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The output gamma. </p> </dd> </dl> <p> </p> </div> <a name='function.imagegammacorrect.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.imagegammacorrect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagegammacorrect()</b> usage</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;image&amp;nbsp;instance<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Correct&amp;nbsp;gamma,&amp;nbsp;out&amp;nbsp;=&amp;nbsp;1.537<br /></span><span style='color: #0000BB'>imagegammacorrect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1.0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1.537</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;and&amp;nbsp;free&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagegif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./php_gamma_corrected.gif'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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="imagefttext" value="<div id='function.imagefttext' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagefttext.php'>imagefttext</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5)</p><p class='refpurpose'><span class='refname'>imagefttext</span> &amp;mdash; <span class='dc-title'>Write text to the image using fonts using FreeType 2</span></p> </div> <a name='function.imagefttext.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>imagefttext</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$size</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$angle</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$fontfile</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$extrainfo</tt></span> ] )</div> </div> <a name='function.imagefttext.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>size</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The font size to use in points. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>angle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The angle in degrees, with 0 degrees being left-to-right reading text. Higher values represent a counter-clockwise rotation. For example, a value of 90 would result in bottom-to-top reading text. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The coordinates given by <i><tt class='parameter'>x</tt></i> and <i><tt class='parameter'>y</tt></i> will define the basepoint of the first character (roughly the lower-left corner of the character). This is different from the <a href='http://www.php.net/manual/en/function.imagestring.php' class='function'>imagestring()</a>, where <i><tt class='parameter'>x</tt></i> and <i><tt class='parameter'>y</tt></i> define the upper-left corner of the first character. For example, &amp;quot;top left&amp;quot; is 0, 0. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The y-ordinate. This sets the position of the fonts baseline, not the very bottom of the character. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The index of the desired color for the text, see <a href='http://www.php.net/manual/en/function.imagecolorexact.php' class='function'>imagecolorexact()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fontfile</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The path to the TrueType font you wish to use. </p> <p class='para'> Depending on which version of the GD library PHP is using, <em class='emphasis'>when <i><tt class='parameter'>fontfile</tt></i> does not begin with a leading <i>/</i> then <i>.ttf</i> will be appended</em> to the filename and the library will attempt to search for that filename along a library-defined font path. </p> <p class='para'> When using versions of the GD library lower than 2.0.18, a <i>space</i> character, rather than a semicolon, was used as the &amp;#039;path separator&amp;#039; for different font files. Unintentional use of this feature will result in the warning message: <i>Warning: Could not find/open font</i>. For these affected versions, the only solution is moving the font to a path which does not contain spaces. </p> <p class='para'> In many cases where a font resides in the same directory as the script using it the following trick will alleviate any include problems. </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;enviroment&amp;nbsp;variable&amp;nbsp;for&amp;nbsp;GD<br /></span><span style='color: #0000BB'>putenv</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'GDFONTPATH='&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>realpath</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'.'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Name&amp;nbsp;the&amp;nbsp;font&amp;nbsp;to&amp;nbsp;be&amp;nbsp;used&amp;nbsp;(note&amp;nbsp;the&amp;nbsp;lack&amp;nbsp;of&amp;nbsp;the&amp;nbsp;.ttf&amp;nbsp;extension)<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SomeFont'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Text to be inserted into image. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>extrainfo</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p><table class='doctable table'> <caption><b>Possible array indexes for <i><tt class='parameter'>extrainfo</tt></i> </b></caption> <thead valign='middle'> <tr valign='middle'> <th>Key</th> <th>Type</th> <th>Meaning</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><i>linespacing</i></td> <td align='left'><a href='http://www.php.net/manual/en/language.types.float.php' class='type float'>float</a></td> <td align='left'>Defines drawing linespacing</td> </tr> </tbody> </table> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.imagefttext.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> This function returns an array defining the four points of the box, starting in the lower left and moving counter-clockwise: </p><table class='doctable informaltable'> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0</td> <td align='left'>lower left x-coordinate</td> </tr> <tr valign='middle'> <td align='left'>1</td> <td align='left'>lower left y-coordinate</td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'>lower right x-coordinate</td> </tr> <tr valign='middle'> <td align='left'>3</td> <td align='left'>lower right y-coordinate</td> </tr> <tr valign='middle'> <td align='left'>4</td> <td align='left'>upper right x-coordinate</td> </tr> <tr valign='middle'> <td align='left'>5</td> <td align='left'>upper right y-coordinate</td> </tr> <tr valign='middle'> <td align='left'>6</td> <td align='left'>upper left x-coordinate</td> </tr> <tr valign='middle'> <td align='left'>7</td> <td align='left'>upper left y-coordinate</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imagefttext.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagefttext()</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;Create&amp;nbsp;a&amp;nbsp;300x100&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>300</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$red&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Make&amp;nbsp;the&amp;nbsp;background&amp;nbsp;red<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>299</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>99</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Path&amp;nbsp;to&amp;nbsp;our&amp;nbsp;ttf&amp;nbsp;font&amp;nbsp;file<br /></span><span style='color: #0000BB'>$font_file&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'./arial.ttf'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;the&amp;nbsp;text&amp;nbsp;'PHP&amp;nbsp;Manual'&amp;nbsp;using&amp;nbsp;font&amp;nbsp;size&amp;nbsp;13<br /></span><span style='color: #0000BB'>imagefttext</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>13</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'>105</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>55</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$black</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font_file</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'PHP&amp;nbsp;Manual'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;image&amp;nbsp;to&amp;nbsp;the&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagefttext.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function is only available if PHP is compiled with freetype support (<span class='option'>--with-freetype-dir=DIR</span>) </span></p></blockquote> </div> <a name='function.imagefttext.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.5</td> <td align='left'> <i><tt class='parameter'>extrainfo</tt></i> was made optional. </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="imageftbbox" value="<div id='function.imageftbbox' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imageftbbox.php'>imageftbbox</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5)</p><p class='refpurpose'><span class='refname'>imageftbbox</span> &amp;mdash; <span class='dc-title'>Give the bounding box of a text using fonts via freetype2</span></p> </div> <a name='function.imageftbbox.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>imageftbbox</b></span> ( <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$size</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$angle</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$fontfile</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$text</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$extrainfo</tt></span> ] )</div> <p class='para rdfs-comment'> This function calculates and returns the bounding box in pixels for a FreeType text. </p> </div> <a name='function.imageftbbox.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'>size</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The font size. Depending on your version of GD, this should be specified as the pixel size (GD1) or point size (GD2). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>angle</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Angle in degrees in which <i><tt class='parameter'>text</tt></i> will be measured. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fontfile</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the TrueType font file (can be a URL). Depending on which version of the GD library that PHP is using, it may attempt to search for files that do not begin with a leading &amp;#039;/&amp;#039; by appending &amp;#039;.ttf&amp;#039; to the filename and searching along a library-defined font path. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to be measured. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>extrainfo</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p><table class='doctable table'> <caption><b>Possible array indexes for <i><tt class='parameter'>extrainfo</tt></i> </b></caption> <thead valign='middle'> <tr valign='middle'> <th>Key</th> <th>Type</th> <th>Meaning</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><i>linespacing</i></td> <td align='left'><a href='http://www.php.net/manual/en/language.types.float.php' class='type float'>float</a></td> <td align='left'>Defines drawing linespacing</td> </tr> </tbody> </table> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.imageftbbox.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>imageftbbox()</b> returns an array with 8 elements representing four points making the bounding box of the text: </p><table class='doctable informaltable'> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0</td> <td align='left'>lower left corner, X position</td> </tr> <tr valign='middle'> <td align='left'>1</td> <td align='left'>lower left corner, Y position</td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'>lower right corner, X position</td> </tr> <tr valign='middle'> <td align='left'>3</td> <td align='left'>lower right corner, Y position</td> </tr> <tr valign='middle'> <td align='left'>4</td> <td align='left'>upper right corner, X position</td> </tr> <tr valign='middle'> <td align='left'>5</td> <td align='left'>upper right corner, Y position</td> </tr> <tr valign='middle'> <td align='left'>6</td> <td align='left'>upper left corner, X position</td> </tr> <tr valign='middle'> <td align='left'>7</td> <td align='left'>upper left corner, Y position</td> </tr> </tbody> </table> <p> </p> <p class='para'> The points are relative to the <em class='emphasis'>text</em> regardless of the <i><tt class='parameter'>angle</tt></i> , so &amp;quot;upper left&amp;quot; means in the top left-hand corner seeing the text horizontally. </p> </div> <a name='function.imageftbbox.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imageftbbox()</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;Create&amp;nbsp;a&amp;nbsp;300x150&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>300</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>150</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;background&amp;nbsp;to&amp;nbsp;be&amp;nbsp;white<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>299</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>299</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Path&amp;nbsp;to&amp;nbsp;our&amp;nbsp;font&amp;nbsp;file<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'./arial.ttf'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;First&amp;nbsp;we&amp;nbsp;create&amp;nbsp;our&amp;nbsp;bounding&amp;nbsp;box<br /></span><span style='color: #0000BB'>$bbox&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imageftbbox</span><span style='color: #007700'>(</span><span style='color: #0000BB'>10</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'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;PHP&amp;nbsp;Documentation&amp;nbsp;Group'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;is&amp;nbsp;our&amp;nbsp;cordinates&amp;nbsp;for&amp;nbsp;X&amp;nbsp;and&amp;nbsp;Y<br /></span><span style='color: #0000BB'>$x&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$bbox</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;+&amp;nbsp;(</span><span style='color: #0000BB'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;(</span><span style='color: #0000BB'>$bbox</span><span style='color: #007700'>[</span><span style='color: #0000BB'>4</span><span style='color: #007700'>]&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$y&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$bbox</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'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;(</span><span style='color: #0000BB'>$bbox</span><span style='color: #007700'>[</span><span style='color: #0000BB'>5</span><span style='color: #007700'>]&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>imagefttext</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</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'>$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'>$black</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$font</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;PHP&amp;nbsp;Documentation&amp;nbsp;Group'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;to&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imageftbbox.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function is only available if PHP is compiled with freetype support (<span class='option'>--with-freetype-dir=DIR</span>) </span></p></blockquote> </div> <a name='function.imageftbbox.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.5</td> <td align='left'> <i><tt class='parameter'>extrainfo</tt></i> was made optional. </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="imagefontwidth" value="<div id='function.imagefontwidth' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagefontwidth.php'>imagefontwidth</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagefontwidth</span> &amp;mdash; <span class='dc-title'>Get font width</span></p> </div> <a name='function.imagefontwidth.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>imagefontwidth</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$font</tt></span> )</div> <p class='para rdfs-comment'> Returns the pixel width of a character in font. </p> </div> <a name='function.imagefontwidth.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'> font</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Can be 1, 2, 3, 4, 5 for built-in fonts in latin2 encoding (where higher numbers corresponding to larger fonts) or any of your own font identifiers registered with <a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function'>imageloadfont()</a>. </p></dd> </dl> <p> </p> </div> <a name='function.imagefontwidth.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the width of the pixel </p> </div> <a name='function.imagefontwidth.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>imagefontwidth()</b> on built-in fonts</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'>'Font&amp;nbsp;width:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imagefontwidth</span><span style='color: #007700'>(</span><span style='color: #0000BB'>4</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> Font width: 8 </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Using <b>imagefontwidth()</b> together with <a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function'>imageloadfont()</a></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;Load&amp;nbsp;a&amp;nbsp;.gdf&amp;nbsp;font<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imageloadfont</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'anonymous.gdf'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Font&amp;nbsp;width:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imagefontwidth</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$font</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> Font width: 23 </pre></div> </div> </div><p> </p> </div> <a name='function.imagefontwidth.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.imagefontheight.php' class='function' rel='rdfs-seeAlso'>imagefontheight()</a> - Get font height</li> <li class='member'><a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function' rel='rdfs-seeAlso'>imageloadfont()</a> - Load a new font</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="imagefontheight" value="<div id='function.imagefontheight' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagefontheight.php'>imagefontheight</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagefontheight</span> &amp;mdash; <span class='dc-title'>Get font height</span></p> </div> <a name='function.imagefontheight.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>imagefontheight</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$font</tt></span> )</div> <p class='para rdfs-comment'> Returns the pixel height of a character in the specified font. </p> </div> <a name='function.imagefontheight.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'> font</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Can be 1, 2, 3, 4, 5 for built-in fonts in latin2 encoding (where higher numbers corresponding to larger fonts) or any of your own font identifiers registered with <a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function'>imageloadfont()</a>. </p></dd> </dl> <p> </p> </div> <a name='function.imagefontheight.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the height of the pixel. </p> </div> <a name='function.imagefontheight.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>imagefontheight()</b> on built-in fonts</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'>'Font&amp;nbsp;height:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imagefontheight</span><span style='color: #007700'>(</span><span style='color: #0000BB'>4</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> Font height: 16 </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Using <b>imagefontheight()</b> together with <a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function'>imageloadfont()</a></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;Load&amp;nbsp;a&amp;nbsp;.gdf&amp;nbsp;font<br /></span><span style='color: #0000BB'>$font&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imageloadfont</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'anonymous.gdf'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Font&amp;nbsp;height:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imagefontheight</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$font</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> Font height: 43 </pre></div> </div> </div><p> </p> </div> <a name='function.imagefontheight.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.imagefontwidth.php' class='function' rel='rdfs-seeAlso'>imagefontwidth()</a> - Get font width</li> <li class='member'><a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function' rel='rdfs-seeAlso'>imageloadfont()</a> - Load a new font</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="imagefilter" value="<div id='function.imagefilter' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagefilter.php'>imagefilter</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>imagefilter</span> &amp;mdash; <span class='dc-title'>Applies a filter to an image</span></p> </div> <a name='function.imagefilter.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>imagefilter</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$filtertype</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$arg1</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$arg2</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$arg3</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$arg4</tt></span> ]]]] )</div> <p class='para rdfs-comment'> <b>imagefilter()</b> applies the given filter <i><tt class='parameter'>filtertype</tt></i> on the <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagefilter.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filtertype</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>filtertype</tt></i> can be one of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_NEGATE</tt></b>: Reverses all colors of the image. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_GRAYSCALE</tt></b>: Converts the image into grayscale. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_BRIGHTNESS</tt></b>: Changes the brightness of the image. Use <i><tt class='parameter'>arg1</tt></i> to set the level of brightness. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_CONTRAST</tt></b>: Changes the contrast of the image. Use <i><tt class='parameter'>arg1</tt></i> to set the level of contrast. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_COLORIZE</tt></b>: Like <b><tt class='constant'>IMG_FILTER_GRAYSCALE</tt></b>, except you can specify the color. Use <i><tt class='parameter'>arg1</tt></i> , <i><tt class='parameter'>arg2</tt></i> and <i><tt class='parameter'>arg3</tt></i> in the form of <i><tt class='parameter'>red</tt></i> , <i><tt class='parameter'>blue</tt></i> , <i><tt class='parameter'>green</tt></i> and <i><tt class='parameter'>arg4</tt></i> for the <i><tt class='parameter'>alpha</tt></i> channel. The range for each color is 0 to 255. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_EDGEDETECT</tt></b>: Uses edge detection to highlight the edges in the image. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_EMBOSS</tt></b>: Embosses the image. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_GAUSSIAN_BLUR</tt></b>: Blurs the image using the Gaussian method. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_SELECTIVE_BLUR</tt></b>: Blurs the image. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_MEAN_REMOVAL</tt></b>: Uses mean removal to achieve a &amp;quot;sketchy&amp;quot; effect. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_SMOOTH</tt></b>: Makes the image smoother. Use <i><tt class='parameter'>arg1</tt></i> to set the level of smoothness. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_PIXELATE</tt></b>: Applies pixelation effect to the image, use <i><tt class='parameter'>arg1</tt></i> to set the block size and <i><tt class='parameter'>arg2</tt></i> to set the pixelation effect mode. </span> </li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>arg1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_BRIGHTNESS</tt></b>: Brightness level. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_CONTRAST</tt></b>: Contrast level. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_COLORIZE</tt></b>: Value of red component. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_SMOOTH</tt></b>: Smoothness level. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_PIXELATE</tt></b>: Block size in pixels. </span> </li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>arg2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_COLORIZE</tt></b>: Value of green component. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_PIXELATE</tt></b>: Whether to use advanced pixelation effect or not (defaults to <b><tt class='constant'>FALSE</tt></b>). </span> </li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>arg3</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_COLORIZE</tt></b>: Value of blue component. </span> </li> </ul><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>arg4</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>IMG_FILTER_COLORIZE</tt></b>: Alpha channel, A value between 0 and 127. 0 indicates completely opaque while 127 indicates completely transparent. </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.imagefilter.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.imagefilter.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.3.0</td> <td align='left'> Pixelation support (<b><tt class='constant'>IMG_FILTER_PIXELATE</tt></b>) was added. </td> </tr> <tr valign='middle'> <td align='left'>5.2.5</td> <td align='left'> Alpha support for <b><tt class='constant'>IMG_FILTER_COLORIZE</tt></b> was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imagefilter.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagefilter()</b> grayscale example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dave.png'</span><span style='color: #007700'>);<br /><br />if(</span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>&amp;amp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilter</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_FILTER_GRAYSCALE</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Image&amp;nbsp;converted&amp;nbsp;to&amp;nbsp;grayscale.'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'dave.png'</span><span style='color: #007700'>);<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Conversion&amp;nbsp;to&amp;nbsp;grayscale&amp;nbsp;failed.'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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>imagefilter()</b> brightness example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'sean.png'</span><span style='color: #007700'>);<br /><br />if(</span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>&amp;amp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilter</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_FILTER_BRIGHTNESS</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Image&amp;nbsp;brightness&amp;nbsp;changed.'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sean.png'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Image&amp;nbsp;brightness&amp;nbsp;change&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> <p class='para'> </p><div class='example'> <p><b>Example #3 <b>imagefilter()</b> colorize example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'philip.png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;R,&amp;nbsp;G,&amp;nbsp;B,&amp;nbsp;so&amp;nbsp;0,&amp;nbsp;255,&amp;nbsp;0&amp;nbsp;is&amp;nbsp;green&amp;nbsp;*/<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>&amp;amp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilter</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_FILTER_COLORIZE</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'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Image&amp;nbsp;successfully&amp;nbsp;shaded&amp;nbsp;green.'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'philip.png'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Green&amp;nbsp;shading&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> <p class='para'> </p><div class='example'> <p><b>Example #4 <b>imagefilter()</b> negate 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;Define&amp;nbsp;our&amp;nbsp;negate&amp;nbsp;function&amp;nbsp;so&amp;nbsp;its&amp;nbsp;portable&amp;nbsp;for&amp;nbsp;<br />//&amp;nbsp;php&amp;nbsp;versions&amp;nbsp;without&amp;nbsp;imagefilter()<br /></span><span style='color: #007700'>function&amp;nbsp;</span><span style='color: #0000BB'>negate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if(</span><span style='color: #0000BB'>function_exists</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'imagefilter'</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>imagefilter</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_FILTER_NEGATE</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;for(</span><span style='color: #0000BB'>$x&amp;nbsp;</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'>$x&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);&amp;nbsp;++</span><span style='color: #0000BB'>$x</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;for(</span><span style='color: #0000BB'>$y&amp;nbsp;</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'>$y&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);&amp;nbsp;++</span><span style='color: #0000BB'>$y</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$index&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorat</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$x</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$y</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'>$rgb&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorsforindex</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$index</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'>$color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'red'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>255&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'green'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>255&amp;nbsp;</span><span style='color: #007700'>-&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'blue'</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'>imagesetpixel</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</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'>$color</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 />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return(</span><span style='color: #0000BB'>true</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromjpeg</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'kalle.jpg'</span><span style='color: #007700'>);<br /><br />if(</span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>&amp;amp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>negate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Image&amp;nbsp;successfully&amp;nbsp;converted&amp;nbsp;to&amp;nbsp;negative&amp;nbsp;colors.'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'kalle.jpg'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Converting&amp;nbsp;to&amp;nbsp;negative&amp;nbsp;colors&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> <p class='para'> </p><div class='example'> <p><b>Example #5 <b>imagefilter()</b> pixelate 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;Load&amp;nbsp;the&amp;nbsp;PHP&amp;nbsp;logo,&amp;nbsp;we&amp;nbsp;need&amp;nbsp;to&amp;nbsp;create&amp;nbsp;two&amp;nbsp;instances&amp;nbsp;<br />//&amp;nbsp;to&amp;nbsp;show&amp;nbsp;the&amp;nbsp;differences<br /></span><span style='color: #0000BB'>$logo1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./php.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$logo2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./php.png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;image&amp;nbsp;instance&amp;nbsp;we&amp;nbsp;want&amp;nbsp;to&amp;nbsp;show&amp;nbsp;the&amp;nbsp;<br />//&amp;nbsp;differences&amp;nbsp;on<br /></span><span style='color: #0000BB'>$output&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo1</span><span style='color: #007700'>)&amp;nbsp;*&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo1</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Apply&amp;nbsp;pixelation&amp;nbsp;to&amp;nbsp;each&amp;nbsp;instance,&amp;nbsp;with&amp;nbsp;a&amp;nbsp;block&amp;nbsp;<br />//&amp;nbsp;size&amp;nbsp;of&amp;nbsp;3<br /></span><span style='color: #0000BB'>imagefilter</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_FILTER_PIXELATE</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagefilter</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_FILTER_PIXELATE</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</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;Merge&amp;nbsp;the&amp;nbsp;differences&amp;nbsp;onto&amp;nbsp;the&amp;nbsp;output&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagecopy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$output</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$logo1</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'>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'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo1</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo1</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagecopy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$output</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$logo2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo2</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'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$logo2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;the&amp;nbsp;differences<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$output</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$output</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagefilterpixelate.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagefilter.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 if PHP is compiled with the bundled version of the GD library.</span></p></blockquote> </div> <a name='function.imagefilter.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.imageconvolution.php' class='function' rel='rdfs-seeAlso'>imageconvolution()</a> - Apply a 3x3 convolution matrix, using coefficient and offset</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="imagefilltoborder" value="<div id='function.imagefilltoborder' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagefilltoborder.php'>imagefilltoborder</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagefilltoborder</span> &amp;mdash; <span class='dc-title'>Flood fill to specific color</span></p> </div> <a name='function.imagefilltoborder.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>imagefilltoborder</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$border</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> <b>imagefilltoborder()</b> performs a flood fill whose border color is defined by <i><tt class='parameter'>border</tt></i> . The starting point for the fill is <i><tt class='parameter'>x</tt></i> , <i><tt class='parameter'>y</tt></i> (top left is 0, 0) and the region is filled with color <i><tt class='parameter'>color</tt></i> . </p> </div> <a name='function.imagefilltoborder.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of start. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of start. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>border</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The border color. A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The fill color. A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagefilltoborder.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.imagefilltoborder.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Filling an ellipse with a color</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;the&amp;nbsp;image&amp;nbsp;handle,&amp;nbsp;set&amp;nbsp;the&amp;nbsp;background&amp;nbsp;to&amp;nbsp;white<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;an&amp;nbsp;ellipse&amp;nbsp;to&amp;nbsp;fill&amp;nbsp;with&amp;nbsp;a&amp;nbsp;black&amp;nbsp;border<br /></span><span style='color: #0000BB'>imageellipse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;border&amp;nbsp;and&amp;nbsp;fill&amp;nbsp;colors<br /></span><span style='color: #0000BB'>$border&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$fill&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Fill&amp;nbsp;the&amp;nbsp;selection<br /></span><span style='color: #0000BB'>imagefilltoborder</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$border</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$fill</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;and&amp;nbsp;free&amp;nbsp;memory<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagefilltoborder.png' /> </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="imagefilledrectangle" value="<div id='function.imagefilledrectangle' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagefilledrectangle.php'>imagefilledrectangle</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagefilledrectangle</span> &amp;mdash; <span class='dc-title'>Draw a filled rectangle</span></p> </div> <a name='function.imagefilledrectangle.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>imagefilledrectangle</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x1</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y1</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> Creates a rectangle filled with <i><tt class='parameter'>color</tt></i> in the given <i><tt class='parameter'>image</tt></i> starting at point 1 and ending at point 2. 0, 0 is the top left corner of the image. </p> </div> <a name='function.imagefilledrectangle.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate for point 1. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate for point 1. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate for point 2. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate for point 2. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The fill color. A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagefilledrectangle.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.imagefilledrectangle.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagefilledrectangle()</b> usage</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;55x30&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>55</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;a&amp;nbsp;white&amp;nbsp;rectangle<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>25</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./imagefilledrectangle.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagefilledrectangle.png' /> </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="imagefilledpolygon" value="<div id='function.imagefilledpolygon' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagefilledpolygon.php'>imagefilledpolygon</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagefilledpolygon</span> &amp;mdash; <span class='dc-title'>Draw a filled polygon</span></p> </div> <a name='function.imagefilledpolygon.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>imagefilledpolygon</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$points</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$num_points</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> <b>imagefilledpolygon()</b> creates a filled polygon in the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagefilledpolygon.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>points</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array containing the <i>x</i> and <i>y</i> coordinates of the polygons vertices consecutively. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>num_points</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Total number of vertices, which must be bigger than 3. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagefilledpolygon.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.imagefilledpolygon.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagefilledpolygon()</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;array&amp;nbsp;of&amp;nbsp;points&amp;nbsp;for&amp;nbsp;polygon<br /></span><span style='color: #0000BB'>$values&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<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'>40</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Point&amp;nbsp;1&amp;nbsp;(x,&amp;nbsp;y)<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'>20</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>240</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Point&amp;nbsp;2&amp;nbsp;(x,&amp;nbsp;y)<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'>60</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>60</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Point&amp;nbsp;3&amp;nbsp;(x,&amp;nbsp;y)<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'>240</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Point&amp;nbsp;4&amp;nbsp;(x,&amp;nbsp;y)<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'>50</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>40</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Point&amp;nbsp;5&amp;nbsp;(x,&amp;nbsp;y)<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'>10</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>10&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Point&amp;nbsp;6&amp;nbsp;(x,&amp;nbsp;y)<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: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;create&amp;nbsp;image<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>250</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>250</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;allocate&amp;nbsp;colors<br /></span><span style='color: #0000BB'>$bg&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$blue&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;fill&amp;nbsp;the&amp;nbsp;background<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>249</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>249</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$bg</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;draw&amp;nbsp;a&amp;nbsp;polygon<br /></span><span style='color: #0000BB'>imagefilledpolygon</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$values</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>6</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$blue</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;flush&amp;nbsp;image<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagefilledpolygon.png' /> </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="imagefilledellipse" value="<div id='function.imagefilledellipse' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagefilledellipse.php'>imagefilledellipse</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagefilledellipse</span> &amp;mdash; <span class='dc-title'>Draw a filled ellipse</span></p> </div> <a name='function.imagefilledellipse.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>imagefilledellipse</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cx</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cy</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$width</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$height</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> Draws an ellipse centered at the specified coordinate on the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagefilledellipse.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cx</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of the center. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cy</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of the center. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>width</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The ellipse width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>height</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The ellipse height. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The fill color. A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagefilledellipse.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.imagefilledellipse.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagefilledellipse()</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;create&amp;nbsp;a&amp;nbsp;blank&amp;nbsp;image<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>400</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>300</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;fill&amp;nbsp;the&amp;nbsp;background&amp;nbsp;color<br /></span><span style='color: #0000BB'>$bg&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>0</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;choose&amp;nbsp;a&amp;nbsp;color&amp;nbsp;for&amp;nbsp;the&amp;nbsp;ellipse<br /></span><span style='color: #0000BB'>$col_ellipse&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;draw&amp;nbsp;the&amp;nbsp;white&amp;nbsp;ellipse<br /></span><span style='color: #0000BB'>imagefilledellipse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>300</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$col_ellipse</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;output&amp;nbsp;the&amp;nbsp;picture<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagefilledellipse.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagefilledellipse.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> </div> <a name='function.imagefilledellipse.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.imageellipse.php' class='function' rel='rdfs-seeAlso'>imageellipse()</a> - Draw an ellipse</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagefilledarc.php' class='function' rel='rdfs-seeAlso'>imagefilledarc()</a> - Draw a partial arc and fill it</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="imagefilledarc" value="<div id='function.imagefilledarc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagefilledarc.php'>imagefilledarc</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagefilledarc</span> &amp;mdash; <span class='dc-title'>Draw a partial arc and fill it</span></p> </div> <a name='function.imagefilledarc.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>imagefilledarc</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cx</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cy</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$width</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$height</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'>$end</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$style</tt></span> )</div> <p class='para rdfs-comment'> Draws a partial arc centered at the specified coordinate in the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagefilledarc.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cx</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of the center. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cy</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of the center. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>width</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The arc width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>height</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The arc height. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>start</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The arc start angle, in degrees. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>end</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The arc end angle, in degrees. 0&amp;Acirc;&amp;deg; is located at the three-o&amp;#039;clock position, and the arc is drawn clockwise. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>style</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A bitwise OR of the following possibilities: </p><ol type='1'> <li class='listitem'><span class='simpara'><b><tt class='constant'>IMG_ARC_PIE</tt></b></span></li> <li class='listitem'><span class='simpara'><b><tt class='constant'>IMG_ARC_CHORD</tt></b></span></li> <li class='listitem'><span class='simpara'><b><tt class='constant'>IMG_ARC_NOFILL</tt></b></span></li> <li class='listitem'><span class='simpara'><b><tt class='constant'>IMG_ARC_EDGED</tt></b></span></li> </ol><p> <b><tt class='constant'>IMG_ARC_PIE</tt></b> and <b><tt class='constant'>IMG_ARC_CHORD</tt></b> are mutually exclusive; <b><tt class='constant'>IMG_ARC_CHORD</tt></b> just connects the starting and ending angles with a straight line, while <b><tt class='constant'>IMG_ARC_PIE</tt></b> produces a rounded edge. <b><tt class='constant'>IMG_ARC_NOFILL</tt></b> indicates that the arc or chord should be outlined, not filled. <b><tt class='constant'>IMG_ARC_EDGED</tt></b>, used together with <b><tt class='constant'>IMG_ARC_NOFILL</tt></b>, indicates that the beginning and ending angles should be connected to the center - this is a good way to outline (rather than fill) a &amp;#039;pie slice&amp;#039;. </p> </dd> </dl> <p> </p> </div> <a name='function.imagefilledarc.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.imagefilledarc.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Creating a 3D looking pie</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;create&amp;nbsp;image<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;allocate&amp;nbsp;some&amp;nbsp;solors<br /></span><span style='color: #0000BB'>$white&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$gray&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xC0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xC0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xC0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$darkgray&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x90</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x90</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x90</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$navy&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x80</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$darknavy&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x50</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$red&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$darkred&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x90</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;make&amp;nbsp;the&amp;nbsp;3D&amp;nbsp;effect<br /></span><span style='color: #007700'>for&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>60</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>50</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;</span><span style='color: #0000BB'>imagefilledarc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</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'>45</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$darknavy</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_ARC_PIE</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilledarc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>45</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>75&amp;nbsp;</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$darkgray</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_ARC_PIE</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilledarc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>360&amp;nbsp;</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$darkred</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_ARC_PIE</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>imagefilledarc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</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'>45</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$navy</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_ARC_PIE</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagefilledarc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>45</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>75&amp;nbsp;</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$gray</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_ARC_PIE</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagefilledarc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>360&amp;nbsp;</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_ARC_PIE</span><span style='color: #007700'>);<br /><br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;flush&amp;nbsp;image<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagefilledarc.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagefilledarc.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</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="imagefill" value="<div id='function.imagefill' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagefill.php'>imagefill</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagefill</span> &amp;mdash; <span class='dc-title'>Flood fill</span></p> </div> <a name='function.imagefill.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>imagefill</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> Performs a flood fill starting at the given coordinate (top left is 0, 0) with the given <i><tt class='parameter'>color</tt></i> in the <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagefill.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of start point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of start point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The fill color. A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagefill.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.imagefill.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagefill()</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 />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;sets&amp;nbsp;background&amp;nbsp;to&amp;nbsp;red<br /></span><span style='color: #0000BB'>$red&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>);<br /></span><span style='color: #0000BB'>imagefill</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>$red</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagefill.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagefill.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.imagecolorallocate.php' class='function' rel='rdfs-seeAlso'>imagecolorallocate()</a> - Allocate a color for 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="imageellipse" value="<div id='function.imageellipse' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imageellipse.php'>imageellipse</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imageellipse</span> &amp;mdash; <span class='dc-title'>Draw an ellipse</span></p> </div> <a name='function.imageellipse.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>imageellipse</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cx</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cy</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$width</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$height</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> Draws an ellipse centered at the specified coordinates. </p> </div> <a name='function.imageellipse.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cx</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of the center. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cy</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of the center. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>width</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The ellipse width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>height</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The ellipse height. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The color of the ellipse. A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imageellipse.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.imageellipse.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imageellipse()</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;Create&amp;nbsp;a&amp;nbsp;blank&amp;nbsp;image.<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>400</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>300</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Select&amp;nbsp;the&amp;nbsp;background&amp;nbsp;color.<br /></span><span style='color: #0000BB'>$bg&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>0</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Fill&amp;nbsp;the&amp;nbsp;background&amp;nbsp;with&amp;nbsp;the&amp;nbsp;color&amp;nbsp;selected&amp;nbsp;above.<br /></span><span style='color: #0000BB'>imagefill</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>$bg</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Choose&amp;nbsp;a&amp;nbsp;color&amp;nbsp;for&amp;nbsp;the&amp;nbsp;ellipse.<br /></span><span style='color: #0000BB'>$col_ellipse&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;the&amp;nbsp;ellipse.<br /></span><span style='color: #0000BB'>imageellipse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>300</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$col_ellipse</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;the&amp;nbsp;image.<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imageellipse.png' /> </div> </div> </div><p> </p> </div> <a name='function.imageellipse.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function requires GD 2.0.2 or later. <br /> </p></blockquote> </div> <a name='function.imageellipse.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.imagefilledellipse.php' class='function' rel='rdfs-seeAlso'>imagefilledellipse()</a> - Draw a filled ellipse</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagearc.php' class='function' rel='rdfs-seeAlso'>imagearc()</a> - Draws an arc</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="imagedestroy" value="<div id='function.imagedestroy' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagedestroy.php'>imagedestroy</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagedestroy</span> &amp;mdash; <span class='dc-title'>Destroy an image</span></p> </div> <a name='function.imagedestroy.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>imagedestroy</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> )</div> <p class='para rdfs-comment'> <b>imagedestroy()</b> frees any memory associated with image <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagedestroy.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imagedestroy.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.imagedestroy.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>imagedestroy()</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;create&amp;nbsp;a&amp;nbsp;100&amp;nbsp;x&amp;nbsp;100&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;alter&amp;nbsp;or&amp;nbsp;save&amp;nbsp;the&amp;nbsp;image<br /><br />//&amp;nbsp;frees&amp;nbsp;image&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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="imagedashedline" value="<div id='function.imagedashedline' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagedashedline.php'>imagedashedline</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagedashedline</span> &amp;mdash; <span class='dc-title'>Draw a dashed line</span></p> </div> <a name='function.imagedashedline.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>imagedashedline</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x1</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y1</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y2</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> This function is deprecated. Use combination of <a href='http://www.php.net/manual/en/function.imagesetstyle.php' class='function'>imagesetstyle()</a> and <a href='http://www.php.net/manual/en/function.imageline.php' class='function'>imageline()</a> instead. </p> </div> <a name='function.imagedashedline.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Upper left x coordinate. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Upper left y coordinate 0, 0 is the top left corner of the image. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Bottom right x coordinate. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Bottom right y coordinate. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The fill color. A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagedashedline.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Always returns true </p> </div> <a name='function.imagedashedline.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagedashedline()</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;Create&amp;nbsp;a&amp;nbsp;100x100&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;a&amp;nbsp;vertical&amp;nbsp;dashed&amp;nbsp;line<br /></span><span style='color: #0000BB'>imagedashedline</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>25</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./dashedline.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagedashedline.png' /> </div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Alternative to <b>imagedashedline()</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;Create&amp;nbsp;a&amp;nbsp;100x100&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Define&amp;nbsp;our&amp;nbsp;style:&amp;nbsp;First&amp;nbsp;4&amp;nbsp;pixels&amp;nbsp;is&amp;nbsp;white&amp;nbsp;and&amp;nbsp;the&amp;nbsp;<br />//&amp;nbsp;next&amp;nbsp;4&amp;nbsp;is&amp;nbsp;transparent.&amp;nbsp;This&amp;nbsp;creates&amp;nbsp;the&amp;nbsp;dashed&amp;nbsp;line&amp;nbsp;effect<br /></span><span style='color: #0000BB'>$style&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;Array(<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: #0000BB'>$white</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;</span><span style='color: #0000BB'>$white</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;</span><span style='color: #0000BB'>$white</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;</span><span style='color: #0000BB'>$white</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;</span><span style='color: #0000BB'>IMG_COLOR_TRANSPARENT</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;</span><span style='color: #0000BB'>IMG_COLOR_TRANSPARENT</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;</span><span style='color: #0000BB'>IMG_COLOR_TRANSPARENT</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;</span><span style='color: #0000BB'>IMG_COLOR_TRANSPARENT<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: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagesetstyle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$style</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;the&amp;nbsp;dashed&amp;nbsp;line<br /></span><span style='color: #0000BB'>imageline</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>25</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_COLOR_STYLED</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./imageline.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagedashedline.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.imagesetstyle.php' class='function' rel='rdfs-seeAlso'>imagesetstyle()</a> - Set the style for line drawing</li> <li class='member'><a href='http://www.php.net/manual/en/function.imageline.php' class='function' rel='rdfs-seeAlso'>imageline()</a> - Draw a line</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="imagecreatetruecolor" value="<div id='function.imagecreatetruecolor' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreatetruecolor.php'>imagecreatetruecolor</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreatetruecolor</span> &amp;mdash; <span class='dc-title'>Create a new true color image</span></p> </div> <a name='function.imagecreatetruecolor.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>imagecreatetruecolor</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$width</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$height</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecreatetruecolor()</b> returns an image identifier representing a black image of the specified size. </p> <p class='para'> Depending on your PHP and GD versions this function is defined or not. With PHP 4.0.6 through 4.1.x this function always exists if the GD module is loaded, but calling it without GD2 being installed PHP will issue a fatal error and exit. With PHP 4.2.x this behaviour is different in issuing a warning instead of an error. Other versions only define this function, if the correct GD version is installed. </p> </div> <a name='function.imagecreatetruecolor.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'>width</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Image width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>height</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Image height. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreatetruecolor.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagecreatetruecolor.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Creating a new GD image stream and outputting an image. </b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />header&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>120</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</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'>'Cannot&amp;nbsp;Initialize&amp;nbsp;new&amp;nbsp;GD&amp;nbsp;image&amp;nbsp;stream'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecreatetruecolor.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagecreatetruecolor.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: This function will not work with <acronym title='Graphic Interchange Format'>GIF</acronym> file formats. <br /> </p></blockquote> </div> <a name='function.imagecreatetruecolor.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.imagedestroy.php' class='function' rel='rdfs-seeAlso'>imagedestroy()</a> - Destroy an image</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecreate.php' class='function' rel='rdfs-seeAlso'>imagecreate()</a> - Create a new palette based 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="imagecreatefromxbm" value="<div id='function.imagecreatefromxbm' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreatefromxbm.php'>imagecreatefromxbm</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.1, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreatefromxbm</span> &amp;mdash; <span class='dc-title'>Create a new image from file or URL</span></p> </div> <a name='function.imagecreatefromxbm.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>imagecreatefromxbm</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecreatefromxbm()</b> returns an image identifier representing the image obtained from the given filename. </p> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>A URL can be used as a filename with this function if the <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>fopen wrappers</a> have been enabled. See <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a> for more details on how to specify the filename. See the <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.</p></div> </div> <a name='function.imagecreatefromxbm.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 XBM image. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreatefromxbm.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagecreatefromxbm.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Convert an XBM image to a png image using <b>imagecreatefromxbm()</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;Load&amp;nbsp;the&amp;nbsp;xbm&amp;nbsp;file<br /></span><span style='color: #0000BB'>$xbm&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromxbm</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./example.xbm'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Convert&amp;nbsp;it&amp;nbsp;to&amp;nbsp;a&amp;nbsp;png&amp;nbsp;file<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$xbm</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./example.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$xbm</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.imagecreatefromxbm.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='warning'><b class='warning'>Warning</b><p class='para'>Windows versions of PHP prior to PHP 4.3.0 do not support access of remote files via this function, even if <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>allow_url_fopen</a> is enabled. </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="imagecreatefromwbmp" value="<div id='function.imagecreatefromwbmp' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreatefromwbmp.php'>imagecreatefromwbmp</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.1, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreatefromwbmp</span> &amp;mdash; <span class='dc-title'>Create a new image from file or URL</span></p> </div> <a name='function.imagecreatefromwbmp.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>imagecreatefromwbmp</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecreatefromwbmp()</b> returns an image identifier representing the image obtained from the given filename. </p> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>A URL can be used as a filename with this function if the <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>fopen wrappers</a> have been enabled. See <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a> for more details on how to specify the filename. See the <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.</p></div> </div> <a name='function.imagecreatefromwbmp.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 WBMP image. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreatefromwbmp.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagecreatefromwbmp.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Example to handle an error during loading of a WBMP</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'>function&amp;nbsp;</span><span style='color: #0000BB'>LoadWBMP</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Attempt&amp;nbsp;to&amp;nbsp;open&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>imagecreatefromwbmp</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;See&amp;nbsp;if&amp;nbsp;it&amp;nbsp;failed&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;blank&amp;nbsp;image&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$im&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>20</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</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'>$bgc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>$tc&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$bgc</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Output&amp;nbsp;an&amp;nbsp;error&amp;nbsp;message&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>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: #DD0000'>'Error&amp;nbsp;loading&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$tc</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$img&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>LoadPNG</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'bogus.image'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagwbmp</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.imagecreatefromwbmp.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>WBMP support is only available if PHP was compiled against GD-1.8 or later.</span></p></blockquote> <div class='warning'><b class='warning'>Warning</b><p class='para'>Windows versions of PHP prior to PHP 4.3.0 do not support access of remote files via this function, even if <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>allow_url_fopen</a> is enabled. </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="imagecreatefromstring" value="<div id='function.imagecreatefromstring' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreatefromstring.php'>imagecreatefromstring</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreatefromstring</span> &amp;mdash; <span class='dc-title'>Create a new image from the image stream in the string</span></p> </div> <a name='function.imagecreatefromstring.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>imagecreatefromstring</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecreatefromstring()</b> returns an image identifier representing the image obtained from the given <i><tt class='parameter'>data</tt></i> . These types will be automatically detected if your build of PHP supports them: JPEG, PNG, GIF, WBMP, and GD2. </p> </div> <a name='function.imagecreatefromstring.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'>image</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A string containing the image data. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreatefromstring.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An image resource will be returned on success. <b><tt class='constant'>FALSE</tt></b> is returned if the image type is unsupported, the data is not in a recognised format, or the image is corrupt and cannot be loaded. </p> </div> <a name='function.imagecreatefromstring.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagecreatefromstring()</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 />$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'iVBORw0KGgoAAAANSUhEUgAAABwAAAASCAMAAAB/2U7WAAAABl'<br />&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'>'BMVEUAAAD///+l2Z/dAAAASUlEQVR4XqWQUQoAIAxC2/0vXZDr'<br />&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'>'EX4IJTRkb7lobNUStXsB0jIXIAMSsQnWlsV+wULF4Avk9fLq2r'<br />&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'>'8a5HSE35Q3eO2XP1A1wQkZSgETvDtKdQAAAABJRU5ErkJggg=='</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>base64_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromstring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$im&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'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br />}<br />else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occurred.'</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecreatefromstring.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagecreatefromstring.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.imagecreatefromjpeg.php' class='function' rel='rdfs-seeAlso'>imagecreatefromjpeg()</a> - Create a new image from file or URL</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecreatefrompng.php' class='function' rel='rdfs-seeAlso'>imagecreatefrompng()</a> - Create a new image from file or URL</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecreatefromgif.php' class='function' rel='rdfs-seeAlso'>imagecreatefromgif()</a> - Create a new image from file or URL</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function' rel='rdfs-seeAlso'>imagecreatetruecolor()</a> - Create a new true color 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="imagecreatefrompng" value="<div id='function.imagecreatefrompng' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreatefrompng.php'>imagecreatefrompng</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreatefrompng</span> &amp;mdash; <span class='dc-title'>Create a new image from file or URL</span></p> </div> <a name='function.imagecreatefrompng.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>imagecreatefrompng</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecreatefrompng()</b> returns an image identifier representing the image obtained from the given filename. </p> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>A URL can be used as a filename with this function if the <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>fopen wrappers</a> have been enabled. See <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a> for more details on how to specify the filename. See the <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.</p></div> </div> <a name='function.imagecreatefrompng.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 PNG image. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreatefrompng.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagecreatefrompng.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Example to handle an error during loading of a PNG</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'>function&amp;nbsp;</span><span style='color: #0000BB'>LoadPNG</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Attempt&amp;nbsp;to&amp;nbsp;open&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;See&amp;nbsp;if&amp;nbsp;it&amp;nbsp;failed&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;blank&amp;nbsp;image&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$im&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</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'>$bgc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>$tc&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$bgc</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Output&amp;nbsp;an&amp;nbsp;error&amp;nbsp;message&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>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: #DD0000'>'Error&amp;nbsp;loading&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$tc</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$img&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>LoadPNG</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'bogus.image'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.imagecreatefrompng.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='warning'><b class='warning'>Warning</b><p class='para'>Windows versions of PHP prior to PHP 4.3.0 do not support access of remote files via this function, even if <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>allow_url_fopen</a> is enabled. </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="imagecreatefromjpeg" value="<div id='function.imagecreatefromjpeg' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreatefromjpeg.php'>imagecreatefromjpeg</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreatefromjpeg</span> &amp;mdash; <span class='dc-title'>Create a new image from file or URL</span></p> </div> <a name='function.imagecreatefromjpeg.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>imagecreatefromjpeg</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecreatefromjpeg()</b> returns an image identifier representing the image obtained from the given filename. </p> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>A URL can be used as a filename with this function if the <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>fopen wrappers</a> have been enabled. See <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a> for more details on how to specify the filename. See the <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.</p></div> </div> <a name='function.imagecreatefromjpeg.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 JPEG image. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreatefromjpeg.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagecreatefromjpeg.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Example to handle an error during loading of a JPEG</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'>function&amp;nbsp;</span><span style='color: #0000BB'>LoadJpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Attempt&amp;nbsp;to&amp;nbsp;open&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>imagecreatefromjpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;See&amp;nbsp;if&amp;nbsp;it&amp;nbsp;failed&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;black&amp;nbsp;image&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$im&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</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'>$bgc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>$tc&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$bgc</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Output&amp;nbsp;an&amp;nbsp;error&amp;nbsp;message&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>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: #DD0000'>'Error&amp;nbsp;loading&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$tc</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$img&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>LoadJpeg</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'bogus.image'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecreatefromjpeg.jpg' /> </div> </div> </div> </div> <a name='function.imagecreatefromjpeg.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>JPEG support is only available if PHP was compiled against GD-1.8 or later.</span></p></blockquote> <div class='warning'><b class='warning'>Warning</b><p class='para'>Windows versions of PHP prior to PHP 4.3.0 do not support access of remote files via this function, even if <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>allow_url_fopen</a> is enabled. </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="imagecreatefromgif" value="<div id='function.imagecreatefromgif' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreatefromgif.php'>imagecreatefromgif</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreatefromgif</span> &amp;mdash; <span class='dc-title'>Create a new image from file or URL</span></p> </div> <a name='function.imagecreatefromgif.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>imagecreatefromgif</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecreatefromgif()</b> returns an image identifier representing the image obtained from the given filename. </p> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>A URL can be used as a filename with this function if the <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>fopen wrappers</a> have been enabled. See <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a> for more details on how to specify the filename. See the <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.</p></div> </div> <a name='function.imagecreatefromgif.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 GIF image. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreatefromgif.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagecreatefromgif.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Example to handle an error during loading of a GIF</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'>function&amp;nbsp;</span><span style='color: #0000BB'>LoadGif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Attempt&amp;nbsp;to&amp;nbsp;open&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;See&amp;nbsp;if&amp;nbsp;it&amp;nbsp;failed&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;blank&amp;nbsp;image&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</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'>$bgc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>$tc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilledrectangle&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$bgc</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Output&amp;nbsp;an&amp;nbsp;error&amp;nbsp;message&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagestring&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>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: #DD0000'>'Error&amp;nbsp;loading&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$imgname</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$tc</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$img&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>LoadGif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'bogus.image'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagegif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecreatefromgif.gif' /> </div> </div> </div> </div> <a name='function.imagecreatefromgif.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: GIF support was removed from the GD library in Version 1.6, and added back in Version 2.0.28. This function is not available between these versions. <br /> </p></blockquote> <div class='warning'><b class='warning'>Warning</b><p class='para'>Windows versions of PHP prior to PHP 4.3.0 do not support access of remote files via this function, even if <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>allow_url_fopen</a> is enabled. </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="imagecreatefromgd2part" value="<div id='function.imagecreatefromgd2part' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreatefromgd2part.php'>imagecreatefromgd2part</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreatefromgd2part</span> &amp;mdash; <span class='dc-title'>Create a new image from a given part of GD2 file or URL</span></p> </div> <a name='function.imagecreatefromgd2part.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>imagecreatefromgd2part</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'>$srcX</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$srcY</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$width</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$height</tt></span> )</div> <p class='para rdfs-comment'> Create a new image from a given part of GD2 file or URL. </p> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>A URL can be used as a filename with this function if the <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>fopen wrappers</a> have been enabled. See <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a> for more details on how to specify the filename. See the <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.</p></div> </div> <a name='function.imagecreatefromgd2part.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 GD2 image. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>srcX</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>srcY</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>width</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>height</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source height. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreatefromgd2part.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagecreatefromgd2part.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagecreatefromgd2part()</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;For&amp;nbsp;this&amp;nbsp;example&amp;nbsp;we&amp;nbsp;need&amp;nbsp;the&amp;nbsp;image&amp;nbsp;size&amp;nbsp;before<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>getimagesize</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./test.gd2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;image&amp;nbsp;instance&amp;nbsp;now&amp;nbsp;we&amp;nbsp;got&amp;nbsp;the&amp;nbsp;image&amp;nbsp;<br />//&amp;nbsp;sizes<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgd2part</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./test.gd2'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;/&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>6</span><span style='color: #007700'>,&amp;nbsp;(</span><span style='color: #0000BB'>$image</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'>2</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>6</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;an&amp;nbsp;image&amp;nbsp;operation,&amp;nbsp;in&amp;nbsp;this&amp;nbsp;case&amp;nbsp;we&amp;nbsp;emboss&amp;nbsp;the&amp;nbsp;<br />//&amp;nbsp;image&amp;nbsp;if&amp;nbsp;PHP5+<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>function_exists</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'imagefilter'</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilter</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_FILTER_EMBOSS</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;optimized&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagegd2</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./test_emboss.gd2'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagecreatefromgd2part.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> <div class='warning'><b class='warning'>Warning</b><p class='para'>Windows versions of PHP prior to PHP 4.3.0 do not support access of remote files via this function, even if <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>allow_url_fopen</a> is enabled. </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="imagecreatefromgd2" value="<div id='function.imagecreatefromgd2' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreatefromgd2.php'>imagecreatefromgd2</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreatefromgd2</span> &amp;mdash; <span class='dc-title'>Create a new image from GD2 file or URL</span></p> </div> <a name='function.imagecreatefromgd2.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>imagecreatefromgd2</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Create a new image from GD2 file or URL. </p> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>A URL can be used as a filename with this function if the <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>fopen wrappers</a> have been enabled. See <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a> for more details on how to specify the filename. See the <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.</p></div> </div> <a name='function.imagecreatefromgd2.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 GD2 image. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreatefromgd2.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagecreatefromgd2.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagecreatefromgd2()</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;Load&amp;nbsp;the&amp;nbsp;gd2&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgd2</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./test.gd2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Apply&amp;nbsp;an&amp;nbsp;effect&amp;nbsp;on&amp;nbsp;the&amp;nbsp;image,&amp;nbsp;in&amp;nbsp;this&amp;nbsp;<br />//&amp;nbsp;case&amp;nbsp;negate&amp;nbsp;the&amp;nbsp;image&amp;nbsp;if&amp;nbsp;PHP5+<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>function_exists</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'imagefilter'</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>imagefilter</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>IMG_FILTER_NEGATE</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagegd2</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./test_updated.gd2'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagecreatefromgd2.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> <div class='warning'><b class='warning'>Warning</b><p class='para'>Windows versions of PHP prior to PHP 4.3.0 do not support access of remote files via this function, even if <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>allow_url_fopen</a> is enabled. </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="imagecreatefromgd" value="<div id='function.imagecreatefromgd' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreatefromgd.php'>imagecreatefromgd</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreatefromgd</span> &amp;mdash; <span class='dc-title'>Create a new image from GD file or URL</span></p> </div> <a name='function.imagecreatefromgd.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>imagecreatefromgd</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> <p class='para rdfs-comment'> Create a new image from GD file or URL. </p> <div class='tip'><b class='tip'>Tip</b><p class='simpara'>A URL can be used as a filename with this function if the <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>fopen wrappers</a> have been enabled. See <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a> for more details on how to specify the filename. See the <a href='http://www.php.net/manual/en/wrappers.php' class='xref'>List of Supported Protocols/Wrappers</a> for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.</p></div> </div> <a name='function.imagecreatefromgd.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 GD file. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreatefromgd.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagecreatefromgd.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagecreatefromgd()</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;Load&amp;nbsp;the&amp;nbsp;gd&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>imagecreatefromgd</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./test.gd'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Test&amp;nbsp;if&amp;nbsp;the&amp;nbsp;image&amp;nbsp;was&amp;nbsp;loaded<br /></span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>is_resource</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;load&amp;nbsp;gd&amp;nbsp;image!'</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;image&amp;nbsp;operations&amp;nbsp;here<br /><br />//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagegd</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./test_updated.gd'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagecreatefromgd.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='warning'><b class='warning'>Warning</b><p class='para'>Windows versions of PHP prior to PHP 4.3.0 do not support access of remote files via this function, even if <a href='http://www.php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen' class='link'>allow_url_fopen</a> is enabled. </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="imagecreate" value="<div id='function.imagecreate' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecreate.php'>imagecreate</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecreate</span> &amp;mdash; <span class='dc-title'>Create a new palette based image</span></p> </div> <a name='function.imagecreate.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>imagecreate</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$width</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$height</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecreate()</b> returns an image identifier representing a blank image of specified size. </p> <p class='para'> We recommend the use of <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>. </p> </div> <a name='function.imagecreate.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'>width</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The image width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>height</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The image height. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecreate.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an image resource identifier on success, <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.imagecreate.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Creating a new GD image stream and outputting an image. </b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>imagecreate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>110</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Cannot&amp;nbsp;Initialize&amp;nbsp;new&amp;nbsp;GD&amp;nbsp;image&amp;nbsp;stream'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$background_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$text_color&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>233</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>14</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>91</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>5</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'>'A&amp;nbsp;Simple&amp;nbsp;Text&amp;nbsp;String'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$text_color</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecreate.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagecreate.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.imagedestroy.php' class='function' rel='rdfs-seeAlso'>imagedestroy()</a> - Destroy an image</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function' rel='rdfs-seeAlso'>imagecreatetruecolor()</a> - Create a new true color 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="imagecopyresized" value="<div id='function.imagecopyresized' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecopyresized.php'>imagecopyresized</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecopyresized</span> &amp;mdash; <span class='dc-title'>Copy and resize part of an image</span></p> </div> <a name='function.imagecopyresized.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>imagecopyresized</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$dst_image</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$src_image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_w</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_h</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_w</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_h</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecopyresized()</b> copies a rectangular portion of one image to another image. <i><tt class='parameter'>dst_image</tt></i> is the destination image, <i><tt class='parameter'>src_image</tt></i> is the source image identifier. </p> <p class='para'> In other words, <b>imagecopyresized()</b> will take an rectangular area from <i><tt class='parameter'>src_image</tt></i> of width <i><tt class='parameter'>src_w</tt></i> and height <i><tt class='parameter'>src_h</tt></i> at position (<i><tt class='parameter'>src_x</tt></i> ,<i><tt class='parameter'>src_y</tt></i> ) and place it in a rectangular area of <i><tt class='parameter'>dst_image</tt></i> of width <i><tt class='parameter'>dst_w</tt></i> and height <i><tt class='parameter'>dst_h</tt></i> at position (<i><tt class='parameter'>dst_x</tt></i> ,<i><tt class='parameter'>dst_y</tt></i> ). </p> <p class='para'> If the source and destination coordinates and width and heights differ, appropriate stretching or shrinking of the image fragment will be performed. The coordinates refer to the upper left corner. This function can be used to copy regions within the same image (if <i><tt class='parameter'>dst_image</tt></i> is the same as <i><tt class='parameter'>src_image</tt></i> ) but if the regions overlap the results will be unpredictable. </p> </div> <a name='function.imagecopyresized.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'>dst_im</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_im</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of destination point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of destination point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_w</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_h</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination height. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_w</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_h</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source height. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecopyresized.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.imagecopyresized.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Resizing an image</b></p> <div class='example-contents para'><p> This example will display the image at half size. </p></div> <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;File&amp;nbsp;and&amp;nbsp;new&amp;nbsp;size<br /></span><span style='color: #0000BB'>$filename&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'test.jpg'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$percent&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0.5</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Content&amp;nbsp;type<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;new&amp;nbsp;sizes<br /></span><span style='color: #007700'>list(</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;=&amp;nbsp;</span><span style='color: #0000BB'>getimagesize</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$newwidth&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$width&amp;nbsp;</span><span style='color: #007700'>*&amp;nbsp;</span><span style='color: #0000BB'>$percent</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$newheight&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$height&amp;nbsp;</span><span style='color: #007700'>*&amp;nbsp;</span><span style='color: #0000BB'>$percent</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Load<br /></span><span style='color: #0000BB'>$thumb&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$newwidth</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$newheight</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$source&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromjpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Resize<br /></span><span style='color: #0000BB'>imagecopyresized</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$thumb</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$source</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'>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'>$newwidth</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$newheight</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'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output<br /></span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$thumb</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecopyresized.jpg' /> </div> </div> <div class='example-contents para'><p> The image will be output at half size, though better quality could be obtained using <a href='http://www.php.net/manual/en/function.imagecopyresampled.php' class='function'>imagecopyresampled()</a>. </p></div> </div><p> </p> </div> <a name='function.imagecopyresized.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: There is a problem due to palette image limitations (255+1 colors). Resampling or filtering an image commonly needs more colors than 255, a kind of approximation is used to calculate the new resampled pixel and its color. With a palette image we try to allocate a new color, if that failed, we choose the closest (in theory) computed color. This is not always the closest visual color. That may produce a weird result, like blank (or visually blank) images. To skip this problem, please use a truecolor image as a destination image, such as one created by <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>. <br /> </p></blockquote> </div> <a name='function.imagecopyresized.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> <a href='http://www.php.net/manual/en/function.imagecopyresampled.php' class='function' rel='rdfs-seeAlso'>imagecopyresampled()</a> - Copy and resize part of an image with resampling </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="imagecopyresampled" value="<div id='function.imagecopyresampled' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecopyresampled.php'>imagecopyresampled</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecopyresampled</span> &amp;mdash; <span class='dc-title'>Copy and resize part of an image with resampling</span></p> </div> <a name='function.imagecopyresampled.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>imagecopyresampled</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$dst_image</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$src_image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_w</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_h</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_w</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_h</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecopyresampled()</b> copies a rectangular portion of one image to another image, smoothly interpolating pixel values so that, in particular, reducing the size of an image still retains a great deal of clarity. </p> <p class='para'> In other words, <b>imagecopyresampled()</b> will take an rectangular area from <i><tt class='parameter'>src_image</tt></i> of width <i><tt class='parameter'>src_w</tt></i> and height <i><tt class='parameter'>src_h</tt></i> at position (<i><tt class='parameter'>src_x</tt></i> ,<i><tt class='parameter'>src_y</tt></i> ) and place it in a rectangular area of <i><tt class='parameter'>dst_image</tt></i> of width <i><tt class='parameter'>dst_w</tt></i> and height <i><tt class='parameter'>dst_h</tt></i> at position (<i><tt class='parameter'>dst_x</tt></i> ,<i><tt class='parameter'>dst_y</tt></i> ). </p> <p class='para'> If the source and destination coordinates and width and heights differ, appropriate stretching or shrinking of the image fragment will be performed. The coordinates refer to the upper left corner. This function can be used to copy regions within the same image (if <i><tt class='parameter'>dst_image</tt></i> is the same as <i><tt class='parameter'>src_image</tt></i> ) but if the regions overlap the results will be unpredictable. </p> </div> <a name='function.imagecopyresampled.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'>dst_im</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_im</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of destination point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of destination point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_w</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_h</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination height. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_w</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_h</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source height. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecopyresampled.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.imagecopyresampled.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Simple example</b></p> <div class='example-contents para'><p> This example will resample an image to half its original size. </p></div> <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;The&amp;nbsp;file<br /></span><span style='color: #0000BB'>$filename&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'test.jpg'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$percent&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0.5</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Content&amp;nbsp;type<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;new&amp;nbsp;dimensions<br /></span><span style='color: #007700'>list(</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;=&amp;nbsp;</span><span style='color: #0000BB'>getimagesize</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$new_width&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$width&amp;nbsp;</span><span style='color: #007700'>*&amp;nbsp;</span><span style='color: #0000BB'>$percent</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$new_height&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$height&amp;nbsp;</span><span style='color: #007700'>*&amp;nbsp;</span><span style='color: #0000BB'>$percent</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Resample<br /></span><span style='color: #0000BB'>$image_p&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$new_width</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$new_height</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromjpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagecopyresampled</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image_p</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$image</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'>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'>$new_width</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$new_height</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'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output<br /></span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image_p</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>null</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 class='example-contents para'><p>The above example will output something similar to:</p></div> <div class='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecopyresampled.jpg' /> </div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 Resampling an image proportionally</b></p> <div class='example-contents para'><p> This example will display an image with the maximum width, or height, of 200 pixels. </p></div> <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;The&amp;nbsp;file<br /></span><span style='color: #0000BB'>$filename&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'test.jpg'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;a&amp;nbsp;maximum&amp;nbsp;height&amp;nbsp;and&amp;nbsp;width<br /></span><span style='color: #0000BB'>$width&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$height&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Content&amp;nbsp;type<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;new&amp;nbsp;dimensions<br /></span><span style='color: #007700'>list(</span><span style='color: #0000BB'>$width_orig</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$height_orig</span><span style='color: #007700'>)&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>getimagesize</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$ratio_orig&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$width_orig</span><span style='color: #007700'>/</span><span style='color: #0000BB'>$height_orig</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$width</span><span style='color: #007700'>/</span><span style='color: #0000BB'>$height&amp;nbsp;</span><span style='color: #007700'>&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$ratio_orig</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$width&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$height</span><span style='color: #007700'>*</span><span style='color: #0000BB'>$ratio_orig</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$height&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$width</span><span style='color: #007700'>/</span><span style='color: #0000BB'>$ratio_orig</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Resample<br /></span><span style='color: #0000BB'>$image_p&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$width</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$height</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromjpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagecopyresampled</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image_p</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$image</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'>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'>$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'>$width_orig</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$height_orig</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output<br /></span><span style='color: #0000BB'>imagejpeg</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image_p</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>null</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 class='example-contents para'><p>The above example will output something similar to:</p></div> <div class='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecopyresampled_2.jpg' /> </div> </div> </div><p> </p> </div> <a name='function.imagecopyresampled.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: There is a problem due to palette image limitations (255+1 colors). Resampling or filtering an image commonly needs more colors than 255, a kind of approximation is used to calculate the new resampled pixel and its color. With a palette image we try to allocate a new color, if that failed, we choose the closest (in theory) computed color. This is not always the closest visual color. That may produce a weird result, like blank (or visually blank) images. To skip this problem, please use a truecolor image as a destination image, such as one created by <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>. <br /> </p></blockquote> </div> <a name='function.imagecopyresampled.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> <a href='http://www.php.net/manual/en/function.imagecopyresized.php' class='function' rel='rdfs-seeAlso'>imagecopyresized()</a> - Copy and resize part of an image </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="imagecopymergegray" value="<div id='function.imagecopymergegray' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecopymergegray.php'>imagecopymergegray</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecopymergegray</span> &amp;mdash; <span class='dc-title'>Copy and merge part of an image with gray scale</span></p> </div> <a name='function.imagecopymergegray.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>imagecopymergegray</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$dst_im</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$src_im</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_w</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_h</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$pct</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecopymergegray()</b> copy a part of <i><tt class='parameter'>src_im</tt></i> onto <i><tt class='parameter'>dst_im</tt></i> starting at the x,y coordinates <i><tt class='parameter'>src_x</tt></i> , <i><tt class='parameter'>src_y </tt></i> with a width of <i><tt class='parameter'>src_w</tt></i> and a height of <i><tt class='parameter'>src_h</tt></i> . The portion defined will be copied onto the x,y coordinates, <i><tt class='parameter'>dst_x</tt></i> and <i><tt class='parameter'>dst_y</tt></i> . </p> <p class='para'> This function is identical to <a href='http://www.php.net/manual/en/function.imagecopymerge.php' class='function'>imagecopymerge()</a> except that when merging it preserves the hue of the source by converting the destination pixels to gray scale before the copy operation. </p> </div> <a name='function.imagecopymergegray.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'>dst_im</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_im</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of destination point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of destination point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_w</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_h</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source height. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pct</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>src_im</tt></i> will be changed to grayscale according to <i><tt class='parameter'>pct</tt></i> where 0 is fully grayscale and 100 is unchanged. When <i><tt class='parameter'>pct</tt></i> = 100 this function behaves identically to <a href='http://www.php.net/manual/en/function.imagecopy.php' class='function'>imagecopy()</a> for pallete images, while it implements alpha transparency for true colour images. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecopymergegray.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.imagecopymergegray.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagecopymergegray()</b> usage</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;image&amp;nbsp;instances<br /></span><span style='color: #0000BB'>$dest&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.gif'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$src&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Copy&amp;nbsp;and&amp;nbsp;merge&amp;nbsp;-&amp;nbsp;Gray&amp;nbsp;=&amp;nbsp;20%<br /></span><span style='color: #0000BB'>imagecopymergegray</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dest</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$src</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</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'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>47</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;and&amp;nbsp;free&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/gif'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagegif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dest</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dest</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$src</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="imagecopymerge" value="<div id='function.imagecopymerge' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecopymerge.php'>imagecopymerge</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.1, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecopymerge</span> &amp;mdash; <span class='dc-title'>Copy and merge part of an image</span></p> </div> <a name='function.imagecopymerge.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>imagecopymerge</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$dst_im</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$src_im</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_w</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_h</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$pct</tt></span> )</div> <p class='para rdfs-comment'> Copy a part of <i><tt class='parameter'>src_im</tt></i> onto <i><tt class='parameter'>dst_im</tt></i> starting at the x,y coordinates <i><tt class='parameter'>src_x</tt></i> , <i><tt class='parameter'>src_y </tt></i> with a width of <i><tt class='parameter'>src_w</tt></i> and a height of <i><tt class='parameter'>src_h</tt></i> . The portion defined will be copied onto the x,y coordinates, <i><tt class='parameter'>dst_x</tt></i> and <i><tt class='parameter'>dst_y</tt></i> . </p> </div> <a name='function.imagecopymerge.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'>dst_im</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_im</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of destination point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of destination point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_w</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_h</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source height. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pct</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The two images will be merged according to <i><tt class='parameter'>pct</tt></i> which can range from 0 to 100. When <i><tt class='parameter'>pct</tt></i> = 0, no action is taken, when 100 this function behaves identically to <a href='http://www.php.net/manual/en/function.imagecopy.php' class='function'>imagecopy()</a> for pallete images, while it implements alpha transparency for true colour images. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecopymerge.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.imagecopymerge.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Merging two copies of the PHP.net logo with 75% transparency</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;image&amp;nbsp;instances<br /></span><span style='color: #0000BB'>$dest&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.gif'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$src&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Copy&amp;nbsp;and&amp;nbsp;merge<br /></span><span style='color: #0000BB'>imagecopymerge</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dest</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$src</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</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'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>47</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;and&amp;nbsp;free&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/gif'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagegif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dest</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dest</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$src</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="imagecopy" value="<div id='function.imagecopy' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecopy.php'>imagecopy</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecopy</span> &amp;mdash; <span class='dc-title'>Copy part of an image</span></p> </div> <a name='function.imagecopy.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>imagecopy</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$dst_im</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$src_im</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$dst_y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_y</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_w</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$src_h</tt></span> )</div> <p class='para rdfs-comment'> Copy a part of <i><tt class='parameter'>src_im</tt></i> onto <i><tt class='parameter'>dst_im</tt></i> starting at the x,y coordinates <i><tt class='parameter'>src_x</tt></i> , <i><tt class='parameter'>src_y </tt></i> with a width of <i><tt class='parameter'>src_w</tt></i> and a height of <i><tt class='parameter'>src_h</tt></i> . The portion defined will be copied onto the x,y coordinates, <i><tt class='parameter'>dst_x</tt></i> and <i><tt class='parameter'>dst_y</tt></i> . </p> </div> <a name='function.imagecopy.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'>dst_im</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Destination image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_im</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of destination point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dst_y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of destination point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of source point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_w</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>src_h</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Source height. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecopy.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.imagecopy.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Cropping the PHP.net logo</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;image&amp;nbsp;instances<br /></span><span style='color: #0000BB'>$src&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.gif'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$dest&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>80</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>40</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Copy<br /></span><span style='color: #0000BB'>imagecopy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dest</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$src</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'>20</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>13</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>80</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>40</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;and&amp;nbsp;free&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/gif'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagegif</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dest</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dest</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$src</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecopy.gif' /> </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="imageconvolution" value="<div id='function.imageconvolution' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imageconvolution.php'>imageconvolution</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>imageconvolution</span> &amp;mdash; <span class='dc-title'>Apply a 3x3 convolution matrix, using coefficient and offset</span></p> </div> <a name='function.imageconvolution.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>imageconvolution</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$matrix</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$div</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$offset</tt></span> )</div> <p class='para rdfs-comment'> Applies a convolution matrix on the image, using the given coefficient and offset. </p> </div> <a name='function.imageconvolution.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>matrix</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A 3x3 matrix: an array of three arrays of three floats. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>div</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The divisor of the result of the convolution, used for normalization. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Color offset. </p> </dd> </dl> <p> </p> </div> <a name='function.imageconvolution.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.imageconvolution.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Embossing the PHP.net logo</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'http://www.php.net/images/php.gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$emboss&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(array(</span><span style='color: #0000BB'>2</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;array(</span><span style='color: #0000BB'>0</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'>0</span><span style='color: #007700'>),&amp;nbsp;array(</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'>1</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>imageconvolution</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$emboss</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'>127</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>null</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>9</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imageconvolution_emboss.png' /> </div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Gaussian blur</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>180</span><span style='color: #007700'>,</span><span style='color: #0000BB'>40</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Writes&amp;nbsp;the&amp;nbsp;text&amp;nbsp;and&amp;nbsp;apply&amp;nbsp;a&amp;nbsp;gaussian&amp;nbsp;blur&amp;nbsp;on&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>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: #DD0000'>'Gaussian&amp;nbsp;Blur&amp;nbsp;Text'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00ff00</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$gaussian&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(array(</span><span style='color: #0000BB'>1.0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2.0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1.0</span><span style='color: #007700'>),&amp;nbsp;array(</span><span style='color: #0000BB'>2.0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4.0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2.0</span><span style='color: #007700'>),&amp;nbsp;array(</span><span style='color: #0000BB'>1.0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2.0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1.0</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>imageconvolution</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$gaussian</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'>0</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Rewrites&amp;nbsp;the&amp;nbsp;text&amp;nbsp;for&amp;nbsp;comparison<br /></span><span style='color: #0000BB'>imagestring</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>18</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Gaussian&amp;nbsp;Blur&amp;nbsp;Text'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00ff00</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>null</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>9</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imageconvolution_gaussian.png' /> </div> </div> </div><p> </p> </div> <a name='function.imageconvolution.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 if PHP is compiled with the bundled version of the GD library.</span></p></blockquote> </div> <a name='function.imageconvolution.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.imagefilter.php' class='function' rel='rdfs-seeAlso'>imagefilter()</a> - Applies a filter to 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="imagecolortransparent" value="<div id='function.imagecolortransparent' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolortransparent.php'>imagecolortransparent</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolortransparent</span> &amp;mdash; <span class='dc-title'>Define a color as transparent</span></p> </div> <a name='function.imagecolortransparent.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>imagecolortransparent</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> ] )</div> <p class='para rdfs-comment'> Sets the transparent color in the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagecolortransparent.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecolortransparent.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The identifier of the new (or current, if none is specified) transparent color is returned. </p> </div> <a name='function.imagecolortransparent.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagecolortransparent()</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;Create&amp;nbsp;a&amp;nbsp;55x30&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>55</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$red&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Make&amp;nbsp;the&amp;nbsp;background&amp;nbsp;transparent<br /></span><span style='color: #0000BB'>imagecolortransparent</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$black</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;a&amp;nbsp;red&amp;nbsp;rectangle<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>25</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Save&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'./imagecolortransparent.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecolortransparent.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagecolortransparent.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Transparency is copied only with <a href='http://www.php.net/manual/en/function.imagecopymerge.php' class='function'>imagecopymerge()</a> and true color images, not with <a href='http://www.php.net/manual/en/function.imagecopy.php' class='function'>imagecopy()</a> or pallete images. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: The transparent color is a property of the image, transparency is not a property of the color. Once you have set a color to be the transparent color, any regions of the image in that color that were drawn previously will be transparent. <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="imagecolorstotal" value="<div id='function.imagecolorstotal' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorstotal.php'>imagecolorstotal</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorstotal</span> &amp;mdash; <span class='dc-title'>Find out the number of colors in an image&amp;#039;s palette</span></p> </div> <a name='function.imagecolorstotal.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>imagecolorstotal</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of colors in an image palette. </p> </div> <a name='function.imagecolorstotal.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> </dl> <p> </p> </div> <a name='function.imagecolorstotal.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of colors in the specified image&amp;#039;s palette or 0 for truecolor images. </p> </div> <a name='function.imagecolorstotal.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Getting total number of colors in an image using <b>imagecolorstotal()</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;Create&amp;nbsp;image&amp;nbsp;instance<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.gif'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Total&amp;nbsp;colors&amp;nbsp;in&amp;nbsp;image:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>imagecolorstotal</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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> Total colors in image: 128 </pre></div> </div> </div><p> </p> </div> <a name='function.imagecolorstotal.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.imagecolorat.php' class='function' rel='rdfs-seeAlso'>imagecolorat()</a> - Get the index of the color of a pixel</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolorsforindex.php' class='function' rel='rdfs-seeAlso'>imagecolorsforindex()</a> - Get the colors for an index</li> <li class='member'><a href='http://www.php.net/manual/en/function.imageistruecolor.php' class='function' rel='rdfs-seeAlso'>imageistruecolor()</a> - Finds whether an image is a truecolor 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="imagecolorsforindex" value="<div id='function.imagecolorsforindex' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorsforindex.php'>imagecolorsforindex</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorsforindex</span> &amp;mdash; <span class='dc-title'>Get the colors for an index</span></p> </div> <a name='function.imagecolorsforindex.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>imagecolorsforindex</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$index</tt></span> )</div> <p class='para rdfs-comment'> Gets the color for a specified index. </p> </div> <a name='function.imagecolorsforindex.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The color index. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecolorsforindex.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array with red, green, blue and alpha keys that contain the appropriate values for the specified color index. </p> </div> <a name='function.imagecolorsforindex.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagecolorsforindex()</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;an&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'nexen.png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;get&amp;nbsp;a&amp;nbsp;color<br /></span><span style='color: #0000BB'>$start_x&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>40</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$start_y&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$color_index&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorat</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$start_x</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$start_y</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;make&amp;nbsp;it&amp;nbsp;human&amp;nbsp;readable<br /></span><span style='color: #0000BB'>$color_tran&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorsforindex</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$color_index</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;what&amp;nbsp;is&amp;nbsp;it&amp;nbsp;?<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$color_tran</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 ( [red] =&amp;gt; 226 [green] =&amp;gt; 222 [blue] =&amp;gt; 252 [alpha] =&amp;gt; 0 ) </pre></div> </div> </div><p> </p> </div> <a name='function.imagecolorsforindex.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.imagecolorat.php' class='function' rel='rdfs-seeAlso'>imagecolorat()</a> - Get the index of the color of a pixel</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolorexact.php' class='function' rel='rdfs-seeAlso'>imagecolorexact()</a> - Get the index of the specified color</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="imagecolorset" value="<div id='function.imagecolorset' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorset.php'>imagecolorset</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorset</span> &amp;mdash; <span class='dc-title'>Set the color for the specified palette index</span></p> </div> <a name='function.imagecolorset.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>imagecolorset</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$index</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$red</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$green</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$blue</tt></span> )</div> <p class='para rdfs-comment'> This sets the specified index in the palette to the specified color. This is useful for creating flood-fill-like effects in palleted images without the overhead of performing the actual flood-fill. </p> </div> <a name='function.imagecolorset.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An index in the palette. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>red</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of red component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>green</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of green component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>blue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of blue component. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecolorset.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.imagecolorset.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagecolorset()</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;Create&amp;nbsp;a&amp;nbsp;300x100&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>300</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;background&amp;nbsp;to&amp;nbsp;be&amp;nbsp;red<br /></span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;the&amp;nbsp;color&amp;nbsp;index&amp;nbsp;for&amp;nbsp;the&amp;nbsp;background<br /></span><span style='color: #0000BB'>$bg&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorat</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;backgrund&amp;nbsp;to&amp;nbsp;be&amp;nbsp;blue<br /></span><span style='color: #0000BB'>imagecolorset</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$bg</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'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;the&amp;nbsp;image&amp;nbsp;to&amp;nbsp;the&amp;nbsp;browser<br />//header('Content-type:&amp;nbsp;image/png');<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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.imagecolorset.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.imagecolorat.php' class='function' rel='rdfs-seeAlso'>imagecolorat()</a> - Get the index of the color of a pixel</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="imagecolorresolvealpha" value="<div id='function.imagecolorresolvealpha' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorresolvealpha.php'>imagecolorresolvealpha</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorresolvealpha</span> &amp;mdash; <span class='dc-title'>Get the index of the specified color + alpha or its closest possible alternative</span></p> </div> <a name='function.imagecolorresolvealpha.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>imagecolorresolvealpha</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$red</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$green</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$blue</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$alpha</tt></span> )</div> <p class='para rdfs-comment'> This function is guaranteed to return a color index for a requested color, either the exact color or the closest possible alternative. </p> </div> <a name='function.imagecolorresolvealpha.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>red</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of red component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>green</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of green component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>blue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of blue component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>alpha</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A value between <i>0</i> and <i>127</i>. <i>0</i> indicates completely opaque while <i>127</i> indicates completely transparent. </p> </dd> </dl> <p> The colors parameters are integers between 0 and 255 or hexadecimals between 0x00 and 0xFF. </p> </div> <a name='function.imagecolorresolvealpha.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a color index. </p> </div> <a name='function.imagecolorresolvealpha.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Using <b>imagecoloresolvealpha()</b> to get colors from an image</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;Load&amp;nbsp;an&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'phplogo.gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;closest&amp;nbsp;colors&amp;nbsp;from&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>$colors&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array();<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorresolvealpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorresolvealpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>127</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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 ( [0] =&amp;gt; 89 [1] =&amp;gt; 85 ) </pre></div> </div> </div> </div> <a name='function.imagecolorresolvealpha.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> </div> <a name='function.imagecolorresolvealpha.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.imagecolorclosestalpha.php' class='function' rel='rdfs-seeAlso'>imagecolorclosestalpha()</a> - Get the index of the closest color to the specified color + alpha</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="imagecolorresolve" value="<div id='function.imagecolorresolve' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorresolve.php'>imagecolorresolve</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorresolve</span> &amp;mdash; <span class='dc-title'>Get the index of the specified color or its closest possible alternative</span></p> </div> <a name='function.imagecolorresolve.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>imagecolorresolve</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$red</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$green</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$blue</tt></span> )</div> <p class='para rdfs-comment'> This function is guaranteed to return a color index for a requested color, either the exact color or the closest possible alternative. </p> <p class='para'> If you created the image from a file, only colors used in the image are resolved. Colors present only in the palette are not resolved. </p> </div> <a name='function.imagecolorresolve.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>red</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of red component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>green</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of green component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>blue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of blue component. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecolorresolve.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a color index. </p> </div> <a name='function.imagecolorresolve.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Using <b>imagecoloresolve()</b> to get colors from an image</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;Load&amp;nbsp;an&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefromgif</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'phplogo.gif'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;closest&amp;nbsp;colors&amp;nbsp;from&amp;nbsp;the&amp;nbsp;image<br /></span><span style='color: #0000BB'>$colors&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array();<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorresolve</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorresolve</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>200</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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 ( [0] =&amp;gt; 89 [1] =&amp;gt; 85 ) </pre></div> </div> </div> </div> <a name='function.imagecolorresolve.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.imagecolorclosest.php' class='function' rel='rdfs-seeAlso'>imagecolorclosest()</a> - Get the index of the closest color to the specified color</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="imagecolormatch" value="<div id='function.imagecolormatch' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolormatch.php'>imagecolormatch</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolormatch</span> &amp;mdash; <span class='dc-title'>Makes the colors of the palette version of an image more closely match the true color version</span></p> </div> <a name='function.imagecolormatch.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>imagecolormatch</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image1</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image2</tt></span> )</div> <p class='para rdfs-comment'> Makes the colors of the palette version of an image more closely match the true color version. </p> </div> <a name='function.imagecolormatch.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'>image1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A truecolor image link resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>image2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A palette image link resource pointing to an image that has the same size as <i><tt class='parameter'>image1</tt></i> . </p> </dd> </dl> <p> </p> </div> <a name='function.imagecolormatch.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.imagecolormatch.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>imagecolormatch()</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;Setup&amp;nbsp;the&amp;nbsp;true&amp;nbsp;color&amp;nbsp;and&amp;nbsp;palette&amp;nbsp;images<br /></span><span style='color: #0000BB'>$im1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./gdlogo.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$im2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>imagesx</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im1</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>imagesy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im1</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Add&amp;nbsp;some&amp;nbsp;colors&amp;nbsp;to&amp;nbsp;$im2<br /></span><span style='color: #0000BB'>$colors&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;Array();<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>36</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>74</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>40</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'>240</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>82</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>84</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>63</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>44</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Match&amp;nbsp;these&amp;nbsp;colors&amp;nbsp;with&amp;nbsp;the&amp;nbsp;true&amp;nbsp;color&amp;nbsp;image<br /></span><span style='color: #0000BB'>imagecolormatch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$im2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.imagecolormatch.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 if PHP is compiled with the bundled version of the GD library.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> </div> <a name='function.imagecolormatch.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.imagecreatetruecolor.php' class='function' rel='rdfs-seeAlso'>imagecreatetruecolor()</a> - Create a new true color 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="imagecolorexactalpha" value="<div id='function.imagecolorexactalpha' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorexactalpha.php'>imagecolorexactalpha</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorexactalpha</span> &amp;mdash; <span class='dc-title'>Get the index of the specified color + alpha</span></p> </div> <a name='function.imagecolorexactalpha.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>imagecolorexactalpha</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$red</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$green</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$blue</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$alpha</tt></span> )</div> <p class='para rdfs-comment'> Returns the index of the specified color+alpha in the palette of the image. </p> </div> <a name='function.imagecolorexactalpha.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>red</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of red component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>green</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of green component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>blue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of blue component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>alpha</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A value between <i>0</i> and <i>127</i>. <i>0</i> indicates completely opaque while <i>127</i> indicates completely transparent. </p> </dd> </dl> <p> The colors parameters are integers between 0 and 255 or hexadecimals between 0x00 and 0xFF. </p> </div> <a name='function.imagecolorexactalpha.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the index of the specified color+alpha in the palette of the image, or -1 if the color does not exist in the image&amp;#039;s palette. </p> </div> <a name='function.imagecolorexactalpha.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Get colors from the GD logo</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;Setup&amp;nbsp;an&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./gdlogo.png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$colors&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;Array();<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorexactalpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorexactalpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>127</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorexactalpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>55</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorexactalpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>52</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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 ( [0] =&amp;gt; 16711680 [1] =&amp;gt; 2130706432 [2] =&amp;gt; 939524095 [3] =&amp;gt; 342163252 ) </pre></div> </div> </div> </div> <a name='function.imagecolorexactalpha.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> </div> <a name='function.imagecolorexactalpha.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.imagecolorclosestalpha.php' class='function' rel='rdfs-seeAlso'>imagecolorclosestalpha()</a> - Get the index of the closest color to the specified color + alpha</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="imagecolorexact" value="<div id='function.imagecolorexact' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorexact.php'>imagecolorexact</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorexact</span> &amp;mdash; <span class='dc-title'>Get the index of the specified color</span></p> </div> <a name='function.imagecolorexact.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>imagecolorexact</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$red</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$green</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$blue</tt></span> )</div> <p class='para rdfs-comment'> Returns the index of the specified color in the palette of the image. </p> <p class='para'> If you created the image from a file, only colors used in the image are resolved. Colors present only in the palette are not resolved. </p> </div> <a name='function.imagecolorexact.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>red</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of red component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>green</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of green component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>blue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of blue component. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecolorexact.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the index of the specified color in the palette, or -1 if the color does not exist. </p> </div> <a name='function.imagecolorexact.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Get colors from the GD logo</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;Setup&amp;nbsp;an&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'./gdlogo.png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$colors&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;Array();<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorexact</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorexact</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorexact</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>[]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorexact</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>52</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$colors</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;from&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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 ( [0] =&amp;gt; 16711680 [1] =&amp;gt; 0 [2] =&amp;gt; 16777215 [3] =&amp;gt; 6618932 ) </pre></div> </div> </div> </div> <a name='function.imagecolorexact.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.imagecolorclosest.php' class='function' rel='rdfs-seeAlso'>imagecolorclosest()</a> - Get the index of the closest color to the specified color</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="imagecolordeallocate" value="<div id='function.imagecolordeallocate' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolordeallocate.php'>imagecolordeallocate</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolordeallocate</span> &amp;mdash; <span class='dc-title'>De-allocate a color for an image</span></p> </div> <a name='function.imagecolordeallocate.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>imagecolordeallocate</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> De-allocates a color previously allocated with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a> or <a href='http://www.php.net/manual/en/function.imagecolorallocatealpha.php' class='function'>imagecolorallocatealpha()</a>. </p> </div> <a name='function.imagecolordeallocate.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The color identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecolordeallocate.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.imagecolordeallocate.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>imagecolordeallocate()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagecolordeallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</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.imagecolordeallocate.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.imagecolorallocate.php' class='function' rel='rdfs-seeAlso'>imagecolorallocate()</a> - Allocate a color for an image</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolorallocatealpha.php' class='function' rel='rdfs-seeAlso'>imagecolorallocatealpha()</a> - Allocate a color for 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="imagecolorclosestalpha" value="<div id='function.imagecolorclosestalpha' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorclosestalpha.php'>imagecolorclosestalpha</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorclosestalpha</span> &amp;mdash; <span class='dc-title'>Get the index of the closest color to the specified color + alpha</span></p> </div> <a name='function.imagecolorclosestalpha.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>imagecolorclosestalpha</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$red</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$green</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$blue</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$alpha</tt></span> )</div> <p class='para rdfs-comment'> Returns the index of the color in the palette of the image which is &amp;quot;closest&amp;quot; to the specified <acronym title='Red-Green-Blue'>RGB</acronym> value and <i><tt class='parameter'>alpha</tt></i> level. </p> </div> <a name='function.imagecolorclosestalpha.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>red</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of red component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>green</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of green component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>blue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of blue component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>alpha</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A value between <i>0</i> and <i>127</i>. <i>0</i> indicates completely opaque while <i>127</i> indicates completely transparent. </p> </dd> </dl> <p> The colors parameters are integers between 0 and 255 or hexadecimals between 0x00 and 0xFF. </p> </div> <a name='function.imagecolorclosestalpha.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the index of the closest color in the palette. </p> </div> <a name='function.imagecolorclosestalpha.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Search for a set of colors in an image</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;Start&amp;nbsp;with&amp;nbsp;an&amp;nbsp;image&amp;nbsp;and&amp;nbsp;convert&amp;nbsp;it&amp;nbsp;to&amp;nbsp;a&amp;nbsp;palette-based&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'figures/imagecolorclosest.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagetruecolortopalette</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Search&amp;nbsp;colors&amp;nbsp;(RGB)<br /></span><span style='color: #0000BB'>$colors&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>254</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>145</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>154</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>153</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>145</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>188</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>127</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>153</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>90</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>145</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>137</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>92</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>84</span><span style='color: #007700'>)<br />);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Loop&amp;nbsp;through&amp;nbsp;each&amp;nbsp;search&amp;nbsp;and&amp;nbsp;find&amp;nbsp;the&amp;nbsp;closest&amp;nbsp;color&amp;nbsp;in&amp;nbsp;the&amp;nbsp;palette.<br />//&amp;nbsp;Return&amp;nbsp;the&amp;nbsp;search&amp;nbsp;number,&amp;nbsp;the&amp;nbsp;search&amp;nbsp;RGB&amp;nbsp;and&amp;nbsp;the&amp;nbsp;converted&amp;nbsp;RGB&amp;nbsp;match<br /></span><span style='color: #007700'>foreach(</span><span style='color: #0000BB'>$colors&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'>$rgb</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorclosestalpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>3</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorsforindex</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'(</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'red'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'green'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'blue'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'alpha'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>)'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'#</span><span style='color: #0000BB'>$id</span><span style='color: #DD0000'>:&amp;nbsp;Search&amp;nbsp;(</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>]</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>3</span><span style='color: #007700'>]</span><span style='color: #DD0000'>);&amp;nbsp;Closest&amp;nbsp;match:&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'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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> #0: Search (254, 145, 154, 50); Closest match: (252, 150, 148, 0). #1: Search (153, 145, 188, 127); Closest match: (148, 150, 196, 0). #2: Search (153, 90, 145, 0); Closest match: (148, 90, 156, 0). #3: Search (255, 137, 92, 84); Closest match: (252, 150, 92, 0). </pre></div> </div> </div><p> </p> </div> <a name='function.imagecolorclosestalpha.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> </div> <a name='function.imagecolorclosestalpha.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.imagecolorexactalpha.php' class='function' rel='rdfs-seeAlso'>imagecolorexactalpha()</a> - Get the index of the specified color + alpha</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolorclosest.php' class='function' rel='rdfs-seeAlso'>imagecolorclosest()</a> - Get the index of the closest color to the specified color</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolorclosesthwb.php' class='function' rel='rdfs-seeAlso'>imagecolorclosesthwb()</a> - Get the index of the color which has the hue, white and blackness</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="imagecolorclosest" value="<div id='function.imagecolorclosest' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorclosest.php'>imagecolorclosest</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorclosest</span> &amp;mdash; <span class='dc-title'>Get the index of the closest color to the specified color</span></p> </div> <a name='function.imagecolorclosest.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>imagecolorclosest</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$red</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$green</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$blue</tt></span> )</div> <p class='para rdfs-comment'> Returns the index of the color in the palette of the image which is &amp;quot;closest&amp;quot; to the specified <acronym title='Red-Green-Blue'>RGB</acronym> value. </p> <p class='para'> The &amp;quot;distance&amp;quot; between the desired color and each color in the palette is calculated as if the <acronym title='Red-Green-Blue'>RGB</acronym> values represented points in three-dimensional space. </p> <p class='para'> If you created the image from a file, only colors used in the image are resolved. Colors present only in the palette are not resolved. </p> </div> <a name='function.imagecolorclosest.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>red</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of red component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>green</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of green component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>blue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of blue component. </p> </dd> </dl> <p> The colors parameters are integers between 0 and 255 or hexadecimals between 0x00 and 0xFF. </p> </div> <a name='function.imagecolorclosest.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the index of the closest color, in the palette of the image, to the specified one </p> </div> <a name='function.imagecolorclosest.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Search for a set of colors in an image</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;Start&amp;nbsp;with&amp;nbsp;an&amp;nbsp;image&amp;nbsp;and&amp;nbsp;convert&amp;nbsp;it&amp;nbsp;to&amp;nbsp;a&amp;nbsp;palette-based&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'figures/imagecolorclosest.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagetruecolortopalette</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Search&amp;nbsp;colors&amp;nbsp;(RGB)<br /></span><span style='color: #0000BB'>$colors&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>254</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>145</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>154</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>153</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>145</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>188</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>153</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>90</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>145</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>137</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>92</span><span style='color: #007700'>)<br />);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Loop&amp;nbsp;through&amp;nbsp;each&amp;nbsp;search&amp;nbsp;and&amp;nbsp;find&amp;nbsp;the&amp;nbsp;closest&amp;nbsp;color&amp;nbsp;in&amp;nbsp;the&amp;nbsp;palette.<br />//&amp;nbsp;Return&amp;nbsp;the&amp;nbsp;search&amp;nbsp;number,&amp;nbsp;the&amp;nbsp;search&amp;nbsp;RGB&amp;nbsp;and&amp;nbsp;the&amp;nbsp;converted&amp;nbsp;RGB&amp;nbsp;match<br /></span><span style='color: #007700'>foreach(</span><span style='color: #0000BB'>$colors&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'>$rgb</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorclosest</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorsforindex</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'(</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'red'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'green'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'blue'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>)'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'#</span><span style='color: #0000BB'>$id</span><span style='color: #DD0000'>:&amp;nbsp;Search&amp;nbsp;(</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>]</span><span style='color: #DD0000'>);&amp;nbsp;Closest&amp;nbsp;match:&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'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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> #0: Search (254, 145, 154); Closest match: (252, 150, 148). #1: Search (153, 145, 188); Closest match: (148, 150, 196). #2: Search (153, 90, 145); Closest match: (148, 90, 156). #3: Search (255, 137, 92); Closest match: (252, 150, 92). </pre></div> </div> </div><p> </p> </div> <a name='function.imagecolorclosest.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.imagecolorexact.php' class='function' rel='rdfs-seeAlso'>imagecolorexact()</a> - Get the index of the specified color</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolorclosestalpha.php' class='function' rel='rdfs-seeAlso'>imagecolorclosestalpha()</a> - Get the index of the closest color to the specified color + alpha</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolorclosesthwb.php' class='function' rel='rdfs-seeAlso'>imagecolorclosesthwb()</a> - Get the index of the color which has the hue, white and blackness</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="imagecolorat" value="<div id='function.imagecolorat' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorat.php'>imagecolorat</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorat</span> &amp;mdash; <span class='dc-title'>Get the index of the color of a pixel</span></p> </div> <a name='function.imagecolorat.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>imagecolorat</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> )</div> <p class='para rdfs-comment'> Returns the index of the color of the pixel at the specified location in the image specified by <i><tt class='parameter'>image</tt></i> . </p> <p class='para'> If PHP is compiled against GD library 2.0 or higher and the image is a truecolor image, this function returns the RGB value of that pixel as integer. Use bitshifting and masking to access the distinct red, green and blue component values: </p> </div> <a name='function.imagecolorat.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of the point. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of the point. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecolorat.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the index of the color. </p> </div> <a name='function.imagecolorat.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Access distinct RGB values</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rgb&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorat</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>15</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'>$rgb&amp;nbsp;</span><span style='color: #007700'>&amp;gt;&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>16</span><span style='color: #007700'>)&amp;nbsp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>0xFF</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'>$rgb&amp;nbsp;</span><span style='color: #007700'>&amp;gt;&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>8</span><span style='color: #007700'>)&amp;nbsp;&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>0xFF</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'>$rgb&amp;nbsp;</span><span style='color: #007700'>&amp;amp;&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$g</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$b</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> int(119) int(123) int(180) </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Human-readable RGB values using <a href='http://www.php.net/manual/en/function.imagecolorsforindex.php' class='function'>imagecolorsforindex()</a></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php.png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rgb&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorat</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>15</span><span style='color: #007700'>);<br /><br />list(</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$g</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'>$alpha</span><span style='color: #007700'>)&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorsforindex</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$rgb</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$g</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'>$alpha</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> int(119) int(123) int(180) int(127) </pre></div> </div> </div><p> </p> </div> <a name='function.imagecolorat.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.imagecolorset.php' class='function' rel='rdfs-seeAlso'>imagecolorset()</a> - Set the color for the specified palette index</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolorsforindex.php' class='function' rel='rdfs-seeAlso'>imagecolorsforindex()</a> - Get the colors for an index</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="imagecolorallocatealpha" value="<div id='function.imagecolorallocatealpha' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorallocatealpha.php'>imagecolorallocatealpha</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.2, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorallocatealpha</span> &amp;mdash; <span class='dc-title'>Allocate a color for an image</span></p> </div> <a name='function.imagecolorallocatealpha.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>imagecolorallocatealpha</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$red</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$green</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$blue</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$alpha</tt></span> )</div> <p class='para rdfs-comment'> <b>imagecolorallocatealpha()</b> behaves identically to <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a> with the addition of the transparency parameter <i><tt class='parameter'>alpha</tt></i> . </p> </div> <a name='function.imagecolorallocatealpha.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>red</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of red component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>green</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of green component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>blue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of blue component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>alpha</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A value between <i>0</i> and <i>127</i>. <i>0</i> indicates completely opaque while <i>127</i> indicates completely transparent. </p> </dd> </dl> <p> The colors parameters are integers between 0 and 255 or hexadecimals between 0x00 and 0xFF. </p> </div> <a name='function.imagecolorallocatealpha.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A color identifier or <b><tt class='constant'>FALSE</tt></b> if the allocation failed. </p> </div> <a name='function.imagecolorallocatealpha.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'>Prior to 5.1.3</td> <td align='left'> Returns -1 if the allocation failed. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imagecolorallocatealpha.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Example of using <b>imagecolorallocatealpha()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$size&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>300</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$image</span><span style='color: #007700'>=</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$size</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$size</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;something&amp;nbsp;to&amp;nbsp;get&amp;nbsp;a&amp;nbsp;white&amp;nbsp;background&amp;nbsp;with&amp;nbsp;black&amp;nbsp;border<br /></span><span style='color: #0000BB'>$back&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$border&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>$size&amp;nbsp;</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'>$size&amp;nbsp;</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'>$back</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagerectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>$size&amp;nbsp;</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'>$size&amp;nbsp;</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'>$border</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$yellow_x&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$yellow_y&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$red_x&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>120</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$red_y&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>165</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$blue_x&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>187</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$blue_y&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>125</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$radius&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>150</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;allocate&amp;nbsp;colors&amp;nbsp;with&amp;nbsp;alpha&amp;nbsp;values<br /></span><span style='color: #0000BB'>$yellow&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocatealpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>75</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$red&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocatealpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>75</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$blue&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocatealpha</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;drawing&amp;nbsp;3&amp;nbsp;overlapped&amp;nbsp;circle<br /></span><span style='color: #0000BB'>imagefilledellipse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$yellow_x</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$yellow_y</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$radius</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$radius</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$yellow</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagefilledellipse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red_x</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red_y</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$radius</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$radius</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagefilledellipse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$blue_x</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$blue_y</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$radius</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$radius</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$blue</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;don't&amp;nbsp;forget&amp;nbsp;to&amp;nbsp;output&amp;nbsp;a&amp;nbsp;correct&amp;nbsp;header!<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;and&amp;nbsp;finally,&amp;nbsp;output&amp;nbsp;the&amp;nbsp;result<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecolorallocatealpha.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagecolorallocatealpha.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</span></p></blockquote> </div> <a name='function.imagecolorallocatealpha.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.imagecolorallocate.php' class='function' rel='rdfs-seeAlso'>imagecolorallocate()</a> - Allocate a color for an image</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolordeallocate.php' class='function' rel='rdfs-seeAlso'>imagecolordeallocate()</a> - De-allocate a color for 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="imagecolorallocate" value="<div id='function.imagecolorallocate' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecolorallocate.php'>imagecolorallocate</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecolorallocate</span> &amp;mdash; <span class='dc-title'>Allocate a color for an image</span></p> </div> <a name='function.imagecolorallocate.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>imagecolorallocate</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$red</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$green</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$blue</tt></span> )</div> <p class='para rdfs-comment'> Returns a color identifier representing the color composed of the given <acronym title='Red-Green-Blue'>RGB</acronym> components. </p> <p class='para'> <b>imagecolorallocate()</b> must be called to create each color that is to be used in the image represented by <i><tt class='parameter'>image</tt></i> . </p> <blockquote><p><b class='note'>Note</b>: The first call to <b>imagecolorallocate()</b> fills the background color in palette-based images - images created using <a href='http://www.php.net/manual/en/function.imagecreate.php' class='function'>imagecreate()</a>. <br /> </p></blockquote> </div> <a name='function.imagecolorallocate.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>red</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of red component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>green</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of green component. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>blue</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Value of blue component. </p> </dd> </dl> <p> These parameters are integers between 0 and 255 or hexadecimals between 0x00 and 0xFF. </p> </div> <a name='function.imagecolorallocate.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A color identifier or <b><tt class='constant'>FALSE</tt></b> if the allocation failed. </p> </div> <a name='function.imagecolorallocate.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'>Prior to 5.1.3</td> <td align='left'> Returns -1 if the allocation failed. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.imagecolorallocate.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagecolorallocate()</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 />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;sets&amp;nbsp;background&amp;nbsp;to&amp;nbsp;red<br /></span><span style='color: #0000BB'>$background&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;sets&amp;nbsp;some&amp;nbsp;colors<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;hexadecimal&amp;nbsp;way<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0xFF</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0x00</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.imagecolorallocate.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.imagecolorallocatealpha.php' class='function' rel='rdfs-seeAlso'>imagecolorallocatealpha()</a> - Allocate a color for an image</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagecolordeallocate.php' class='function' rel='rdfs-seeAlso'>imagecolordeallocate()</a> - De-allocate a color for 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="imagecharup" value="<div id='function.imagecharup' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagecharup.php'>imagecharup</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagecharup</span> &amp;mdash; <span class='dc-title'>Draw a character vertically</span></p> </div> <a name='function.imagecharup.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>imagecharup</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$font</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$c</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> Draws the character <i><tt class='parameter'>c</tt></i> vertically at the specified coordinate on the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.imagecharup.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> font</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Can be 1, 2, 3, 4, 5 for built-in fonts in latin2 encoding (where higher numbers corresponding to larger fonts) or any of your own font identifiers registered with <a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function'>imageloadfont()</a>. </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of the start. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of the start. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>c</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The character to draw. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagecharup.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.imagecharup.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagecharup()</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 />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Note&amp;nbsp;that&amp;nbsp;the&amp;nbsp;first&amp;nbsp;letter&amp;nbsp;is&amp;nbsp;a&amp;nbsp;N'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$bg&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;prints&amp;nbsp;a&amp;nbsp;black&amp;nbsp;'Z'&amp;nbsp;on&amp;nbsp;a&amp;nbsp;white&amp;nbsp;background<br /></span><span style='color: #0000BB'>imagecharup</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$black</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagecharup.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagecharup.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.imagechar.php' class='function' rel='rdfs-seeAlso'>imagechar()</a> - Draw a character horizontally</li> <li class='member'><a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function' rel='rdfs-seeAlso'>imageloadfont()</a> - Load a new font</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="imagechar" value="<div id='function.imagechar' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagechar.php'>imagechar</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagechar</span> &amp;mdash; <span class='dc-title'>Draw a character horizontally</span></p> </div> <a name='function.imagechar.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>imagechar</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$font</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$y</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$c</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> <b>imagechar()</b> draws the first character of <i><tt class='parameter'>c</tt></i> in the image identified by <i><tt class='parameter'>image</tt></i> with its upper-left at <i><tt class='parameter'>x</tt></i> ,<i><tt class='parameter'>y</tt></i> (top left is 0, 0) with the color <i><tt class='parameter'>color</tt></i> . </p> </div> <a name='function.imagechar.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'> font</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Can be 1, 2, 3, 4, 5 for built-in fonts in latin2 encoding (where higher numbers corresponding to larger fonts) or any of your own font identifiers registered with <a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function'>imageloadfont()</a>. </p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of the start. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of the start. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>c</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The character to draw. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagechar.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.imagechar.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>imagechar()</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 />$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'PHP'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$bg&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$black&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>0</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;prints&amp;nbsp;a&amp;nbsp;black&amp;nbsp;'P'&amp;nbsp;in&amp;nbsp;the&amp;nbsp;top&amp;nbsp;left&amp;nbsp;corner<br /></span><span style='color: #0000BB'>imagechar</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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'>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'>$string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$black</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagechar.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagechar.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.imagecharup.php' class='function' rel='rdfs-seeAlso'>imagecharup()</a> - Draw a character vertically</li> <li class='member'><a href='http://www.php.net/manual/en/function.imageloadfont.php' class='function' rel='rdfs-seeAlso'>imageloadfont()</a> - Load a new font</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="imagearc" value="<div id='function.imagearc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagearc.php'>imagearc</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>imagearc</span> &amp;mdash; <span class='dc-title'>Draws an arc</span></p> </div> <a name='function.imagearc.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>imagearc</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cx</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cy</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$width</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$height</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'>$end</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$color</tt></span> )</div> <p class='para rdfs-comment'> <b>imagearc()</b> draws an arc of circle centered at the given coordinates. </p> </div> <a name='function.imagearc.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cx</tt></i> </span> </dt><dd class='listitem'> <p class='para'> x-coordinate of the center. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cy</tt></i> </span> </dt><dd class='listitem'> <p class='para'> y-coordinate of the center. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>width</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The arc width. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>height</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The arc height. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>start</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The arc start angle, in degrees. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>end</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The arc end angle, in degrees. 0&amp;Acirc;&amp;deg; is located at the three-o&amp;#039;clock position, and the arc is drawn clockwise. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>color</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A color identifier created with <a href='http://www.php.net/manual/en/function.imagecolorallocate.php' class='function'>imagecolorallocate()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagearc.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.imagearc.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Drawing a circle with <b>imagearc()</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;create&amp;nbsp;a&amp;nbsp;200*200&amp;nbsp;image<br /></span><span style='color: #0000BB'>$img&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;allocate&amp;nbsp;some&amp;nbsp;colors<br /></span><span style='color: #0000BB'>$white&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$red&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$green&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$blue&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;draw&amp;nbsp;the&amp;nbsp;head<br /></span><span style='color: #0000BB'>imagearc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>360</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$white</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//&amp;nbsp;mouth<br /></span><span style='color: #0000BB'>imagearc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>150</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>25</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>155</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//&amp;nbsp;left&amp;nbsp;and&amp;nbsp;then&amp;nbsp;the&amp;nbsp;right&amp;nbsp;eye<br /></span><span style='color: #0000BB'>imagearc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>60</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>360</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$green</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagearc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>140</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>75</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>50</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>360</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$blue</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;output&amp;nbsp;image&amp;nbsp;in&amp;nbsp;the&amp;nbsp;browser<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;free&amp;nbsp;memory<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$img</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imagearc.png' /> </div> </div> </div><p> </p> </div> <a name='function.imagearc.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.imagefilledarc.php' class='function' rel='rdfs-seeAlso'>imagefilledarc()</a> - Draw a partial arc and fill it</li> <li class='member'><a href='http://www.php.net/manual/en/function.imageellipse.php' class='function' rel='rdfs-seeAlso'>imageellipse()</a> - Draw an ellipse</li> <li class='member'><a href='http://www.php.net/manual/en/function.imagefilledellipse.php' class='function' rel='rdfs-seeAlso'>imagefilledellipse()</a> - Draw a filled ellipse</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="imageantialias" value="<div id='function.imageantialias' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imageantialias.php'>imageantialias</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.2, PHP 5)</p><p class='refpurpose'><span class='refname'>imageantialias</span> &amp;mdash; <span class='dc-title'>Should antialias functions be used or not</span></p> </div> <a name='function.imageantialias.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>imageantialias</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$enabled</tt></span> )</div> <p class='para rdfs-comment'> Activate the fast drawing antialiased methods for lines and wired polygons. It does not support alpha components. It works using a direct blend operation. It works only with truecolor images. </p> <p class='para'> Thickness and styled are not supported. </p> <p class='para'> Using antialiased primitives with transparent background color can end with some unexpected results. The blend method uses the background color as any other colors. The lack of alpha component support does not allow an alpha based antialiasing method. </p> </div> <a name='function.imageantialias.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>enabled</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whether to enable antialiasing or not. </p> </dd> </dl> <p> </p> </div> <a name='function.imageantialias.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.imageantialias.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A comparison of two lines, one with anti-aliasing switched on</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;Setup&amp;nbsp;an&amp;nbsp;anti-aliased&amp;nbsp;image&amp;nbsp;and&amp;nbsp;a&amp;nbsp;normal&amp;nbsp;image<br /></span><span style='color: #0000BB'>$aa&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>400</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$normal&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Switch&amp;nbsp;antialiasing&amp;nbsp;on&amp;nbsp;for&amp;nbsp;one&amp;nbsp;image<br /></span><span style='color: #0000BB'>imageantialias</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$aa</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;Allocate&amp;nbsp;colors<br /></span><span style='color: #0000BB'>$red&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$normal</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>);<br /></span><span style='color: #0000BB'>$red_aa&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$aa</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Draw&amp;nbsp;two&amp;nbsp;lines,&amp;nbsp;one&amp;nbsp;with&amp;nbsp;AA&amp;nbsp;enabled<br /></span><span style='color: #0000BB'>imageline</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$normal</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'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imageline</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$aa</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'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$red_aa</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Merge&amp;nbsp;the&amp;nbsp;two&amp;nbsp;images&amp;nbsp;side&amp;nbsp;by&amp;nbsp;side&amp;nbsp;for&amp;nbsp;output&amp;nbsp;(AA:&amp;nbsp;left,&amp;nbsp;Normal:&amp;nbsp;Right)<br /></span><span style='color: #0000BB'>imagecopymerge</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$aa</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$normal</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</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'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>200</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output&amp;nbsp;image<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$aa</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$aa</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$normal</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='mediaobject'> <div class='imageobject'> <img src='images/21009b70229598c6a80eef8b45bf282b-imageantialias.png' /> </div> </div> </div><p> </p> </div> <a name='function.imageantialias.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 if PHP is compiled with the bundled version of the GD library.</span></p></blockquote> </div> <a name='function.imageantialias.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.imagecreatetruecolor.php' class='function' rel='rdfs-seeAlso'>imagecreatetruecolor()</a> - Create a new true color 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="imagealphablending" value="<div id='function.imagealphablending' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.imagealphablending.php'>imagealphablending</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>imagealphablending</span> &amp;mdash; <span class='dc-title'>Set the blending mode for an image</span></p> </div> <a name='function.imagealphablending.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>imagealphablending</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></span> , <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$blendmode</tt></span> )</div> <p class='para rdfs-comment'> <b>imagealphablending()</b> allows for two different modes of drawing on truecolor images. In blending mode, the alpha channel component of the color supplied to all drawing function, such as <a href='http://www.php.net/manual/en/function.imagesetpixel.php' class='function'>imagesetpixel()</a> determines how much of the underlying color should be allowed to shine through. As a result, gd automatically blends the existing color at that point with the drawing color, and stores the result in the image. The resulting pixel is opaque. In non-blending mode, the drawing color is copied literally with its alpha channel information, replacing the destination pixel. Blending mode is not available when drawing on palette images. </p> </div> <a name='function.imagealphablending.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>blendmode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whether to enable the blending mode or not. Default to <b><tt class='constant'>FALSE</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.imagealphablending.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.imagealphablending.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 <b>imagealphablending()</b> usage 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;Create&amp;nbsp;image<br /></span><span style='color: #0000BB'>$im&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatetruecolor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;alphablending&amp;nbsp;to&amp;nbsp;on<br /></span><span style='color: #0000BB'>imagealphablending</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</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;Draw&amp;nbsp;a&amp;nbsp;square<br /></span><span style='color: #0000BB'>imagefilledrectangle</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>70</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>70</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>imagecolorallocate</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>255</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'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Output<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/png'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>imagepng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$im</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.imagealphablending.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function requires GD 2.0.1 or later (2.0.28 or later is recommended).</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="image2wbmp" value="<div id='function.image2wbmp' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.image2wbmp.php'>image2wbmp</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>image2wbmp</span> &amp;mdash; <span class='dc-title'>Output image to browser or file</span></p> </div> <a name='function.image2wbmp.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>image2wbmp</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$image</tt></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'>$threshold</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>image2wbmp()</b> outputs or save a <acronym title='Wireless Bitmap'>WBMP</acronym> version of the given <i><tt class='parameter'>image</tt></i> . </p> </div> <a name='function.image2wbmp.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'> image</tt></i> </span> </dt><dd class='listitem'> <p class='para'>An image resource, returned by one of the image creation functions, such as <a href='http://www.php.net/manual/en/function.imagecreatetruecolor.php' class='function'>imagecreatetruecolor()</a>.</p></dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Path to the saved file. If not given, the raw image stream will be outputted directly. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>threshold</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Threshold value, between 0 and 255 (inclusive). </p> </dd> </dl> <p> </p> </div> <a name='function.image2wbmp.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.image2wbmp.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>image2wbmp()</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'>'php.png'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$image&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>imagecreatefrompng</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$file</span><span style='color: #007700'>);<br /><br /></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'>.&amp;nbsp;</span><span style='color: #0000BB'>image_type_to_mime_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>IMAGETYPE_WBMP</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>image2wbmp</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;output&amp;nbsp;the&amp;nbsp;stream&amp;nbsp;directly<br /></span><span style='color: #0000BB'>imagedestroy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$image</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.image2wbmp.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: WBMP support is only available if PHP was compiled against GD-1.8 or later. <br /> </p></blockquote> </div> <a name='function.image2wbmp.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.imagewbmp.php' class='function' rel='rdfs-seeAlso'>imagewbmp()</a> - Output image to browser or file</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="ignore_user_abort" value="<div id='function.ignore-user-abort' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ignore-user-abort.php'>ignore_user_abort</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ignore_user_abort</span> &amp;mdash; <span class='dc-title'>Set whether a client disconnect should abort script execution</span></p> </div> <a name='function.ignore-user-abort.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>ignore_user_abort</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$value</tt></span> ] )</div> <p class='para rdfs-comment'> Sets whether a client disconnect should cause a script to be aborted. </p> </div> <a name='function.ignore-user-abort.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'>value</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If set, this function will set the <a href='http://www.php.net/manual/en/misc.configuration.php#ini.ignore-user-abort' class='link'>ignore_user_abort</a> ini setting to the given <i><tt class='parameter'>value</tt></i> . If not, this function will only return the previous setting without changing it. </p> </dd> </dl> <p> </p> </div> <a name='function.ignore-user-abort.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the previous setting, as an integer. </p> </div> <a name='function.ignore-user-abort.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>ignore_user_abort()</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;Ignore&amp;nbsp;user&amp;nbsp;aborts&amp;nbsp;and&amp;nbsp;allow&amp;nbsp;the&amp;nbsp;script<br />//&amp;nbsp;to&amp;nbsp;run&amp;nbsp;forever<br /></span><span style='color: #0000BB'>ignore_user_abort</span><span style='color: #007700'>(</span><span style='color: #0000BB'>true</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>set_time_limit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Testing&amp;nbsp;connection&amp;nbsp;handling&amp;nbsp;in&amp;nbsp;PHP'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Run&amp;nbsp;a&amp;nbsp;pointless&amp;nbsp;loop&amp;nbsp;that&amp;nbsp;sometime&amp;nbsp;<br />//&amp;nbsp;hopefully&amp;nbsp;will&amp;nbsp;make&amp;nbsp;us&amp;nbsp;click&amp;nbsp;away&amp;nbsp;from&amp;nbsp;<br />//&amp;nbsp;page&amp;nbsp;or&amp;nbsp;click&amp;nbsp;the&amp;nbsp;'Stop'&amp;nbsp;button.<br /></span><span style='color: #007700'>while(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Did&amp;nbsp;the&amp;nbsp;connection&amp;nbsp;fail?<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>connection_status</span><span style='color: #007700'>()&amp;nbsp;!=&amp;nbsp;</span><span style='color: #0000BB'>CONNECTION_NORMAL</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;break;<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;Sleep&amp;nbsp;for&amp;nbsp;10&amp;nbsp;seconds<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>sleep</span><span style='color: #007700'>(</span><span style='color: #0000BB'>10</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;If&amp;nbsp;this&amp;nbsp;is&amp;nbsp;reached,&amp;nbsp;then&amp;nbsp;the&amp;nbsp;'break'&amp;nbsp;<br />//&amp;nbsp;was&amp;nbsp;triggered&amp;nbsp;from&amp;nbsp;inside&amp;nbsp;the&amp;nbsp;while&amp;nbsp;loop<br /><br />//&amp;nbsp;So&amp;nbsp;here&amp;nbsp;we&amp;nbsp;can&amp;nbsp;log,&amp;nbsp;or&amp;nbsp;perform&amp;nbsp;any&amp;nbsp;other&amp;nbsp;tasks<br />//&amp;nbsp;we&amp;nbsp;need&amp;nbsp;without&amp;nbsp;actually&amp;nbsp;being&amp;nbsp;dependent&amp;nbsp;on&amp;nbsp;the&amp;nbsp;<br />//&amp;nbsp;browser.<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ignore-user-abort.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <p class='para'> PHP will not detect that the user has aborted the connection until an attempt is made to send information to the client. Simply using an echo statement does not guarantee that information is sent, see <a href='http://www.php.net/manual/en/function.flush.php' class='function'>flush()</a>. </p> </div> <a name='function.ignore-user-abort.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.connection-aborted.php' class='function' rel='rdfs-seeAlso'>connection_aborted()</a> - Check whether client disconnected</li> <li class='member'><a href='http://www.php.net/manual/en/function.connection-status.php' class='function' rel='rdfs-seeAlso'>connection_status()</a> - Returns connection status bitfield</li> <li class='member'> <a href='http://www.php.net/manual/en/features.connection-handling.php' class='link'>Connection Handling</a> for a complete description of connection handling in PHP. </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="idate" value="<div id='function.idate' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.idate.php'>idate</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>idate</span> &amp;mdash; <span class='dc-title'>Format a local time/date as integer</span></p> </div> <a name='function.idate.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>idate</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$format</tt></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'> Returns a number formatted according to the given format string using the given integer <i><tt class='parameter'>timestamp</tt></i> or the current local time if no timestamp is given. In other words, <i><tt class='parameter'>timestamp</tt></i> is optional and defaults to the value of <a href='http://www.php.net/manual/en/function.time.php' class='function'>time()</a>. </p> <p class='para'> Unlike the function <a href='http://www.php.net/manual/en/function.date.php' class='function'>date()</a>, <b>idate()</b> accepts just one char in the <i><tt class='parameter'>format</tt></i> parameter. </p> </div> <a name='function.idate.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'>format</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p><table class='doctable table'> <caption><b>The following characters are recognized in the <i><tt class='parameter'>format</tt></i> parameter string</b></caption> <thead valign='middle'> <tr valign='middle'> <th><i><tt class='parameter'>format</tt></i> character</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><i>B</i></td> <td align='left'>Swatch Beat/Internet Time</td> </tr> <tr valign='middle'> <td align='left'><i>d</i></td> <td align='left'>Day of the month</td> </tr> <tr valign='middle'> <td align='left'><i>h</i></td> <td align='left'>Hour (12 hour format)</td> </tr> <tr valign='middle'> <td align='left'><i>H</i></td> <td align='left'>Hour (24 hour format)</td> </tr> <tr valign='middle'> <td align='left'><i>i</i></td> <td align='left'>Minutes</td> </tr> <tr valign='middle'> <td align='left'><i>I</i> (uppercase i)</td> <td align='left'>returns <i>1</i> if DST is activated, <i>0</i> otherwise</td> </tr> <tr valign='middle'> <td align='left'><i>L</i> (uppercase l)</td> <td align='left'>returns <i>1</i> for leap year, <i>0</i> otherwise</td> </tr> <tr valign='middle'> <td align='left'><i>m</i></td> <td align='left'>Month number</td> </tr> <tr valign='middle'> <td align='left'><i>s</i></td> <td align='left'>Seconds</td> </tr> <tr valign='middle'> <td align='left'><i>t</i></td> <td align='left'>Days in current month</td> </tr> <tr valign='middle'> <td align='left'><i>U</i></td> <td align='left'>Seconds since the Unix Epoch - January 1 1970 00:00:00 UTC - this is the same as <a href='http://www.php.net/manual/en/function.time.php' class='function'>time()</a></td> </tr> <tr valign='middle'> <td align='left'><i>w</i></td> <td align='left'>Day of the week (<i>0</i> on Sunday)</td> </tr> <tr valign='middle'> <td align='left'><i>W</i></td> <td align='left'>ISO-8601 week number of year, weeks starting on Monday</td> </tr> <tr valign='middle'> <td align='left'><i>y</i></td> <td align='left'>Year (1 or 2 digits - check note below)</td> </tr> <tr valign='middle'> <td align='left'><i>Y</i></td> <td align='left'>Year (4 digits)</td> </tr> <tr valign='middle'> <td align='left'><i>z</i></td> <td align='left'>Day of the year</td> </tr> <tr valign='middle'> <td align='left'><i>Z</i></td> <td align='left'>Timezone offset in seconds</td> </tr> </tbody> </table> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timestamp</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional <i><tt class='parameter'>timestamp</tt></i> parameter is an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> Unix timestamp that defaults to the current local time if a <i><tt class='parameter'>timestamp</tt></i> is not given. In other words, it defaults to the value of <a href='http://www.php.net/manual/en/function.time.php' class='function'>time()</a>. </p></dd> </dl> <p> </p> </div> <a name='function.idate.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.integer.php' class='type integer'>integer</a>. </p> <p class='para'> As <b>idate()</b> always returns an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> and as they can&amp;#039;t start with a &amp;quot;0&amp;quot;, <b>idate()</b> may return fewer digits than you would expect. See the example below. </p> </div> <a name='function.idate.errors'></a><div class='refsect1 errors'> <h3 class='title'>Errors/Exceptions</h3> <p class='para'> Every call to a date/time function will generate a <b><tt class='constant'>E_NOTICE</tt></b> if the time zone is not valid, and/or a <b><tt class='constant'>E_STRICT</tt></b> or <b><tt class='constant'>E_WARNING</tt></b> message if using the system settings or the <var class='varname'>TZ</var> environment variable. See also <a href='http://www.php.net/manual/en/function.date-default-timezone-set.php' class='function'>date_default_timezone_set()</a></p> </div> <a name='function.idate.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.1.0</td><td align='left'><p class='para'> Now issues the <b><tt class='constant'>E_STRICT</tt></b> and <b><tt class='constant'>E_NOTICE</tt></b> time zone errors.</p></td></tr> </tbody> </table> <p> </p> </div> <a name='function.idate.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>idate()</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 />$timestamp&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>strtotime</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'1st&amp;nbsp;January&amp;nbsp;2004'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//1072915200<br /><br />//&amp;nbsp;this&amp;nbsp;prints&amp;nbsp;the&amp;nbsp;year&amp;nbsp;in&amp;nbsp;a&amp;nbsp;two&amp;nbsp;digit&amp;nbsp;format<br />//&amp;nbsp;however,&amp;nbsp;as&amp;nbsp;this&amp;nbsp;would&amp;nbsp;start&amp;nbsp;with&amp;nbsp;a&amp;nbsp;'0',&amp;nbsp;it<br />//&amp;nbsp;only&amp;nbsp;prints&amp;nbsp;'4'<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>idate</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'y'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$timestamp</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.idate.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.date.php' class='function' rel='rdfs-seeAlso'>date()</a> - Format a local time/date</li> <li class='member'><a href='http://www.php.net/manual/en/function.time.php' class='function' rel='rdfs-seeAlso'>time()</a> - Return current 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="hypot" value="<div id='function.hypot' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.hypot.php'>hypot</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.1.0, PHP 5)</p><p class='refpurpose'><span class='refname'>hypot</span> &amp;mdash; <span class='dc-title'> Calculate the length of the hypotenuse of a right-angle triangle </span></p> </div> <a name='function.hypot.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>float</span> <span class='methodname'><b>hypot</b></span> ( <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$x</tt></span> , <span class='methodparam'><span class='type'>float</span> <tt class='parameter'>$y</tt></span> )</div> <p class='para rdfs-comment'> <b>hypot()</b> returns the length of the hypotenuse of a right-angle triangle with sides of length <i><tt class='parameter'>x</tt></i> and <i><tt class='parameter'>y</tt></i> , or the distance of the point (<i><tt class='parameter'>x</tt></i> , <i><tt class='parameter'>y</tt></i> ) from the origin. This is equivalent to <i>sqrt(x*x + y*y)</i>. </p> </div> <a name='function.hypot.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'>x</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Length of first side </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>y</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Length of second side </p> </dd> </dl> <p> </p> </div> <a name='function.hypot.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Calculated length of the hypotenuse </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="http_build_query" value="<div id='function.http-build-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.http-build-query.php'>http_build_query</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>http_build_query</span> &amp;mdash; <span class='dc-title'>Generate URL-encoded query string</span></p> </div> <a name='function.http-build-query.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>http_build_query</b></span> ( <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$formdata</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$numeric_prefix</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$arg_separator</tt></span> ]] )</div> <p class='para rdfs-comment'> Generates a URL-encoded query string from the associative (or indexed) array provided. </p> </div> <a name='function.http-build-query.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'>formdata</tt></i> </span> </dt><dd class='listitem'> <p class='para'> May be an array or object containing properties. </p> <p class='para'> The array form may be a simple one-dimensional structure, or an array of arrays (who in turn may contain other arrays). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>numeric_prefix</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If numeric indices are used in the base array and this parameter is provided, it will be prepended to the numeric index for elements in the base array only. </p> <p class='para'> This is meant to allow for legal variable names when the data is decoded by PHP or another CGI application later on. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>arg_separator</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <a href='http://www.php.net/manual/en/ini.core.php#ini.arg-separator.output' class='link'>arg_separator.output</a> is used to separate arguments, unless this parameter is specified, and is then used. </p> </dd> </dl> <p> </p> </div> <a name='function.http-build-query.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a URL-encoded string. </p> </div> <a name='function.http-build-query.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.1.2</td> <td align='left'> The <i><tt class='parameter'>arg_separator</tt></i> parameter was added. </td> </tr> <tr valign='middle'> <td align='left'>5.1.3</td> <td align='left'> Square brackets are escaped. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.http-build-query.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <div class='example'> <p><b>Example #1 Simple usage of <b>http_build_query()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'foo'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'bar'</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;</span><span style='color: #DD0000'>'baz'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'boom'</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;</span><span style='color: #DD0000'>'cow'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'milk'</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;</span><span style='color: #DD0000'>'php'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'hypertext&amp;nbsp;processor'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>http_build_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;foo=bar&amp;amp;baz=boom&amp;amp;cow=milk&amp;amp;php=hypertext+processor<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>http_build_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'&amp;amp;amp;'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;foo=bar&amp;amp;amp;baz=boom&amp;amp;amp;cow=milk&amp;amp;amp;php=hypertext+processor<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> <div class='example'> <p><b>Example #2 <b>http_build_query()</b> with numerically index elements.</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'foo'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'bar'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'baz'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'boom'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'cow'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'milk'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'php'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'hypertext&amp;nbsp;processor'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>http_build_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</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'>http_build_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'myvar_'</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=foo&amp;amp;1=bar&amp;amp;2=baz&amp;amp;3=boom&amp;amp;cow=milk&amp;amp;php=hypertext+processor myvar_0=foo&amp;amp;myvar_1=bar&amp;amp;myvar_2=baz&amp;amp;myvar_3=boom&amp;amp;cow=milk&amp;amp;php=hypertext+processor </pre></div> </div> </div> <div class='example'> <p><b>Example #3 <b>http_build_query()</b> with complex arrays</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'user'</span><span style='color: #007700'>=&amp;gt;array(</span><span style='color: #DD0000'>'name'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'Bob&amp;nbsp;Smith'</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'age'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #0000BB'>47</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'sex'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'M'</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'dob'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'5/12/1956'</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;</span><span style='color: #DD0000'>'pastimes'</span><span style='color: #007700'>=&amp;gt;array(</span><span style='color: #DD0000'>'golf'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'opera'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'poker'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'rap'</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;</span><span style='color: #DD0000'>'children'</span><span style='color: #007700'>=&amp;gt;array(</span><span style='color: #DD0000'>'bobby'</span><span style='color: #007700'>=&amp;gt;array(</span><span style='color: #DD0000'>'age'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #0000BB'>12</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;&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;</span><span style='color: #DD0000'>'sex'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'M'</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;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'sally'</span><span style='color: #007700'>=&amp;gt;array(</span><span style='color: #DD0000'>'age'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #0000BB'>8</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;&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;</span><span style='color: #DD0000'>'sex'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'F'</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;</span><span style='color: #DD0000'>'CEO'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>http_build_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'flags_'</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 will output : (word wrapped for readability) </p></div> <div class='example-contents screen'> <div class='cdata'><pre> user%5Bname%5D=Bob+Smith&amp;amp;user%5Bage%5D=47&amp;amp;user%5Bsex%5D=M&amp;amp; user%5Bdob%5D=5%2F12%2F1956&amp;amp;pastimes%5B0%5D=golf&amp;amp;pastimes%5B1%5D=opera&amp;amp; pastimes%5B2%5D=poker&amp;amp;pastimes%5B3%5D=rap&amp;amp;children%5Bbobby%5D%5Bage%5D=12&amp;amp; children%5Bbobby%5D%5Bsex%5D=M&amp;amp;children%5Bsally%5D%5Bage%5D=8&amp;amp; children%5Bsally%5D%5Bsex%5D=F&amp;amp;flags_0=CEO </pre></div> </div> <div class='example-contents para'><p> </p><blockquote><p><b class='note'>Note</b>: Only the numerically indexed element in the base array &amp;quot;CEO&amp;quot; received a prefix. The other numeric indices, found under pastimes, do not require a string prefix to be legal variable names. <br /> </p></blockquote><p> </p></div> </div> <div class='example'> <p><b>Example #4 Using <b>http_build_query()</b> with an object</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'>class&amp;nbsp;</span><span style='color: #0000BB'>myClass&amp;nbsp;</span><span style='color: #007700'>{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;var&amp;nbsp;</span><span style='color: #0000BB'>$foo</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;var&amp;nbsp;</span><span style='color: #0000BB'>$baz</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;function&amp;nbsp;</span><span style='color: #0000BB'>myClass</span><span style='color: #007700'>()&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>foo&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'bar'</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'>$this</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>baz&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'boom'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;new&amp;nbsp;</span><span style='color: #0000BB'>myClass</span><span style='color: #007700'>();<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>http_build_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;foo=bar&amp;amp;baz=boom<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div> </div> <a name='function.http-build-query.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.parse-str.php' class='function' rel='rdfs-seeAlso'>parse_str()</a> - Parses the string into variables</li> <li class='member'><a href='http://www.php.net/manual/en/function.parse-url.php' class='function' rel='rdfs-seeAlso'>parse_url()</a> - Parse a URL and return its components</li> <li class='member'><a href='http://www.php.net/manual/en/function.urlencode.php' class='function' rel='rdfs-seeAlso'>urlencode()</a> - URL-encodes string</li> <li class='member'><a href='http://www.php.net/manual/en/function.array-walk.php' class='function' rel='rdfs-seeAlso'>array_walk()</a> - Apply a user function to every member of an array</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="html_entity_decode" value="<div id='function.html-entity-decode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.html-entity-decode.php'>html_entity_decode</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>html_entity_decode</span> &amp;mdash; <span class='dc-title'>Convert all HTML entities to their applicable characters</span></p> </div> <a name='function.html-entity-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>html_entity_decode</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$quote_style</tt><span class='initializer'> = ENT_COMPAT</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>html_entity_decode()</b> is the opposite of <a href='http://www.php.net/manual/en/function.htmlentities.php' class='function'>htmlentities()</a> in that it converts all HTML entities to their applicable characters from <i><tt class='parameter'>string</tt></i> . </p> </div> <a name='function.html-entity-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'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The input string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>quote_style</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional second <i><tt class='parameter'>quote_style</tt></i> parameter lets you define what will be done with &amp;#039;single&amp;#039; and &amp;quot;double&amp;quot; quotes. It takes on one of three constants with the default being <b><tt class='constant'>ENT_COMPAT</tt></b>: </p><table class='doctable table'> <caption><b>Available <i><tt class='parameter'>quote_style</tt></i> constants</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Constant Name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>ENT_COMPAT</tt></b></td> <td align='left'>Will convert double-quotes and leave single-quotes alone.</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ENT_QUOTES</tt></b></td> <td align='left'>Will convert both double and single quotes.</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ENT_NOQUOTES</tt></b></td> <td align='left'>Will leave both double and single quotes unconverted.</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 ISO-8859-1 character set is used as default for the optional third <i><tt class='parameter'>charset</tt></i> . This defines the character set used in conversion. </p> <p class='para'> Following character sets are supported in PHP 4.3.0 and later. </p><table class='doctable table'> <caption><b>Supported charsets</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Charset</th> <th>Aliases</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>ISO-8859-1</td> <td align='left'>ISO8859-1</td> <td align='left'> Western European, Latin-1 </td> </tr> <tr valign='middle'> <td align='left'>ISO-8859-15</td> <td align='left'>ISO8859-15</td> <td align='left'> Western European, Latin-9. Adds the Euro sign, French and Finnish letters missing in Latin-1(ISO-8859-1). </td> </tr> <tr valign='middle'> <td align='left'>UTF-8</td> <td class='empty'>&amp;nbsp;</td> <td align='left'> ASCII compatible multi-byte 8-bit Unicode. </td> </tr> <tr valign='middle'> <td align='left'>cp866</td> <td align='left'>ibm866, 866</td> <td align='left'> DOS-specific Cyrillic charset. This charset is supported in 4.3.2. </td> </tr> <tr valign='middle'> <td align='left'>cp1251</td> <td align='left'>Windows-1251, win-1251, 1251</td> <td align='left'> Windows-specific Cyrillic charset. This charset is supported in 4.3.2. </td> </tr> <tr valign='middle'> <td align='left'>cp1252</td> <td align='left'>Windows-1252, 1252</td> <td align='left'> Windows specific charset for Western European. </td> </tr> <tr valign='middle'> <td align='left'>KOI8-R</td> <td align='left'>koi8-ru, koi8r</td> <td align='left'> Russian. This charset is supported in 4.3.2. </td> </tr> <tr valign='middle'> <td align='left'>BIG5</td> <td align='left'>950</td> <td align='left'> Traditional Chinese, mainly used in Taiwan. </td> </tr> <tr valign='middle'> <td align='left'>GB2312</td> <td align='left'>936</td> <td align='left'> Simplified Chinese, national standard character set. </td> </tr> <tr valign='middle'> <td align='left'>BIG5-HKSCS</td> <td class='empty'>&amp;nbsp;</td> <td align='left'> Big5 with Hong Kong extensions, Traditional Chinese. </td> </tr> <tr valign='middle'> <td align='left'>Shift_JIS</td> <td align='left'>SJIS, 932</td> <td align='left'> Japanese </td> </tr> <tr valign='middle'> <td align='left'>EUC-JP</td> <td align='left'>EUCJP</td> <td align='left'> Japanese </td> </tr> </tbody> </table> <p> </p><blockquote><p><b class='note'>Note</b>: <span class='simpara'> Any other character sets are not recognized and ISO-8859-1 will be used instead. </span> </p></blockquote><p> </p> </dd> </dl> <p> </p> </div> <a name='function.html-entity-decode.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the decoded string. </p> </div> <a name='function.html-entity-decode.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'> Support for multi-byte character sets was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.html-entity-decode.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Decoding HTML entities</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$orig&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'I'll&amp;nbsp;\'walk\'&amp;nbsp;the&amp;nbsp;&amp;lt;b&amp;gt;dog&amp;lt;/b&amp;gt;&amp;nbsp;now'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>htmlentities</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$orig</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'>html_entity_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;I'll&amp;nbsp;&amp;amp;quot;walk&amp;amp;quot;&amp;nbsp;the&amp;nbsp;&amp;amp;lt;b&amp;amp;gt;dog&amp;amp;lt;/b&amp;amp;gt;&amp;nbsp;now<br /><br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;I'll&amp;nbsp;'walk'&amp;nbsp;the&amp;nbsp;&amp;lt;b&amp;gt;dog&amp;lt;/b&amp;gt;&amp;nbsp;now<br /><br /><br />//&amp;nbsp;For&amp;nbsp;users&amp;nbsp;prior&amp;nbsp;to&amp;nbsp;PHP&amp;nbsp;4.3.0&amp;nbsp;you&amp;nbsp;may&amp;nbsp;do&amp;nbsp;this:<br /></span><span style='color: #007700'>function&amp;nbsp;</span><span style='color: #0000BB'>unhtmlentities</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$string</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;replace&amp;nbsp;numeric&amp;nbsp;entities<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>preg_replace</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'~&amp;amp;#x([0-9a-f]+);~ei'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'chr(hexdec('\\1'))'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$string</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>preg_replace</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'~&amp;amp;#([0-9]+);~e'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'chr('\\1')'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$string</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;replace&amp;nbsp;literal&amp;nbsp;entities<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$trans_tbl&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>get_html_translation_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>HTML_ENTITIES</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$trans_tbl&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>array_flip</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$trans_tbl</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return&amp;nbsp;</span><span style='color: #0000BB'>strtr</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$trans_tbl</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>$c&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>unhtmlentities</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$c</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;I'll&amp;nbsp;'walk'&amp;nbsp;the&amp;nbsp;&amp;lt;b&amp;gt;dog&amp;lt;/b&amp;gt;&amp;nbsp;now<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.html-entity-decode.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: You might wonder why trim(html_entity_decode(&amp;#039;&amp;amp;nbsp;&amp;#039;)); doesn&amp;#039;t reduce the string to an empty string, that&amp;#039;s because the &amp;#039;&amp;amp;nbsp;&amp;#039; entity is not ASCII code 32 (which is stripped by <a href='http://www.php.net/manual/en/function.trim.php' class='function'>trim()</a>) but ASCII code 160 (0xa0) in the default ISO 8859-1 characterset. <br /> </p></blockquote> </div> <a name='function.html-entity-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.htmlentities.php' class='function' rel='rdfs-seeAlso'>htmlentities()</a> - Convert all applicable characters to HTML entities</li> <li class='member'><a href='http://www.php.net/manual/en/function.htmlspecialchars.php' class='function' rel='rdfs-seeAlso'>htmlspecialchars()</a> - Convert special characters to HTML entities</li> <li class='member'><a href='http://www.php.net/manual/en/function.get-html-translation-table.php' class='function' rel='rdfs-seeAlso'>get_html_translation_table()</a> - Returns the translation table used by htmlspecialchars and htmlentities</li> <li class='member'><a href='http://www.php.net/manual/en/function.urldecode.php' class='function' rel='rdfs-seeAlso'>urldecode()</a> - Decodes URL-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="htmlspecialchars_decode" value="<div id='function.htmlspecialchars-decode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.htmlspecialchars-decode.php'>htmlspecialchars_decode</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>htmlspecialchars_decode</span> &amp;mdash; <span class='dc-title'> Convert special HTML entities back to characters </span></p> </div> <a name='function.htmlspecialchars-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>htmlspecialchars_decode</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$quote_style</tt><span class='initializer'> = ENT_COMPAT</span></span> ] )</div> <p class='para rdfs-comment'> This function is the opposite of <a href='http://www.php.net/manual/en/function.htmlspecialchars.php' class='function'>htmlspecialchars()</a>. It converts special HTML entities back to characters. </p> <p class='para'> The converted entities are: <i>&amp;amp;amp;</i>, <i>&amp;amp;quot;</i> (when <b><tt class='constant'>ENT_NOQUOTES</tt></b> is not set), <i>&amp;amp;#039;</i> (when <b><tt class='constant'>ENT_QUOTES</tt></b> is set), <i>&amp;amp;lt;</i> and <i>&amp;amp;gt;</i>. </p> </div> <a name='function.htmlspecialchars-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'>string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string to decode </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>quote_style</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The quote style. One of the following constants: </p><table class='doctable table'> <caption><b>quote_style constants</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Constant Name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>ENT_COMPAT</tt></b></td> <td align='left'>Will convert double-quotes and leave single-quotes alone (default)</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ENT_QUOTES</tt></b></td> <td align='left'>Will convert both double and single quotes</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ENT_NOQUOTES</tt></b></td> <td align='left'>Will leave both double and single quotes unconverted</td> </tr> </tbody> </table> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.htmlspecialchars-decode.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the decoded string. </p> </div> <a name='function.htmlspecialchars-decode.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>htmlspecialchars_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 />$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;p&amp;gt;this&amp;nbsp;-&amp;amp;gt;&amp;nbsp;&amp;amp;quot;&amp;lt;/p&amp;gt;'</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>htmlspecialchars_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;note&amp;nbsp;that&amp;nbsp;here&amp;nbsp;the&amp;nbsp;quotes&amp;nbsp;aren't&amp;nbsp;converted<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>htmlspecialchars_decode</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>ENT_NOQUOTES</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;p&amp;gt;this -&amp;gt; &amp;quot;&amp;lt;/p&amp;gt; &amp;lt;p&amp;gt;this -&amp;gt; &amp;amp;quot;&amp;lt;/p&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='function.htmlspecialchars-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.htmlspecialchars.php' class='function' rel='rdfs-seeAlso'>htmlspecialchars()</a> - Convert special characters to HTML entities</li> <li class='member'><a href='http://www.php.net/manual/en/function.html-entity-decode.php' class='function' rel='rdfs-seeAlso'>html_entity_decode()</a> - Convert all HTML entities to their applicable characters</li> <li class='member'><a href='http://www.php.net/manual/en/function.get-html-translation-table.php' class='function' rel='rdfs-seeAlso'>get_html_translation_table()</a> - Returns the translation table used by htmlspecialchars and htmlentities</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="htmlspecialchars" value="<div id='function.htmlspecialchars' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.htmlspecialchars.php'>htmlspecialchars</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>htmlspecialchars</span> &amp;mdash; <span class='dc-title'>Convert special characters to HTML entities</span></p> </div> <a name='function.htmlspecialchars.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>htmlspecialchars</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$quote_style</tt><span class='initializer'> = ENT_COMPAT</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$double_encode</tt><span class='initializer'> = true</span></span> ]]] )</div> <p class='para rdfs-comment'> Certain characters have special significance in HTML, and should be represented by HTML entities if they are to preserve their meanings. This function returns a string with some of these conversions made; the translations made are those most useful for everyday web programming. If you require all HTML character entities to be translated, use <a href='http://www.php.net/manual/en/function.htmlentities.php' class='function'>htmlentities()</a> instead. </p> <p class='simpara'> This function is useful in preventing user-supplied text from containing HTML markup, such as in a message board or guest book application. </p> <p class='para'> The translations performed are: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> &amp;#039;&amp;amp;&amp;#039; (ampersand) becomes &amp;#039;&amp;amp;amp;&amp;#039; </span> </li> <li class='listitem'> <span class='simpara'> &amp;#039;&amp;quot;&amp;#039; (double quote) becomes &amp;#039;&amp;amp;quot;&amp;#039; when <b><tt class='constant'>ENT_NOQUOTES</tt></b> is not set. </span> </li> <li class='listitem'> <span class='simpara'> &amp;#039;&amp;#039;&amp;#039; (single quote) becomes &amp;#039;&amp;amp;#039;&amp;#039; only when <b><tt class='constant'>ENT_QUOTES</tt></b> is set. </span> </li> <li class='listitem'> <span class='simpara'> &amp;#039;&amp;lt;&amp;#039; (less than) becomes &amp;#039;&amp;amp;lt;&amp;#039; </span> </li> <li class='listitem'> <span class='simpara'> &amp;#039;&amp;gt;&amp;#039; (greater than) becomes &amp;#039;&amp;amp;gt;&amp;#039; </span> </li> </ul><p> </p> </div> <a name='function.htmlspecialchars.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 <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> being converted. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>quote_style</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional second argument, <i><tt class='parameter'>quote_style</tt></i> , tells the function what to do with single and double quote characters. The default mode, <b><tt class='constant'>ENT_COMPAT</tt></b>, is the backwards compatible mode which only translates the double-quote character and leaves the single-quote untranslated. If <b><tt class='constant'>ENT_QUOTES</tt></b> is set, both single and double quotes are translated and if <b><tt class='constant'>ENT_NOQUOTES</tt></b> is set neither single nor double quotes are translated. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Defines character set used in conversion. The default character set is ISO-8859-1. </p> <p class='para'> Following character sets are supported in PHP 4.3.0 and later. </p><table class='doctable table'> <caption><b>Supported charsets</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Charset</th> <th>Aliases</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>ISO-8859-1</td> <td align='left'>ISO8859-1</td> <td align='left'> Western European, Latin-1 </td> </tr> <tr valign='middle'> <td align='left'>ISO-8859-15</td> <td align='left'>ISO8859-15</td> <td align='left'> Western European, Latin-9. Adds the Euro sign, French and Finnish letters missing in Latin-1(ISO-8859-1). </td> </tr> <tr valign='middle'> <td align='left'>UTF-8</td> <td class='empty'>&amp;nbsp;</td> <td align='left'> ASCII compatible multi-byte 8-bit Unicode. </td> </tr> <tr valign='middle'> <td align='left'>cp866</td> <td align='left'>ibm866, 866</td> <td align='left'> DOS-specific Cyrillic charset. This charset is supported in 4.3.2. </td> </tr> <tr valign='middle'> <td align='left'>cp1251</td> <td align='left'>Windows-1251, win-1251, 1251</td> <td align='left'> Windows-specific Cyrillic charset. This charset is supported in 4.3.2. </td> </tr> <tr valign='middle'> <td align='left'>cp1252</td> <td align='left'>Windows-1252, 1252</td> <td align='left'> Windows specific charset for Western European. </td> </tr> <tr valign='middle'> <td align='left'>KOI8-R</td> <td align='left'>koi8-ru, koi8r</td> <td align='left'> Russian. This charset is supported in 4.3.2. </td> </tr> <tr valign='middle'> <td align='left'>BIG5</td> <td align='left'>950</td> <td align='left'> Traditional Chinese, mainly used in Taiwan. </td> </tr> <tr valign='middle'> <td align='left'>GB2312</td> <td align='left'>936</td> <td align='left'> Simplified Chinese, national standard character set. </td> </tr> <tr valign='middle'> <td align='left'>BIG5-HKSCS</td> <td class='empty'>&amp;nbsp;</td> <td align='left'> Big5 with Hong Kong extensions, Traditional Chinese. </td> </tr> <tr valign='middle'> <td align='left'>Shift_JIS</td> <td align='left'>SJIS, 932</td> <td align='left'> Japanese </td> </tr> <tr valign='middle'> <td align='left'>EUC-JP</td> <td align='left'>EUCJP</td> <td align='left'> Japanese </td> </tr> </tbody> </table> <p> </p><blockquote><p><b class='note'>Note</b>: <span class='simpara'> Any other character sets are not recognized and ISO-8859-1 will be used instead. </span> </p></blockquote><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>double_encode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> When <i><tt class='parameter'>double_encode</tt></i> is turned off PHP will not encode existing html entities, the default is to convert everything. </p> </dd> </dl> <p> </p> </div> <a name='function.htmlspecialchars.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The converted <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </div> <a name='function.htmlspecialchars.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.3</td> <td align='left'> The <i><tt class='parameter'>double_encode</tt></i> parameter was added. </td> </tr> <tr valign='middle'> <td align='left'>4.1.0</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.htmlspecialchars.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>htmlspecialchars()</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 />$new&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>htmlspecialchars</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'&amp;lt;a&amp;nbsp;href='http://www.php.net/manual/en/test'&amp;gt;Test&amp;lt;/a&amp;gt;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>ENT_QUOTES</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$new</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;&amp;amp;lt;a&amp;nbsp;href=&amp;amp;#039;test&amp;amp;#039;&amp;amp;gt;Test&amp;amp;lt;/a&amp;amp;gt;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.htmlspecialchars.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Note that this function does not translate anything beyond what is listed above. For full entity translation, see <a href='http://www.php.net/manual/en/function.htmlentities.php' class='function'>htmlentities()</a>. <br /> </p></blockquote> </div> <a name='function.htmlspecialchars.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.get-html-translation-table.php' class='function' rel='rdfs-seeAlso'>get_html_translation_table()</a> - Returns the translation table used by htmlspecialchars and htmlentities</li> <li class='member'><a href='http://www.php.net/manual/en/function.htmlspecialchars-decode.php' class='function' rel='rdfs-seeAlso'>htmlspecialchars_decode()</a> - Convert special HTML entities back to characters</li> <li class='member'><a href='http://www.php.net/manual/en/function.strip-tags.php' class='function' rel='rdfs-seeAlso'>strip_tags()</a> - Strip HTML and PHP tags from a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.htmlentities.php' class='function' rel='rdfs-seeAlso'>htmlentities()</a> - Convert all applicable characters to HTML entities</li> <li class='member'><a href='http://www.php.net/manual/en/function.nl2br.php' class='function' rel='rdfs-seeAlso'>nl2br()</a> - Inserts HTML line breaks before all newlines 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="htmlentities" value="<div id='function.htmlentities' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.htmlentities.php'>htmlentities</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>htmlentities</span> &amp;mdash; <span class='dc-title'>Convert all applicable characters to HTML entities</span></p> </div> <a name='function.htmlentities.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>htmlentities</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$quote_style</tt><span class='initializer'> = ENT_COMPAT</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$double_encode</tt><span class='initializer'> = true</span></span> ]]] )</div> <p class='para rdfs-comment'> This function is identical to <a href='http://www.php.net/manual/en/function.htmlspecialchars.php' class='function'>htmlspecialchars()</a> in all ways, except with <b>htmlentities()</b>, all characters which have HTML character entity equivalents are translated into these entities. </p> <p class='para'> If you&amp;#039;re wanting to decode instead (the reverse) you can use <a href='http://www.php.net/manual/en/function.html-entity-decode.php' class='function'>html_entity_decode()</a>. </p> </div> <a name='function.htmlentities.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 input string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>quote_style</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Like <a href='http://www.php.net/manual/en/function.htmlspecialchars.php' class='function'>htmlspecialchars()</a>, the optional second <i><tt class='parameter'>quote_style</tt></i> parameter lets you define what will be done with &amp;#039;single&amp;#039; and &amp;quot;double&amp;quot; quotes. It takes on one of three constants with the default being <b><tt class='constant'>ENT_COMPAT</tt></b>: </p><table class='doctable table'> <caption><b>Available <i><tt class='parameter'>quote_style</tt></i> constants</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Constant Name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>ENT_COMPAT</tt></b></td> <td align='left'>Will convert double-quotes and leave single-quotes alone.</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ENT_QUOTES</tt></b></td> <td align='left'>Will convert both double and single quotes.</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ENT_NOQUOTES</tt></b></td> <td align='left'>Will leave both double and single quotes unconverted.</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'> Like <a href='http://www.php.net/manual/en/function.htmlspecialchars.php' class='function'>htmlspecialchars()</a>, it takes an optional third argument <i><tt class='parameter'>charset</tt></i> which defines character set used in conversion. Presently, the ISO-8859-1 character set is used as the default. </p> <p class='para'> Following character sets are supported in PHP 4.3.0 and later. </p><table class='doctable table'> <caption><b>Supported charsets</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Charset</th> <th>Aliases</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>ISO-8859-1</td> <td align='left'>ISO8859-1</td> <td align='left'> Western European, Latin-1 </td> </tr> <tr valign='middle'> <td align='left'>ISO-8859-15</td> <td align='left'>ISO8859-15</td> <td align='left'> Western European, Latin-9. Adds the Euro sign, French and Finnish letters missing in Latin-1(ISO-8859-1). </td> </tr> <tr valign='middle'> <td align='left'>UTF-8</td> <td class='empty'>&amp;nbsp;</td> <td align='left'> ASCII compatible multi-byte 8-bit Unicode. </td> </tr> <tr valign='middle'> <td align='left'>cp866</td> <td align='left'>ibm866, 866</td> <td align='left'> DOS-specific Cyrillic charset. This charset is supported in 4.3.2. </td> </tr> <tr valign='middle'> <td align='left'>cp1251</td> <td align='left'>Windows-1251, win-1251, 1251</td> <td align='left'> Windows-specific Cyrillic charset. This charset is supported in 4.3.2. </td> </tr> <tr valign='middle'> <td align='left'>cp1252</td> <td align='left'>Windows-1252, 1252</td> <td align='left'> Windows specific charset for Western European. </td> </tr> <tr valign='middle'> <td align='left'>KOI8-R</td> <td align='left'>koi8-ru, koi8r</td> <td align='left'> Russian. This charset is supported in 4.3.2. </td> </tr> <tr valign='middle'> <td align='left'>BIG5</td> <td align='left'>950</td> <td align='left'> Traditional Chinese, mainly used in Taiwan. </td> </tr> <tr valign='middle'> <td align='left'>GB2312</td> <td align='left'>936</td> <td align='left'> Simplified Chinese, national standard character set. </td> </tr> <tr valign='middle'> <td align='left'>BIG5-HKSCS</td> <td class='empty'>&amp;nbsp;</td> <td align='left'> Big5 with Hong Kong extensions, Traditional Chinese. </td> </tr> <tr valign='middle'> <td align='left'>Shift_JIS</td> <td align='left'>SJIS, 932</td> <td align='left'> Japanese </td> </tr> <tr valign='middle'> <td align='left'>EUC-JP</td> <td align='left'>EUCJP</td> <td align='left'> Japanese </td> </tr> </tbody> </table> <p> </p><blockquote><p><b class='note'>Note</b>: <span class='simpara'> Any other character sets are not recognized and ISO-8859-1 will be used instead. </span> </p></blockquote><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>double_encode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> When <i><tt class='parameter'>double_encode</tt></i> is turned off PHP will not encode existing html entities. The default is to convert everything. </p> </dd> </dl> <p> </p> </div> <a name='function.htmlentities.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the encoded string. </p> </div> <a name='function.htmlentities.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.3</td> <td align='left'> The <i><tt class='parameter'>double_encode</tt></i> parameter was added. </td> </tr> <tr valign='middle'> <td align='left'>4.1.0</td> <td align='left'> The <i><tt class='parameter'>charset</tt></i> parameter was added. </td> </tr> <tr valign='middle'> <td align='left'>4.0.3</td> <td align='left'> The <i><tt class='parameter'>quote_style</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.htmlentities.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>htmlentities()</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 />$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'A&amp;nbsp;'quote'&amp;nbsp;is&amp;nbsp;&amp;lt;b&amp;gt;bold&amp;lt;/b&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Outputs:&amp;nbsp;A&amp;nbsp;'quote'&amp;nbsp;is&amp;nbsp;&amp;amp;lt;b&amp;amp;gt;bold&amp;amp;lt;/b&amp;amp;gt;<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>htmlentities</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Outputs:&amp;nbsp;A&amp;nbsp;&amp;amp;#039;quote&amp;amp;#039;&amp;nbsp;is&amp;nbsp;&amp;amp;lt;b&amp;amp;gt;bold&amp;amp;lt;/b&amp;amp;gt;<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #0000BB'>htmlentities</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>ENT_QUOTES</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.htmlentities.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.html-entity-decode.php' class='function' rel='rdfs-seeAlso'>html_entity_decode()</a> - Convert all HTML entities to their applicable characters</li> <li class='member'><a href='http://www.php.net/manual/en/function.get-html-translation-table.php' class='function' rel='rdfs-seeAlso'>get_html_translation_table()</a> - Returns the translation table used by htmlspecialchars and htmlentities</li> <li class='member'><a href='http://www.php.net/manual/en/function.htmlspecialchars.php' class='function' rel='rdfs-seeAlso'>htmlspecialchars()</a> - Convert special characters to HTML entities</li> <li class='member'><a href='http://www.php.net/manual/en/function.nl2br.php' class='function' rel='rdfs-seeAlso'>nl2br()</a> - Inserts HTML line breaks before all newlines in a string</li> <li class='member'><a href='http://www.php.net/manual/en/function.urlencode.php' class='function' rel='rdfs-seeAlso'>urlencode()</a> - URL-encodes 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="highlight_string" value="<div id='function.highlight-string' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.highlight-string.php'>highlight_string</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>highlight_string</span> &amp;mdash; <span class='dc-title'>Syntax highlighting of a string</span></p> </div> <a name='function.highlight-string.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>highlight_string</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$str</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$return</tt><span class='initializer'> = false</span></span> ] )</div> <p class='simpara'> Outputs or returns a syntax highlighted version of the given PHP code using the colors defined in the built-in syntax highlighter for PHP. </p> </div> <a name='function.highlight-string.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 PHP code to be highlighted. This should include the opening tag. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>return</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Set this parameter to <b><tt class='constant'>TRUE</tt></b> to make this function return the highlighted code. </p> </dd> </dl> <p> </p> </div> <a name='function.highlight-string.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If <i><tt class='parameter'>return</tt></i> is set to <b><tt class='constant'>TRUE</tt></b>, returns the highlighted code as a string instead of printing it out. Otherwise, it will return <b><tt class='constant'>TRUE</tt></b> on success, <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.highlight-string.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'> The <i><tt class='parameter'>return</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.highlight-string.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>highlight_string()</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 />highlight_string</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'&amp;lt;?php&amp;nbsp;phpinfo();&amp;nbsp;?&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 (in PHP 4): </p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;code&amp;gt;&amp;lt;font color=&amp;quot;#000000&amp;quot;&amp;gt; &amp;lt;font color=&amp;quot;#0000BB&amp;quot;&amp;gt;&amp;amp;lt;?php phpinfo&amp;lt;/font&amp;gt;&amp;lt;font color=&amp;quot;#007700&amp;quot;&amp;gt;(); &amp;lt;/font&amp;gt;&amp;lt;font color=&amp;quot;#0000BB&amp;quot;&amp;gt;?&amp;amp;gt;&amp;lt;/font&amp;gt; &amp;lt;/font&amp;gt; &amp;lt;/code&amp;gt; </pre></div> </div> <div class='example-contents para'><p> The above example will output (in PHP 5): </p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;code&amp;gt;&amp;lt;span style=&amp;quot;color: #000000&amp;quot;&amp;gt; &amp;lt;span style=&amp;quot;color: #0000BB&amp;quot;&amp;gt;&amp;amp;lt;?php phpinfo&amp;lt;/span&amp;gt;&amp;lt;span style=&amp;quot;color: #007700&amp;quot;&amp;gt;(); &amp;lt;/span&amp;gt;&amp;lt;span style=&amp;quot;color: #0000BB&amp;quot;&amp;gt;?&amp;amp;gt;&amp;lt;/span&amp;gt; &amp;lt;/span&amp;gt; &amp;lt;/code&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='function.highlight-string.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function uses internal output buffering with this parameter so it can not be used inside an <a href='http://www.php.net/manual/en/function.ob-start.php' class='function'>ob_start()</a> callback function.<br /></p></blockquote> </div> <a name='function.highlight-string.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.highlight-file.php' class='function' rel='rdfs-seeAlso'>highlight_file()</a> - Syntax highlighting of a file</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="highlight_file" value="<div id='function.highlight-file' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.highlight-file.php'>highlight_file</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>highlight_file</span> &amp;mdash; <span class='dc-title'>Syntax highlighting of a file</span></p> </div> <a name='function.highlight-file.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>highlight_file</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$return</tt><span class='initializer'> = false</span></span> ] )</div> <p class='para rdfs-comment'> Prints out or returns a syntax highlighted version of the code contained in <i><tt class='parameter'>filename</tt></i> using the colors defined in the built-in syntax highlighter for PHP. </p> <p class='para'> Many servers are configured to automatically highlight files with a <em class='emphasis'>phps</em> extension. For example, <var class='filename'>example.phps</var> when viewed will show the syntax highlighted source of the file. To enable this, add this line to the <var class='filename'>httpd.conf</var>: </p> <div class='example-contents screen'> <div class='descriptioncode'><pre class='descriptioncode'>AddType application/x-httpd-php-source .phps</pre> </div> </div> </div> <a name='function.highlight-file.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 PHP file to be highlighted. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>return</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Set this parameter to <b><tt class='constant'>TRUE</tt></b> to make this function return the highlighted code. </p> </dd> </dl> <p> </p> </div> <a name='function.highlight-file.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If <i><tt class='parameter'>return</tt></i> is set to <b><tt class='constant'>TRUE</tt></b>, returns the highlighted code as a string instead of printing it out. Otherwise, it will return <b><tt class='constant'>TRUE</tt></b> on success, <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.highlight-file.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.1</td> <td align='left'> This function is now also affected by <a href='http://www.php.net/manual/en/ini.sect.safe-mode.php#ini.safe-mode' class='link'>safe_mode</a> and <a href='http://www.php.net/manual/en/ini.sect.safe-mode.php#ini.open-basedir' class='link'>open_basedir</a>. </td> </tr> <tr valign='middle'> <td align='left'>4.2.0</td> <td align='left'> The <i><tt class='parameter'>return</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.highlight-file.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='caution'><b class='caution'>Caution</b> <p class='para'> Care should be taken when using the <b>highlight_file()</b> function to make sure that you do not inadvertently reveal sensitive information such as passwords or any other type of information that might create a potential security risk. </p> </div> <blockquote><p><b class='note'>Note</b>: This function uses internal output buffering with this parameter so it can not be used inside an <a href='http://www.php.net/manual/en/function.ob-start.php' class='function'>ob_start()</a> callback function.<br /></p></blockquote> </div> <a name='function.highlight-file.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.highlight-string.php' class='function' rel='rdfs-seeAlso'>highlight_string()</a> - Syntax highlighting of 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="hexdec" value="<div id='function.hexdec' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.hexdec.php'>hexdec</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>hexdec</span> &amp;mdash; <span class='dc-title'>Hexadecimal to decimal</span></p> </div> <a name='function.hexdec.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.number' class='type number'>number</a></span> <span class='methodname'><b>hexdec</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$hex_string</tt></span> )</div> <p class='para rdfs-comment'> Returns the decimal equivalent of the hexadecimal number represented by the <i><tt class='parameter'>hex_string</tt></i> argument. <b>hexdec()</b> converts a hexadecimal string to a decimal number. </p> <p class='para'> <b>hexdec()</b> will ignore any non-hexadecimal characters it encounters. </p> </div> <a name='function.hexdec.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'>hex_string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The hexadecimal string to convert </p> </dd> </dl> <p> </p> </div> <a name='function.hexdec.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The decimal representation of <i><tt class='parameter'>hex_string</tt></i> </p> </div> <a name='function.hexdec.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.1.0</td> <td align='left'> The function can now convert values that are too big for the platforms <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> type, it will return the value as <a href='http://www.php.net/manual/en/language.types.float.php' class='type float'>float</a> instead in that case. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.hexdec.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>hexdec()</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 />var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>hexdec</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'See'</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>hexdec</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ee'</span><span style='color: #007700'>));<br /></span><span style='color: #FF8000'>//&amp;nbsp;both&amp;nbsp;print&amp;nbsp;'int(238)'<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>hexdec</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'that'</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;print&amp;nbsp;'int(10)'<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>hexdec</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'a0'</span><span style='color: #007700'>));&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;print&amp;nbsp;'int(160)'<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.hexdec.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.dechex.php' class='function' rel='rdfs-seeAlso'>dechex()</a> - Decimal to hexadecimal</li> <li class='member'><a href='http://www.php.net/manual/en/function.bindec.php' class='function' rel='rdfs-seeAlso'>bindec()</a> - Binary to decimal</li> <li class='member'><a href='http://www.php.net/manual/en/function.octdec.php' class='function' rel='rdfs-seeAlso'>octdec()</a> - Octal to decimal</li> <li class='member'><a href='http://www.php.net/manual/en/function.base-convert.php' class='function' rel='rdfs-seeAlso'>base_convert()</a> - Convert a number between arbitrary bases</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="hebrevc" value="<div id='function.hebrevc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.hebrevc.php'>hebrevc</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>hebrevc</span> &amp;mdash; <span class='dc-title'>Convert logical Hebrew text to visual text with newline conversion</span></p> </div> <a name='function.hebrevc.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>hebrevc</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$hebrew_text</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$max_chars_per_line</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> This function is similar to <a href='http://www.php.net/manual/en/function.hebrev.php' class='function'>hebrev()</a> with the difference that it converts newlines (\n) to &amp;quot;&amp;lt;br&amp;gt;\n&amp;quot;. </p> <p class='para'> The function tries to avoid breaking words. </p> </div> <a name='function.hebrevc.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'>hebrew_text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A Hebrew input string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>max_chars_per_line</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This optional parameter indicates maximum number of characters per line that will be returned. </p> </dd> </dl> <p> </p> </div> <a name='function.hebrevc.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the visual string. </p> </div> <a name='function.hebrevc.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.hebrev.php' class='function' rel='rdfs-seeAlso'>hebrev()</a> - Convert logical Hebrew text to visual 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="hebrev" value="<div id='function.hebrev' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.hebrev.php'>hebrev</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>hebrev</span> &amp;mdash; <span class='dc-title'>Convert logical Hebrew text to visual text</span></p> </div> <a name='function.hebrev.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>hebrev</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$hebrew_text</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$max_chars_per_line</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Converts logical Hebrew text to visual text. </p> <p class='para'> The function tries to avoid breaking words. </p> </div> <a name='function.hebrev.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'>hebrew_text</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A Hebrew input string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>max_chars_per_line</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This optional parameter indicates maximum number of characters per line that will be returned. </p> </dd> </dl> <p> </p> </div> <a name='function.hebrev.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the visual string. </p> </div> <a name='function.hebrev.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.hebrevc.php' class='function' rel='rdfs-seeAlso'>hebrevc()</a> - Convert logical Hebrew text to visual text with newline conversion</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="headers_sent" value="<div id='function.headers-sent' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.headers-sent.php'>headers_sent</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>headers_sent</span> &amp;mdash; <span class='dc-title'>Checks if or where headers have been sent</span></p> </div> <a name='function.headers-sent.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>headers_sent</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter reference'>&amp;amp;$file</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter reference'>&amp;amp;$line</tt></span> ]] )</div> <p class='para rdfs-comment'> Checks if or where headers have been sent. </p> <p class='para'> You can&amp;#039;t add any more header lines using the <a href='http://www.php.net/manual/en/function.header.php' class='function'>header()</a> function once the header block has already been sent. Using this function you can at least prevent getting HTTP header related error messages. Another option is to use <a href='http://www.php.net/manual/en/ref.outcontrol.php' class='link'>Output Buffering</a>. </p> </div> <a name='function.headers-sent.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'>file</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If the optional <i><tt class='parameter'>file</tt></i> and <i><tt class='parameter'>line</tt></i> parameters are set, <b>headers_sent()</b> will put the PHP source file name and line number where output started in the <i><tt class='parameter'>file</tt></i> and <i><tt class='parameter'>line</tt></i> variables. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>line</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The line number where the output started. </p> </dd> </dl> <p> </p> </div> <a name='function.headers-sent.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b>headers_sent()</b> will return <b><tt class='constant'>FALSE</tt></b> if no HTTP headers have already been sent or <b><tt class='constant'>TRUE</tt></b> otherwise. </p> </div> <a name='function.headers-sent.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 <i><tt class='parameter'>file</tt></i> and <i><tt class='parameter'>line</tt></i> parameters were added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.headers-sent.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Examples using <b>headers_sent()</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;If&amp;nbsp;no&amp;nbsp;headers&amp;nbsp;are&amp;nbsp;sent,&amp;nbsp;send&amp;nbsp;one<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>headers_sent</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'>'Location:&amp;nbsp;http://www.example.com/'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;An&amp;nbsp;example&amp;nbsp;using&amp;nbsp;the&amp;nbsp;optional&amp;nbsp;file&amp;nbsp;and&amp;nbsp;line&amp;nbsp;parameters,&amp;nbsp;as&amp;nbsp;of&amp;nbsp;PHP&amp;nbsp;4.3.0<br />//&amp;nbsp;Note&amp;nbsp;that&amp;nbsp;$filename&amp;nbsp;and&amp;nbsp;$linenum&amp;nbsp;are&amp;nbsp;passed&amp;nbsp;in&amp;nbsp;for&amp;nbsp;later&amp;nbsp;use.<br />//&amp;nbsp;Do&amp;nbsp;not&amp;nbsp;assign&amp;nbsp;them&amp;nbsp;values&amp;nbsp;beforehand.<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>headers_sent</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$filename</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$linenum</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'>'Location:&amp;nbsp;http://www.example.com/'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;You&amp;nbsp;would&amp;nbsp;most&amp;nbsp;likely&amp;nbsp;trigger&amp;nbsp;an&amp;nbsp;error&amp;nbsp;here.<br /></span><span style='color: #007700'>}&amp;nbsp;else&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Headers&amp;nbsp;already&amp;nbsp;sent&amp;nbsp;in&amp;nbsp;</span><span style='color: #0000BB'>$filename</span><span style='color: #DD0000'>&amp;nbsp;on&amp;nbsp;line&amp;nbsp;</span><span style='color: #0000BB'>$linenum</span><span style='color: #DD0000'>\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;</span><span style='color: #DD0000'>'Cannot&amp;nbsp;redirect,&amp;nbsp;for&amp;nbsp;now&amp;nbsp;please&amp;nbsp;click&amp;nbsp;this&amp;nbsp;&amp;lt;a&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;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'href=\'http://www.example.com\'&amp;gt;link&amp;lt;/a&amp;gt;&amp;nbsp;instead\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.headers-sent.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> <li class='member'><a href='http://www.php.net/manual/en/function.trigger-error.php' class='function' rel='rdfs-seeAlso'>trigger_error()</a> - Generates a user-level error/warning/notice message</li> <li class='member'><a href='http://www.php.net/manual/en/function.headers-list.php' class='function' rel='rdfs-seeAlso'>headers_list()</a> - Returns a list of response headers sent (or ready to send)</li> <li class='member'> <a href='http://www.php.net/manual/en/function.header.php' class='function' rel='rdfs-seeAlso'>header()</a> - Send a raw HTTP header for a more detailed discussion of the matters involved. </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="headers_list" value="<div id='function.headers-list' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.headers-list.php'>headers_list</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>headers_list</span> &amp;mdash; <span class='dc-title'>Returns a list of response headers sent (or ready to send)</span></p> </div> <a name='function.headers-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>headers_list</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> <b>headers_list()</b> will return a list of headers to be sent to the browser / client. To determine whether or not these headers have been sent yet, use <a href='http://www.php.net/manual/en/function.headers-sent.php' class='function'>headers_sent()</a>. </p> </div> <a name='function.headers-list.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a numerically indexed array of headers. </p> </div> <a name='function.headers-list.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Examples using <b>headers_list()</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;setcookie()&amp;nbsp;will&amp;nbsp;add&amp;nbsp;a&amp;nbsp;response&amp;nbsp;header&amp;nbsp;on&amp;nbsp;its&amp;nbsp;own&amp;nbsp;*/<br /></span><span style='color: #0000BB'>setcookie</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'foo'</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;Define&amp;nbsp;a&amp;nbsp;custom&amp;nbsp;response&amp;nbsp;header<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;This&amp;nbsp;will&amp;nbsp;be&amp;nbsp;ignored&amp;nbsp;by&amp;nbsp;most&amp;nbsp;clients&amp;nbsp;*/<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'X-Sample-Test:&amp;nbsp;foo'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Specify&amp;nbsp;plain&amp;nbsp;text&amp;nbsp;content&amp;nbsp;in&amp;nbsp;our&amp;nbsp;response&amp;nbsp;*/<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;text/plain'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;What&amp;nbsp;headers&amp;nbsp;are&amp;nbsp;going&amp;nbsp;to&amp;nbsp;be&amp;nbsp;sent?&amp;nbsp;*/<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>headers_list</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> array(4) { [0]=&amp;gt; string(23) &amp;quot;X-Powered-By: PHP/5.1.3&amp;quot; [1]=&amp;gt; string(19) &amp;quot;Set-Cookie: foo=bar&amp;quot; [2]=&amp;gt; string(18) &amp;quot;X-Sample-Test: foo&amp;quot; [3]=&amp;gt; string(24) &amp;quot;Content-type: text/plain&amp;quot; } </pre></div> </div> </div><p> </p> </div> <a name='function.headers-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.headers-sent.php' class='function' rel='rdfs-seeAlso'>headers_sent()</a> - Checks if or where headers have been sent</li> <li class='member'><a href='http://www.php.net/manual/en/function.header.php' class='function' rel='rdfs-seeAlso'>header()</a> - Send a raw HTTP header</li> <li class='member'><a href='http://www.php.net/manual/en/function.setcookie.php' class='function' rel='rdfs-seeAlso'>setcookie()</a> - Send a cookie</li> <li class='member'><a href='http://www.php.net/manual/en/function.apache-response-headers.php' class='function' rel='rdfs-seeAlso'>apache_response_headers()</a> - Fetch all HTTP response headers</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="header" value="<div id='function.header' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.header.php'>header</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>header</span> &amp;mdash; <span class='dc-title'>Send a raw HTTP header</span></p> </div> <a name='function.header.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>header</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$replace</tt><span class='initializer'> = true</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$http_response_code</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>header()</b> is used to send a raw <acronym title='Hypertext Transfer Protocol'>HTTP</acronym> header. See the <a href='http://www.faqs.org/rfcs/rfc2616' class='link external'>&amp;raquo; HTTP/1.1 specification</a> for more information on <acronym title='Hypertext Transfer Protocol'>HTTP</acronym> headers. </p> <p class='para'> Remember that <b>header()</b> must be called before any actual output is sent, either by normal HTML tags, blank lines in a file, or from PHP. It is a very common error to read code with <a href='http://www.php.net/manual/en/function.include.php' class='function'>include()</a>, or <a href='http://www.php.net/manual/en/function.require.php' class='function'>require()</a>, functions, or another file access function, and have spaces or empty lines that are output before <b>header()</b> is called. The same problem exists when using a single PHP/HTML file. </p><div class='informalexample'> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> &amp;lt;html&amp;gt;<br /><span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;This&amp;nbsp;will&amp;nbsp;give&amp;nbsp;an&amp;nbsp;error.&amp;nbsp;Note&amp;nbsp;the&amp;nbsp;output<br />&amp;nbsp;*&amp;nbsp;above,&amp;nbsp;which&amp;nbsp;is&amp;nbsp;before&amp;nbsp;the&amp;nbsp;header()&amp;nbsp;call&amp;nbsp;*/<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Location:&amp;nbsp;http://www.example.com/'</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.header.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 header string. </p> <p class='para'> There are two special-case header calls. The first is a header that starts with the string &amp;quot;<i>HTTP/</i>&amp;quot; (case is not significant), which will be used to figure out the HTTP status code to send. For example, if you have configured Apache to use a PHP script to handle requests for missing files (using the <i>ErrorDocument</i> directive), you may want to make sure that your script generates the proper status code. </p> <p class='para'> </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 />header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'HTTP/1.0&amp;nbsp;404&amp;nbsp;Not&amp;nbsp;Found'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> The second special case is the &amp;quot;Location:&amp;quot; header. Not only does it send this header back to the browser, but it also returns a <i>REDIRECT</i> (302) status code to the browser unless some <i>3xx</i> status code has already been set. </p> <p class='para'> </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 />header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Location:&amp;nbsp;http://www.example.com/'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Redirect&amp;nbsp;browser&amp;nbsp;*/<br /><br />/*&amp;nbsp;Make&amp;nbsp;sure&amp;nbsp;that&amp;nbsp;code&amp;nbsp;below&amp;nbsp;does&amp;nbsp;not&amp;nbsp;get&amp;nbsp;executed&amp;nbsp;when&amp;nbsp;we&amp;nbsp;redirect.&amp;nbsp;*/<br /></span><span style='color: #007700'>exit;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>replace</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The optional <i><tt class='parameter'>replace</tt></i> parameter indicates whether the header should replace a previous similar header, or add a second header of the same type. By default it will replace, but if you pass in <b><tt class='constant'>FALSE</tt></b> as the second argument you can force multiple headers of the same type. For example: </p> <p class='para'> </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 />header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'WWW-Authenticate:&amp;nbsp;Negotiate'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'WWW-Authenticate:&amp;nbsp;NTLM'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>http_response_code</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Forces the HTTP response code to the specified value. </p> </dd> </dl> <p> </p> </div> <a name='function.header.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.header.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.4.2 and 5.1.2</td> <td align='left'> This function now prevents more than one header to be sent at once as a protection against header injection attacks. </td> </tr> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> The <i><tt class='parameter'>http_response_code</tt></i> parameter was added. </td> </tr> <tr valign='middle'> <td align='left'>4.0.4</td> <td align='left'> The <i><tt class='parameter'>replace</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.header.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Download dialog</b></p> <div class='example-contents para'><p> If you want the user to be prompted to save the data you are sending, such as a generated PDF file, you can use the <a href='http://www.faqs.org/rfcs/rfc2183' class='link external'>&amp;raquo; Content-Disposition</a> header to supply a recommended filename and force the browser to display the save dialog. </p></div> <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;We'll&amp;nbsp;be&amp;nbsp;outputting&amp;nbsp;a&amp;nbsp;PDF<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;application/pdf'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;It&amp;nbsp;will&amp;nbsp;be&amp;nbsp;called&amp;nbsp;downloaded.pdf<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-Disposition:&amp;nbsp;attachment;&amp;nbsp;filename='downloaded.pdf''</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;The&amp;nbsp;PDF&amp;nbsp;source&amp;nbsp;is&amp;nbsp;in&amp;nbsp;original.pdf<br /></span><span style='color: #0000BB'>readfile</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'original.pdf'</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 Caching directives</b></p> <div class='example-contents para'><p> PHP scripts often generate dynamic content that must not be cached by the client browser or any proxy caches between the server and the client browser. Many proxies and clients can be forced to disable caching with: </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Cache-Control:&amp;nbsp;no-cache,&amp;nbsp;must-revalidate'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;HTTP/1.1<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Expires:&amp;nbsp;Sat,&amp;nbsp;26&amp;nbsp;Jul&amp;nbsp;1997&amp;nbsp;05:00:00&amp;nbsp;GMT'</span><span style='color: #007700'>);&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Date&amp;nbsp;in&amp;nbsp;the&amp;nbsp;past<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p> </p><blockquote><p><b class='note'>Note</b>: You may find that your pages aren&amp;#039;t cached even if you don&amp;#039;t output all of the headers above. There are a number of options that users may be able to set for their browser that change its default caching behavior. By sending the headers above, you should override any settings that may otherwise cause the output of your script to be cached. <br /> Additionally, <a href='http://www.php.net/manual/en/function.session-cache-limiter.php' class='function'>session_cache_limiter()</a> and the <i>session.cache_limiter</i> configuration setting can be used to automatically generate the correct caching-related headers when sessions are being used. <br /> </p></blockquote><p> </p></div> </div><p> </p> </div> <a name='function.header.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: As of PHP 4, you can use output buffering to get around this problem, with the overhead of all of your output to the browser being buffered in the server until you send it. You can do this by calling <a href='http://www.php.net/manual/en/function.ob-start.php' class='function'>ob_start()</a> and <a href='http://www.php.net/manual/en/function.ob-end-flush.php' class='function'>ob_end_flush()</a> in your script, or setting the <i>output_buffering</i> configuration directive on in your <var class='filename'>php.ini</var> or server configuration files. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: The HTTP status header line will always be the first sent to the client, regardless of the actual <b>header()</b> call being the first or not. The status may be overridden by calling <b>header()</b> with a new status line at any time unless the HTTP headers have already been sent. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: There is a bug in Microsoft Internet Explorer 4.01 that prevents this from working. There is no workaround. There is also a bug in Microsoft Internet Explorer 5.5 that interferes with this, which can be resolved by upgrading to Service Pack 2 or later. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> If <a href='http://www.php.net/manual/en/ini.sect.safe-mode.php#ini.safe-mode' class='link'>safe mode</a> is enabled the uid of the script is added to the <i>realm</i> part of the <i>WWW-Authenticate</i> header if you set this header (used for HTTP Authentication). </span> </p></blockquote> <blockquote><p><b class='note'>Note</b>: HTTP/1.1 requires an absolute <acronym title='Uniform Resource Identifier'>URI</acronym> as argument to <a href='http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30' class='link external'>&amp;raquo; Location:</a> including the scheme, hostname and absolute path, but some clients accept relative URIs. You can usually use <var class='varname'><a href='http://www.php.net/manual/en/reserved.variables.server.php' class='classname'>$_SERVER['HTTP_HOST']</a></var>, <var class='varname'><a href='http://www.php.net/manual/en/reserved.variables.server.php' class='classname'>$_SERVER['PHP_SELF']</a></var> and <a href='http://www.php.net/manual/en/function.dirname.php' class='function'>dirname()</a> to make an absolute URI from a relative one yourself: </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 /></span><span style='color: #FF8000'>/*&amp;nbsp;Redirect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;different&amp;nbsp;page&amp;nbsp;in&amp;nbsp;the&amp;nbsp;current&amp;nbsp;directory&amp;nbsp;that&amp;nbsp;was&amp;nbsp;requested&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$host&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$_SERVER</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'HTTP_HOST'</span><span style='color: #007700'>];<br /></span><span style='color: #0000BB'>$uri&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>rtrim</span><span style='color: #007700'>(</span><span style='color: #0000BB'>dirname</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$_SERVER</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'PHP_SELF'</span><span style='color: #007700'>]),&amp;nbsp;</span><span style='color: #DD0000'>'/\\'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$extra&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'mypage.php'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Location:&amp;nbsp;http://</span><span style='color: #0000BB'>$host$uri</span><span style='color: #DD0000'>/</span><span style='color: #0000BB'>$extra</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);<br />exit;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: Session ID is not passed with Location header even if <a href='http://www.php.net/manual/en/session.configuration.php#ini.session.use-trans-sid' class='link'>session.use_trans_sid</a> is enabled. It must by passed manually using <b><tt class='constant'>SID</tt></b> constant. <br /> </p></blockquote> </div> <a name='function.header.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.headers-sent.php' class='function' rel='rdfs-seeAlso'>headers_sent()</a> - Checks if or where headers have been sent</li> <li class='member'><a href='http://www.php.net/manual/en/function.setcookie.php' class='function' rel='rdfs-seeAlso'>setcookie()</a> - Send a cookie</li> <li class='member'> The section on <a href='http://www.php.net/manual/en/features.http-auth.php' class='link'>HTTP authentication</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> " />
</strings>

