cvs: phpdoc /en/reference/info/functions assert-options.xml assert.xml dl.xml extension-loaded.xml get-cfg-var.xml get-current-user.xml
get-defined-constants.xml get-extension-funcs.xml get-include-path.xml get-included-files.xml get-loaded-extensions.xml get-magic-quotes-gpc.xml
get-magic-quotes-runtime.xml getenv.xml getlastmod.xml getmygid.xml getmyinode.xml getmypid.xml getmyuid.xml getopt.xml getrusage.xml ini-get-all.xml
ini-get.xml ini-restore.xml ini-set.xml main.xml memory-get-peak-usage.xml memory-get-usage.xml php-ini-scanned-files.xml php-logo-guid.xml
php-sapi-name.xml php-uname.xml phpcredits.xml phpinfo.xml phpversion.xml putenv.xml restore-include-path.xml set-include-path.xml
set-magic-quotes-runtime.xml set-time-limit.xml sys-get-temp-dir.xml version-compare.xml zend-logo-guid.xml zend-version.xml

didou Sun Feb 4 22:42:28 2007 UTC Modified files: /phpdoc/en/reference/info/functions assert-options.xml assert.xml dl.xml extension-loaded.xml get-cfg-var.xml get-current-user.xml get-defined-constants.xml get-extension-funcs.xml get-include-path.xml get-included-files.xml get-loaded-extensions.xml get-magic-quotes-gpc.xml get-magic-quotes-runtime.xml getenv.xml getlastmod.xml getmygid.xml getmyinode.xml getmypid.xml getmyuid.xml getopt.xml getrusage.xml ini-get-all.xml ini-get.xml ini-restore.xml ini-set.xml main.xml memory-get-peak-usage.xml memory-get-usage.xml php-ini-scanned-files.xml php-logo-guid.xml php-sapi-name.xml php-uname.xml phpcredits.xml phpinfo.xml phpversion.xml putenv.xml restore-include-path.xml set-include-path.xml set-magic-quotes-runtime.xml set-time-limit.xml sys-get-temp-dir.xml version-compare.xml zend-logo-guid.xml zend-version.xml Log: WS, prepare for new docstyle

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/assert-options.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/info/functions/assert-options.xml diff -u phpdoc/en/reference/info/functions/assert-options.xml:1.3 phpdoc/en/reference/info/functions/assert-options.xml:1.4 --- phpdoc/en/reference/info/functions/assert-options.xml:1.3 Mon Jul 28 22:50:15 2003 +++ phpdoc/en/reference/info/functions/assert-options.xml Sun Feb 4 22:42:28 2007 @@ -1,77 +1,77 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.51 --> - <refentry id="function.assert-options"> - <refnamediv> - <refname>assert_options</refname> - <refpurpose>Set/get the various assert flags</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>assert_options</methodname> - <methodparam><type>int</type><parameter>what</parameter></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam> - </methodsynopsis> - <para> - Using <function>assert_options</function> you may set the various - <function>assert</function> control options or just query their - current settings. - </para> - <table> - <title>Assert Options</title> - <tgroup cols="4"> - <thead> - <row> - <entry>option</entry> - <entry>ini-parameter</entry> - <entry>default</entry> - <entry>description</entry> - </row> - </thead> - <tbody> - <row> - <entry>ASSERT_ACTIVE</entry> - <entry>assert.active</entry> - <entry>1</entry> - <entry>enable <function>assert</function> evaluation</entry> - </row> - <row> - <entry>ASSERT_WARNING</entry> - <entry>assert.warning</entry> - <entry>1</entry> - <entry>issue a PHP warning for each failed assertion</entry> - </row> - <row> - <entry>ASSERT_BAIL</entry> - <entry>assert.bail</entry> - <entry>0</entry> - <entry>terminate execution on failed assertions</entry> - </row> - <row> - <entry>ASSERT_QUIET_EVAL</entry> - <entry>assert.quiet_eval</entry> - <entry>0</entry> - <entry> - disable error_reporting during assertion expression - evaluation - </entry> - </row> - <row> - <entry>ASSERT_CALLBACK</entry> - <entry>assert.callback</entry> - <entry>(&null;)</entry> - <entry>user function to call on failed assertions</entry> - </row> - </tbody> - </tgroup> - </table> - <para> - <function>assert_options</function> will return the original - setting of any option or &false; on errors. - </para> - </refsect1> - </refentry> +<refentry id="function.assert-options"> + <refnamediv> + <refname>assert_options</refname> + <refpurpose>Set/get the various assert flags</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>mixed</type><methodname>assert_options</methodname> + <methodparam><type>int</type><parameter>what</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam> + </methodsynopsis> + <para> + Using <function>assert_options</function> you may set the various + <function>assert</function> control options or just query their + current settings. + </para> + <table> + <title>Assert Options</title> + <tgroup cols="4"> + <thead> + <row> + <entry>option</entry> + <entry>ini-parameter</entry> + <entry>default</entry> + <entry>description</entry> + </row> + </thead> + <tbody> + <row> + <entry>ASSERT_ACTIVE</entry> + <entry>assert.active</entry> + <entry>1</entry> + <entry>enable <function>assert</function> evaluation</entry> + </row> + <row> + <entry>ASSERT_WARNING</entry> + <entry>assert.warning</entry> + <entry>1</entry> + <entry>issue a PHP warning for each failed assertion</entry> + </row> + <row> + <entry>ASSERT_BAIL</entry> + <entry>assert.bail</entry> + <entry>0</entry> + <entry>terminate execution on failed assertions</entry> + </row> + <row> + <entry>ASSERT_QUIET_EVAL</entry> + <entry>assert.quiet_eval</entry> + <entry>0</entry> + <entry> + disable error_reporting during assertion expression + evaluation + </entry> + </row> + <row> + <entry>ASSERT_CALLBACK</entry> + <entry>assert.callback</entry> + <entry>(&null;)</entry> + <entry>user function to call on failed assertions</entry> + </row> + </tbody> + </tgroup> + </table> + <para> + <function>assert_options</function> will return the original + setting of any option or &false; on errors. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/assert.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/info/functions/assert.xml diff -u phpdoc/en/reference/info/functions/assert.xml:1.8 phpdoc/en/reference/info/functions/assert.xml:1.9 --- phpdoc/en/reference/info/functions/assert.xml:1.8 Thu Jun 23 16:53:18 2005 +++ phpdoc/en/reference/info/functions/assert.xml Sun Feb 4 22:42:28 2007 @@ -1,78 +1,78 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.51 --> - <refentry id="function.assert"> - <refnamediv> - <refname>assert</refname> - <refpurpose>Checks if assertion is &false;</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>assert</methodname> - <methodparam><type>mixed</type><parameter>assertion</parameter></methodparam> - </methodsynopsis> - <para> - <function>assert</function> will check the given - <parameter>assertion</parameter> and take appropriate action if - its result is &false;. - </para> - <para> - If the <parameter>assertion</parameter> is given as a string it - will be evaluated as PHP code by <function>assert</function>. - The advantages of a string <parameter>assertion</parameter> are - less overhead when assertion checking is off and messages - containing the <parameter>assertion</parameter> expression when - an assertion fails. This means that if you pass a boolean condition - as <parameter>assertion</parameter> this condition will not show up as - parameter to the assertion function which you may have defined with the - <function>assert_options</function> function, the condition is converted - to a string before calling that handler function, and the boolean &false; - is converted as the empty string. - </para> - <para> - Assertions should be used as a debugging feature only. You may - use them for sanity-checks that test for conditions that should - always be &true; and that indicate some programming errors if not - or to check for the presence of certain features like extension - functions or certain system limits and features. - </para> - <para> - Assertions should not be used for normal runtime operations like - input parameter checks. As a rule of thumb your code should - always be able to work correctly if assertion checking is not - activated. - </para> - <para> - The behavior of <function>assert</function> may be configured by - <function>assert_options</function> or by .ini-settings described - in that functions manual page. - </para> - <para> - The <function>assert_options</function> function and/or - ASSERT_CALLBACK configuration directive allow a callback function - to be set to handle failed assertions. - </para> - <para> - <function>assert</function> callbacks are particularly useful for - building automated test suites because they allow you to easily - capture the code passed to the assertion, along with information - on where the assertion was made. While this information can be - captured via other methods, using assertions makes it much faster - and easier! - </para> - <para> - The callback function should accept three arguments. The first - argument will contain the file the assertion failed in. The - second argument will contain the line the assertion failed on and - the third argument will contain the expression that failed (if - any - literal values such as 1 or "two" will not be passed via - this argument) - </para> - <para> - <example> - <title>Handle a failed assertion with a custom handler</title> - <programlisting role="php"> +<refentry id="function.assert"> + <refnamediv> + <refname>assert</refname> + <refpurpose>Checks if assertion is &false;</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>assert</methodname> + <methodparam><type>mixed</type><parameter>assertion</parameter></methodparam> + </methodsynopsis> + <para> + <function>assert</function> will check the given + <parameter>assertion</parameter> and take appropriate action if + its result is &false;. + </para> + <para> + If the <parameter>assertion</parameter> is given as a string it + will be evaluated as PHP code by <function>assert</function>. + The advantages of a string <parameter>assertion</parameter> are + less overhead when assertion checking is off and messages + containing the <parameter>assertion</parameter> expression when + an assertion fails. This means that if you pass a boolean condition + as <parameter>assertion</parameter> this condition will not show up as + parameter to the assertion function which you may have defined with the + <function>assert_options</function> function, the condition is converted + to a string before calling that handler function, and the boolean &false; + is converted as the empty string. + </para> + <para> + Assertions should be used as a debugging feature only. You may + use them for sanity-checks that test for conditions that should + always be &true; and that indicate some programming errors if not + or to check for the presence of certain features like extension + functions or certain system limits and features. + </para> + <para> + Assertions should not be used for normal runtime operations like + input parameter checks. As a rule of thumb your code should + always be able to work correctly if assertion checking is not + activated. + </para> + <para> + The behavior of <function>assert</function> may be configured by + <function>assert_options</function> or by .ini-settings described + in that functions manual page. + </para> + <para> + The <function>assert_options</function> function and/or + ASSERT_CALLBACK configuration directive allow a callback function + to be set to handle failed assertions. + </para> + <para> + <function>assert</function> callbacks are particularly useful for + building automated test suites because they allow you to easily + capture the code passed to the assertion, along with information + on where the assertion was made. While this information can be + captured via other methods, using assertions makes it much faster + and easier! + </para> + <para> + The callback function should accept three arguments. The first + argument will contain the file the assertion failed in. The + second argument will contain the line the assertion failed on and + the third argument will contain the expression that failed (if + any - literal values such as 1 or "two" will not be passed via + this argument) + </para> + <para> + <example> + <title>Handle a failed assertion with a custom handler</title> + <programlisting role="php"> <![CDATA[ <?php // Active assert and make it quiet @@ -81,7 +81,7 @@ assert_options(ASSERT_QUIET_EVAL, 1); // Create a handler function -function my_assert_handler($file, $line, $code) +function my_assert_handler($file, $line, $code) { echo "<hr>Assertion Failed: File '$file'<br /> @@ -96,11 +96,11 @@ assert('mysql_query("")'); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/dl.xml?r1=1.23&r2=1.24&diff_format=u Index: phpdoc/en/reference/info/functions/dl.xml diff -u phpdoc/en/reference/info/functions/dl.xml:1.23 phpdoc/en/reference/info/functions/dl.xml:1.24 --- phpdoc/en/reference/info/functions/dl.xml:1.23 Mon Sep 18 14:17:49 2006 +++ phpdoc/en/reference/info/functions/dl.xml Sun Feb 4 22:42:28 2007 @@ -1,51 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.23 $ --> +<!-- $Revision: 1.24 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.29 --> - <refentry id="function.dl"> - <refnamediv> - <refname>dl</refname> - <refpurpose>Loads a PHP extension at runtime</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>dl</methodname> - <methodparam><type>string</type><parameter>library</parameter></methodparam> - </methodsynopsis> - <para> - Loads the PHP extension given by the parameter - <parameter>library</parameter>. The <parameter>library</parameter> - parameter is <emphasis>only</emphasis> the filename of the extension to - load which also depends on your platform. For example, the <link - linkend="ref.sockets">sockets</link> extension (if compiled as a shared - module, not the default!) would be called <filename>sockets.so</filename> - on Unix platforms whereas it is called - <filename>php_sockets.dll</filename> on the Windows platform. - </para> - <para> - &return.success; If the functionality of loading modules is not available - (see Note) or has been disabled (either by turning it off - <literal>enable_dl</literal> or by enabling &safemode; - in &php.ini;) an <constant>E_ERROR</constant> is emitted - and execution is stopped. If <function>dl</function> fails because the - specified library couldn't be loaded, in addition to &false; an - <constant>E_WARNING</constant> message is emitted. - </para> - <para> - Use <function>extension_loaded</function> to test whether a given - extension is already available or not. This works on both built-in - extensions and dynamically loaded ones (either through &php.ini; - or <function>dl</function>). - </para> - <para> - As of PHP 5, the <function>dl</function> function is deprecated in every - SAPI <emphasis>except</emphasis> <acronym>CLI</acronym>. - Use <link linkend="ini.extension">Extension Loading Directives</link> - method instead. - </para> - <example> - <title><function>dl</function> examples</title> - <programlisting role="php"> +<refentry id="function.dl"> + <refnamediv> + <refname>dl</refname> + <refpurpose>Loads a PHP extension at runtime</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>dl</methodname> + <methodparam><type>string</type><parameter>library</parameter></methodparam> + </methodsynopsis> + <para> + Loads the PHP extension given by the parameter + <parameter>library</parameter>. The <parameter>library</parameter> + parameter is <emphasis>only</emphasis> the filename of the extension to + load which also depends on your platform. For example, the <link + linkend="ref.sockets">sockets</link> extension (if compiled as a shared + module, not the default!) would be called <filename>sockets.so</filename> + on Unix platforms whereas it is called + <filename>php_sockets.dll</filename> on the Windows platform. + </para> + <para> + &return.success; If the functionality of loading modules is not available + (see Note) or has been disabled (either by turning it off + <literal>enable_dl</literal> or by enabling &safemode; + in &php.ini;) an <constant>E_ERROR</constant> is emitted + and execution is stopped. If <function>dl</function> fails because the + specified library couldn't be loaded, in addition to &false; an + <constant>E_WARNING</constant> message is emitted. + </para> + <para> + Use <function>extension_loaded</function> to test whether a given + extension is already available or not. This works on both built-in + extensions and dynamically loaded ones (either through &php.ini; + or <function>dl</function>). + </para> + <para> + As of PHP 5, the <function>dl</function> function is deprecated in every + SAPI <emphasis>except</emphasis> <acronym>CLI</acronym>. + Use <link linkend="ini.extension">Extension Loading Directives</link> + method instead. + </para> + <example> + <title><function>dl</function> examples</title> + <programlisting role="php"> <![CDATA[ <?php // Example loading an extension based on OS @@ -64,76 +64,76 @@ } ?> ]]> - </programlisting> - </example> - <para> - The directory where the extension is loaded from depends on your - platform: - </para> - <para> - Windows - If not explicitly set in the &php.ini;, the extension is - loaded from <filename>c:\php4\extensions\</filename> by default. - </para> - <para> - Unix - If not explicitly set in the &php.ini;, the default extension - directory depends on - <itemizedlist> - <listitem> - <simpara> - whether PHP has been built with <literal>--enable-debug</literal> or - not - </simpara> - </listitem> - <listitem> - <simpara> - whether PHP has been built with (experimental) ZTS (Zend Thread Safety) - support or not - </simpara> - </listitem> - <listitem> - <simpara> - the current internal <literal>ZEND_MODULE_API_NO</literal> (Zend - internal module API number, which is basically the date on which a - major module API change happened, e.g. <literal>20010901</literal>) - </simpara> - </listitem> - </itemizedlist> - Taking into account the above, the directory then defaults to - <literal>&lt;install-dir&gt;/lib/php/extensions/ &lt;debug-or-not&gt;-&lt;zts-or-not&gt;-ZEND_MODULE_API_NO</literal>, - e.g. - <filename>/usr/local/php/lib/php/extensions/debug-non-zts-20010901</filename> - or - <filename>/usr/local/php/lib/php/extensions/no-debug-zts-20010901</filename>. - </para> - <note> - <para> - <function>dl</function> is <emphasis>not</emphasis> supported in - multithreaded Web servers. Use the <literal>extensions</literal> - statement in your &php.ini; when operating under such - an environment. However, the <literal>CGI</literal> and - <literal>CLI</literal> build are <emphasis role="strong">not</emphasis> - affected ! - </para> - </note> - <note> - <para> - Since PHP 6 this function is disabled in all SAPIs, except CLI, CGI and - embed. - </para> - </note> - <note> - <para> - <function>dl</function> is case sensitive on Unix platforms. - </para> - </note> - &note.sm.disabled; - <para> - See also - <link linkend="ini.extension">Extension Loading Directives</link> - and <function>extension_loaded</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + <para> + The directory where the extension is loaded from depends on your + platform: + </para> + <para> + Windows - If not explicitly set in the &php.ini;, the extension is + loaded from <filename>c:\php4\extensions\</filename> by default. + </para> + <para> + Unix - If not explicitly set in the &php.ini;, the default extension + directory depends on + <itemizedlist> + <listitem> + <simpara> + whether PHP has been built with <literal>--enable-debug</literal> or + not + </simpara> + </listitem> + <listitem> + <simpara> + whether PHP has been built with (experimental) ZTS (Zend Thread Safety) + support or not + </simpara> + </listitem> + <listitem> + <simpara> + the current internal <literal>ZEND_MODULE_API_NO</literal> (Zend + internal module API number, which is basically the date on which a + major module API change happened, e.g. <literal>20010901</literal>) + </simpara> + </listitem> + </itemizedlist> + Taking into account the above, the directory then defaults to + <literal>&lt;install-dir&gt;/lib/php/extensions/ &lt;debug-or-not&gt;-&lt;zts-or-not&gt;-ZEND_MODULE_API_NO</literal>, + e.g. + <filename>/usr/local/php/lib/php/extensions/debug-non-zts-20010901</filename> + or + <filename>/usr/local/php/lib/php/extensions/no-debug-zts-20010901</filename>. + </para> + <note> + <para> + <function>dl</function> is <emphasis>not</emphasis> supported in + multithreaded Web servers. Use the <literal>extensions</literal> + statement in your &php.ini; when operating under such + an environment. However, the <literal>CGI</literal> and + <literal>CLI</literal> build are <emphasis role="strong">not</emphasis> + affected ! + </para> + </note> + <note> + <para> + Since PHP 6 this function is disabled in all SAPIs, except CLI, CGI and + embed. + </para> + </note> + <note> + <para> + <function>dl</function> is case sensitive on Unix platforms. + </para> + </note> + &note.sm.disabled; + <para> + See also + <link linkend="ini.extension">Extension Loading Directives</link> + and <function>extension_loaded</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/extension-loaded.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/info/functions/extension-loaded.xml diff -u phpdoc/en/reference/info/functions/extension-loaded.xml:1.8 phpdoc/en/reference/info/functions/extension-loaded.xml:1.9 --- phpdoc/en/reference/info/functions/extension-loaded.xml:1.8 Tue Aug 10 16:30:18 2004 +++ phpdoc/en/reference/info/functions/extension-loaded.xml Sun Feb 4 22:42:28 2007 @@ -1,25 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.extension-loaded"> - <refnamediv> - <refname>extension_loaded</refname> - <refpurpose>Find out whether an extension is loaded</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>extension_loaded</methodname> - <methodparam><type>string</type><parameter>name</parameter></methodparam> - </methodsynopsis> - <para> - Returns &true; if the extension identified by <parameter>name</parameter> - is loaded, &false; otherwise. - </para> - <para> - <example> - <title><function>extension_loaded</function> example</title> - <programlisting role="php"> +<refentry id="function.extension-loaded"> + <refnamediv> + <refname>extension_loaded</refname> + <refpurpose>Find out whether an extension is loaded</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>extension_loaded</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + </methodsynopsis> + <para> + Returns &true; if the extension identified by <parameter>name</parameter> + is loaded, &false; otherwise. + </para> + <para> + <example> + <title><function>extension_loaded</function> example</title> + <programlisting role="php"> <![CDATA[ <?php if (!extension_loaded('gd')) { @@ -29,16 +29,16 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - You can see the names of various extensions by using - <function>phpinfo</function> or if you're using the - <literal>CGI</literal> or <literal>CLI</literal> version of - PHP you can use the <option>-m</option> switch to - list all available extensions: - <screen> + </programlisting> + </example> + </para> + <para> + You can see the names of various extensions by using + <function>phpinfo</function> or if you're using the + <literal>CGI</literal> or <literal>CLI</literal> version of + PHP you can use the <option>-m</option> switch to + list all available extensions: + <screen> <![CDATA[ $ php -m [PHP Modules] @@ -56,26 +56,26 @@ [Zend Modules] ]]> - </screen> - </para> - <note> - <para> - <function>extension_loaded</function> uses the internal extension name - to test whether a certain extension is available or not. Most internal - extension names are written in lower case but there may be extension - available which also use uppercase letters. Be warned that this - function compares <emphasis role="strong">case sensitive</emphasis> ! - </para> - </note> - <para> - See also - <function>get_loaded_extensions</function>, - <function>get_extension_funcs</function>, - <function>phpinfo</function>, and - <function>dl</function>. - </para> - </refsect1> - </refentry> + </screen> + </para> + <note> + <para> + <function>extension_loaded</function> uses the internal extension name + to test whether a certain extension is available or not. Most internal + extension names are written in lower case but there may be extension + available which also use uppercase letters. Be warned that this + function compares <emphasis role="strong">case sensitive</emphasis> ! + </para> + </note> + <para> + See also + <function>get_loaded_extensions</function>, + <function>get_extension_funcs</function>, + <function>phpinfo</function>, and + <function>dl</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/get-cfg-var.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/info/functions/get-cfg-var.xml diff -u phpdoc/en/reference/info/functions/get-cfg-var.xml:1.4 phpdoc/en/reference/info/functions/get-cfg-var.xml:1.5 --- phpdoc/en/reference/info/functions/get-cfg-var.xml:1.4 Thu Dec 18 11:47:08 2003 +++ phpdoc/en/reference/info/functions/get-cfg-var.xml Sun Feb 4 22:42:28 2007 @@ -1,41 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.get-cfg-var"> - <refnamediv> - <refname>get_cfg_var</refname> - <refpurpose> - Gets the value of a PHP configuration option - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>get_cfg_var</methodname> - <methodparam><type>string</type><parameter>varname</parameter></methodparam> - </methodsynopsis> - <simpara> - Returns the current value of the PHP configuration variable - specified by <parameter>varname</parameter>, or &false; if an - error occurs. - </simpara> - <simpara> - It will not return configuration information set when the PHP was - compiled, or read from an Apache configuration file (using the - php3_configuration_option directives). - </simpara> - <simpara> - To check whether the system is using a <link - linkend="configuration.file">configuration file</link>, try - retrieving the value of the cfg_file_path configuration - setting. If this is available, a configuration file is being - used. - </simpara> - <simpara> - See also <function>ini_get</function>. - </simpara> - </refsect1> - </refentry> +<refentry id="function.get-cfg-var"> + <refnamediv> + <refname>get_cfg_var</refname> + <refpurpose>Gets the value of a PHP configuration option</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>get_cfg_var</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> + <simpara> + Returns the current value of the PHP configuration variable + specified by <parameter>varname</parameter>, or &false; if an + error occurs. + </simpara> + <simpara> + It will not return configuration information set when the PHP was + compiled, or read from an Apache configuration file (using the + php3_configuration_option directives). + </simpara> + <simpara> + To check whether the system is using a <link + linkend="configuration.file">configuration file</link>, try + retrieving the value of the cfg_file_path configuration + setting. If this is available, a configuration file is being + used. + </simpara> + <simpara> + See also <function>ini_get</function>. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/get-current-user.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/info/functions/get-current-user.xml diff -u phpdoc/en/reference/info/functions/get-current-user.xml:1.4 phpdoc/en/reference/info/functions/get-current-user.xml:1.5 --- phpdoc/en/reference/info/functions/get-current-user.xml:1.4 Thu Dec 18 11:47:08 2003 +++ phpdoc/en/reference/info/functions/get-current-user.xml Sun Feb 4 22:42:28 2007 @@ -1,30 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.get-current-user"> - <refnamediv> - <refname>get_current_user</refname> - <refpurpose> - Gets the name of the owner of the current PHP script - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>get_current_user</methodname> - <void/> - </methodsynopsis> - <simpara> - Returns the name of the owner of the current PHP script. - </simpara> - <simpara> - See also <function>getmyuid</function>, - <function>getmygid</function>, <function>getmypid</function>, - <function>getmyinode</function>, and - <function>getlastmod</function>. - </simpara> - </refsect1> - </refentry> +<refentry id="function.get-current-user"> + <refnamediv> + <refname>get_current_user</refname> + <refpurpose>Gets the name of the owner of the current PHP script</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>get_current_user</methodname> + <void/> + </methodsynopsis> + <simpara> + Returns the name of the owner of the current PHP script. + </simpara> + <simpara> + See also <function>getmyuid</function>, + <function>getmygid</function>, <function>getmypid</function>, + <function>getmyinode</function>, and + <function>getlastmod</function>. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/get-defined-constants.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/info/functions/get-defined-constants.xml diff -u phpdoc/en/reference/info/functions/get-defined-constants.xml:1.9 phpdoc/en/reference/info/functions/get-defined-constants.xml:1.10 --- phpdoc/en/reference/info/functions/get-defined-constants.xml:1.9 Wed Aug 18 16:17:01 2004 +++ phpdoc/en/reference/info/functions/get-defined-constants.xml Sun Feb 4 22:42:28 2007 @@ -1,40 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.71 --> - <refentry id="function.get-defined-constants"> - <refnamediv> - <refname>get_defined_constants</refname> - <refpurpose> - Returns an associative array with the names of all the constants - and their values - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>get_defined_constants</methodname> - <methodparam choice="opt"><type>mixed</type><parameter>categorize</parameter></methodparam> - </methodsynopsis> - <para> - This function returns the names and values of all the constants - currently defined. This includes those created by extensions as - well as those created with the <function>define</function> - function. - </para> - <para> - For example the line below: - <informalexample> - <programlisting role="php"> +<refentry id="function.get-defined-constants"> + <refnamediv> + <refname>get_defined_constants</refname> + <refpurpose>Returns an associative array with the names of all the constants and their values</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>get_defined_constants</methodname> + <methodparam choice="opt"><type>mixed</type><parameter>categorize</parameter></methodparam> + </methodsynopsis> + <para> + This function returns the names and values of all the constants + currently defined. This includes those created by extensions as + well as those created with the <function>define</function> + function. + </para> + <para> + For example the line below: + <informalexample> + <programlisting role="php"> <![CDATA[ <?php print_r(get_defined_constants()); ?> ]]> - </programlisting> - <para> - will print a list like: - </para> - <screen> + </programlisting> + <para> + will print a list like: + </para> + <screen> <![CDATA[ Array ( @@ -53,25 +50,25 @@ [TRUE] => 1 ) ]]> - </screen> - </informalexample> - </para> - <para> - As of PHP 5, an additional parameter, <parameter>categorize</parameter>, - may be passed, causing this function to return a multi-dimensional array - with categories in the keys of the first dimension and - constants and their values in the second dimension. - <informalexample> - <programlisting role="php"> + </screen> + </informalexample> + </para> + <para> + As of PHP 5, an additional parameter, <parameter>categorize</parameter>, + may be passed, causing this function to return a multi-dimensional array + with categories in the keys of the first dimension and + constants and their values in the second dimension. + <informalexample> + <programlisting role="php"> <![CDATA[ <?php define("MY_CONSTANT", 1); print_r(get_defined_constants(true)); ?> ]]> - </programlisting> - &example.outputs.similar; - <screen> + </programlisting> + &example.outputs.similar; + <screen> <![CDATA[ Array ( @@ -110,24 +107,24 @@ ) ]]> - </screen> - </informalexample> - <note> - <para> - The value of the <parameter>categorize</parameter> parameter is irrelevant, - only its presence is considered. - </para> - </note> - </para> + </screen> + </informalexample> + <note> <para> - See also - <function>defined</function>, - <function>get_loaded_extensions</function>, - <function>get_defined_functions</function>, and - <function>get_defined_vars</function>. + The value of the <parameter>categorize</parameter> parameter is irrelevant, + only its presence is considered. </para> - </refsect1> - </refentry> + </note> + </para> + <para> + See also + <function>defined</function>, + <function>get_loaded_extensions</function>, + <function>get_defined_functions</function>, and + <function>get_defined_vars</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/get-extension-funcs.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/info/functions/get-extension-funcs.xml diff -u phpdoc/en/reference/info/functions/get-extension-funcs.xml:1.7 phpdoc/en/reference/info/functions/get-extension-funcs.xml:1.8 --- phpdoc/en/reference/info/functions/get-extension-funcs.xml:1.7 Thu Jul 15 11:11:55 2004 +++ phpdoc/en/reference/info/functions/get-extension-funcs.xml Sun Feb 4 22:42:28 2007 @@ -1,51 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.71 --> - <refentry id="function.get-extension-funcs"> - <refnamediv> - <refname>get_extension_funcs</refname> - <refpurpose> - Returns an array with the names of the functions of a module - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>get_extension_funcs</methodname> - <methodparam><type>string</type><parameter>module_name</parameter></methodparam> - </methodsynopsis> - <para> - This function returns the names of all the functions defined in - the module indicated by <parameter>module_name</parameter>. - </para> - <note> - <para> - The <parameter>module_name</parameter> parameter must be in - <emphasis>lowercase</emphasis>. - </para> - </note> - <para> - For example the lines below - <informalexample> - <programlisting role="php"> +<refentry id="function.get-extension-funcs"> + <refnamediv> + <refname>get_extension_funcs</refname> + <refpurpose>Returns an array with the names of the functions of a module</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>get_extension_funcs</methodname> + <methodparam><type>string</type><parameter>module_name</parameter></methodparam> + </methodsynopsis> + <para> + This function returns the names of all the functions defined in + the module indicated by <parameter>module_name</parameter>. + </para> + <note> + <para> + The <parameter>module_name</parameter> parameter must be in + <emphasis>lowercase</emphasis>. + </para> + </note> + <para> + For example the lines below + <informalexample> + <programlisting role="php"> <![CDATA[ <?php print_r(get_extension_funcs("xml")); print_r(get_extension_funcs("gd")); ?> ]]> - </programlisting> - <para> - will print a list of the functions in the modules - <varname>xml</varname> and <varname>gd</varname> respectively. - </para> - </informalexample> - </para> + </programlisting> <para> - See also: <function>get_loaded_extensions</function> + will print a list of the functions in the modules + <varname>xml</varname> and <varname>gd</varname> respectively. </para> - </refsect1> - </refentry> + </informalexample> + </para> + <para> + See also: <function>get_loaded_extensions</function> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/get-include-path.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/info/functions/get-include-path.xml diff -u phpdoc/en/reference/info/functions/get-include-path.xml:1.5 phpdoc/en/reference/info/functions/get-include-path.xml:1.6 --- phpdoc/en/reference/info/functions/get-include-path.xml:1.5 Mon Dec 15 16:51:14 2003 +++ phpdoc/en/reference/info/functions/get-include-path.xml Sun Feb 4 22:42:28 2007 @@ -1,26 +1,24 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.get-include-path"> - <refnamediv> - <refname>get_include_path</refname> - <refpurpose> - Gets the current include_path configuration option - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>get_include_path</methodname> - <void /> - </methodsynopsis> - <simpara> - Gets the current <link linkend="ini.include-path">include_path</link> - configuration option value. - </simpara> - <para> - <example> - <title><function>get_include_path</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.6 $ --> +<refentry id="function.get-include-path"> + <refnamediv> + <refname>get_include_path</refname> + <refpurpose>Gets the current include_path configuration option</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>get_include_path</methodname> + <void /> + </methodsynopsis> + <simpara> + Gets the current <link linkend="ini.include-path">include_path</link> + configuration option value. + </simpara> + <para> + <example> + <title><function>get_include_path</function> example</title> + <programlisting role="php"> <![CDATA[ <?php // Works as of PHP 4.3.0 @@ -30,17 +28,17 @@ echo ini_get('include_path'); ?> ]]> - </programlisting> - </example> - </para> - <simpara> - See also <function>ini_get</function>, - <function>restore_include_path</function>, - <function>set_include_path</function>, and - <function>include</function>. - </simpara> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <simpara> + See also <function>ini_get</function>, + <function>restore_include_path</function>, + <function>set_include_path</function>, and + <function>include</function>. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/get-included-files.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/info/functions/get-included-files.xml diff -u phpdoc/en/reference/info/functions/get-included-files.xml:1.9 phpdoc/en/reference/info/functions/get-included-files.xml:1.10 --- phpdoc/en/reference/info/functions/get-included-files.xml:1.9 Thu Feb 1 00:46:02 2007 +++ phpdoc/en/reference/info/functions/get-included-files.xml Sun Feb 4 22:42:28 2007 @@ -1,44 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.71 --> - <refentry id="function.get-included-files"> - <refnamediv> - <refname>get_included_files</refname> - <refpurpose> - Returns an array with the names of included or required files - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>get_included_files</methodname> - <void/> - </methodsynopsis> - <para> - Returns an array of the names of all files that have been - included using <function>include</function>, - <function>include_once</function>, <function>require</function> - or <function>require_once</function>. - </para> - <para> - The script originally called is considered an "included file," so - it will be listed together with the files referenced by - <function>include</function> and family. - </para> - <para> - Files that are included or required multiple times only show up - once in the returned array. - </para> - <note> - <para> - Files included using the <literal>auto_prepend_file</literal> - configuration directive are not included in the returned array. - </para> - </note> - <para> - <example> - <title><function>get_included_files</function> example (<filename>abc.php</filename>)</title> - <programlisting role="php"> +<refentry id="function.get-included-files"> + <refnamediv> + <refname>get_included_files</refname> + <refpurpose>Returns an array with the names of included or required files</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>get_included_files</methodname> + <void/> + </methodsynopsis> + <para> + Returns an array of the names of all files that have been + included using <function>include</function>, + <function>include_once</function>, <function>require</function> + or <function>require_once</function>. + </para> + <para> + The script originally called is considered an "included file," so + it will be listed together with the files referenced by + <function>include</function> and family. + </para> + <para> + Files that are included or required multiple times only show up + once in the returned array. + </para> + <note> + <para> + Files included using the <literal>auto_prepend_file</literal> + configuration directive are not included in the returned array. + </para> + </note> + <para> + <example> + <title><function>get_included_files</function> example (<filename>abc.php</filename>)</title> + <programlisting role="php"> <![CDATA[ <?php @@ -55,11 +53,11 @@ ?> ]]> - </programlisting> - <para> - will generate the following output: - </para> - <screen> + </programlisting> + <para> + will generate the following output: + </para> + <screen> <![CDATA[ abc.php test1.php @@ -67,30 +65,30 @@ test3.php test4.php ]]> - </screen> - </example> - </para> - <note> - <para> - In PHP 4.0.1 and previous versions - <function>get_included_files</function> assumed that the - required files ended in the extension <literal>.php</literal>; - other extensions would not be returned. The array returned by - <function>get_included_files</function> was an associative array - and only listed files included by <function>include</function> - and <function>include_once</function>. - </para> - </note> - <para> - See also - <function>include</function>, - <function>include_once</function>, - <function>require</function>, - <function>require_once</function>, and - <function>get_required_files</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <note> + <para> + In PHP 4.0.1 and previous versions + <function>get_included_files</function> assumed that the + required files ended in the extension <literal>.php</literal>; + other extensions would not be returned. The array returned by + <function>get_included_files</function> was an associative array + and only listed files included by <function>include</function> + and <function>include_once</function>. + </para> + </note> + <para> + See also + <function>include</function>, + <function>include_once</function>, + <function>require</function>, + <function>require_once</function>, and + <function>get_required_files</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/get-loaded-extensions.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/info/functions/get-loaded-extensions.xml diff -u phpdoc/en/reference/info/functions/get-loaded-extensions.xml:1.8 phpdoc/en/reference/info/functions/get-loaded-extensions.xml:1.9 --- phpdoc/en/reference/info/functions/get-loaded-extensions.xml:1.8 Thu Dec 18 11:47:08 2003 +++ phpdoc/en/reference/info/functions/get-loaded-extensions.xml Sun Feb 4 22:42:28 2007 @@ -1,38 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.71 --> - <refentry id="function.get-loaded-extensions"> - <refnamediv> - <refname>get_loaded_extensions</refname> - <refpurpose> - Returns an array with the names of all modules compiled and - loaded - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>get_loaded_extensions</methodname> - <void/> - </methodsynopsis> - <para> - This function returns the names of all the modules compiled and - loaded in the PHP interpreter. - </para> - <para> - For example the line below - <informalexample> - <programlisting role="php"> +<refentry id="function.get-loaded-extensions"> + <refnamediv> + <refname>get_loaded_extensions</refname> + <refpurpose>Returns an array with the names of all modules compiled and loaded</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>get_loaded_extensions</methodname> + <void/> + </methodsynopsis> + <para> + This function returns the names of all the modules compiled and + loaded in the PHP interpreter. + </para> + <para> + For example the line below + <informalexample> + <programlisting role="php"> <![CDATA[ <?php print_r(get_loaded_extensions()); ?> ]]> - </programlisting> - <para> - will print a list like: - </para> - <screen> + </programlisting> + <para> + will print a list like: + </para> + <screen> <![CDATA[ Array ( @@ -50,18 +47,18 @@ [11] => bcmath ) ]]> - </screen> - </informalexample> - </para> - <para> - See also - <function>get_extension_funcs</function>, - <function>extension_loaded</function>, - <function>dl</function>, and - <function>phpinfo</function>. - </para> - </refsect1> - </refentry> + </screen> + </informalexample> + </para> + <para> + See also + <function>get_extension_funcs</function>, + <function>extension_loaded</function>, + <function>dl</function>, and + <function>phpinfo</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/get-magic-quotes-gpc.xml?r1=1.15&r2=1.16&diff_format=u Index: phpdoc/en/reference/info/functions/get-magic-quotes-gpc.xml diff -u phpdoc/en/reference/info/functions/get-magic-quotes-gpc.xml:1.15 phpdoc/en/reference/info/functions/get-magic-quotes-gpc.xml:1.16 --- phpdoc/en/reference/info/functions/get-magic-quotes-gpc.xml:1.15 Fri Mar 4 19:19:06 2005 +++ phpdoc/en/reference/info/functions/get-magic-quotes-gpc.xml Sun Feb 4 22:42:28 2007 @@ -1,43 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.15 $ --> +<!-- $Revision: 1.16 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.get-magic-quotes-gpc"> - <refnamediv> - <refname>get_magic_quotes_gpc</refname> - <refpurpose> - Gets the current configuration setting of magic quotes gpc - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>get_magic_quotes_gpc</methodname> - <void/> - </methodsynopsis> - <simpara> - Returns the current configuration setting of <link - linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link> (0 for - off, 1 for on). - </simpara> - <note> - <para> - If the directive <link linkend="ini.magic-quotes-sybase"> - magic_quotes_sybase</link> is ON it will completely override - <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>. So even - when <function>get_magic_quotes_gpc</function> returns - &true; neither double quotes, backslashes or NUL's will - be escaped. Only single quotes will be escaped. In this - case they'll look like: <emphasis>''</emphasis> - </para> - </note> - <simpara> - Keep in mind that the setting <link linkend="ini.magic-quotes-gpc"> - magic_quotes_gpc</link> will not work at runtime. - </simpara> - <para> - <example> - <title><function>get_magic_quotes_gpc</function> example</title> - <programlisting role="php"> +<refentry id="function.get-magic-quotes-gpc"> + <refnamediv> + <refname>get_magic_quotes_gpc</refname> + <refpurpose>Gets the current configuration setting of magic quotes gpc</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>get_magic_quotes_gpc</methodname> + <void/> + </methodsynopsis> + <simpara> + Returns the current configuration setting of <link + linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link> (0 for + off, 1 for on). + </simpara> + <note> + <para> + If the directive <link linkend="ini.magic-quotes-sybase"> + magic_quotes_sybase</link> is ON it will completely override + <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>. So even + when <function>get_magic_quotes_gpc</function> returns + &true; neither double quotes, backslashes or NUL's will + be escaped. Only single quotes will be escaped. In this + case they'll look like: <emphasis>''</emphasis> + </para> + </note> + <simpara> + Keep in mind that the setting <link linkend="ini.magic-quotes-gpc"> + magic_quotes_gpc</link> will not work at runtime. + </simpara> + <para> + <example> + <title><function>get_magic_quotes_gpc</function> example</title> + <programlisting role="php"> <![CDATA[ <?php echo get_magic_quotes_gpc(); // 1 @@ -54,21 +52,21 @@ $sql = "INSERT INTO lastnames (lastname) VALUES ('$lastname')"; ?> ]]> - </programlisting> - </example> - </para> - <para> - For more information about magic_quotes, see this - <link linkend="security.magicquotes">security section</link>. - </para> - <simpara> - See also <function>addslashes</function>, - <function>stripslashes</function>, - <function>get_magic_quotes_runtime</function>, and - <function>ini_get</function>. - </simpara> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + For more information about magic_quotes, see this + <link linkend="security.magicquotes">security section</link>. + </para> + <simpara> + See also <function>addslashes</function>, + <function>stripslashes</function>, + <function>get_magic_quotes_runtime</function>, and + <function>ini_get</function>. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/get-magic-quotes-runtime.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/info/functions/get-magic-quotes-runtime.xml diff -u phpdoc/en/reference/info/functions/get-magic-quotes-runtime.xml:1.3 phpdoc/en/reference/info/functions/get-magic-quotes-runtime.xml:1.4 --- phpdoc/en/reference/info/functions/get-magic-quotes-runtime.xml:1.3 Wed Feb 5 02:38:39 2003 +++ phpdoc/en/reference/info/functions/get-magic-quotes-runtime.xml Sun Feb 4 22:42:28 2007 @@ -1,31 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.get-magic-quotes-runtime"> - <refnamediv> - <refname>get_magic_quotes_runtime</refname> - <refpurpose> - Gets the current active configuration setting of - magic_quotes_runtime - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>get_magic_quotes_runtime</methodname> - <void/> - </methodsynopsis> - <simpara> - Returns the current active configuration setting of <link - linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> - (0 for off, 1 for on). - </simpara> - <simpara> - See also <function>get_magic_quotes_gpc</function> and - <function>set_magic_quotes_runtime</function>. - </simpara> - </refsect1> - </refentry> +<refentry id="function.get-magic-quotes-runtime"> + <refnamediv> + <refname>get_magic_quotes_runtime</refname> + <refpurpose>Gets the current active configuration setting of magic_quotes_runtime</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>get_magic_quotes_runtime</methodname> + <void/> + </methodsynopsis> + <simpara> + Returns the current active configuration setting of <link + linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> + (0 for off, 1 for on). + </simpara> + <simpara> + See also <function>get_magic_quotes_gpc</function> and + <function>set_magic_quotes_runtime</function>. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/getenv.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/info/functions/getenv.xml diff -u phpdoc/en/reference/info/functions/getenv.xml:1.8 phpdoc/en/reference/info/functions/getenv.xml:1.9 --- phpdoc/en/reference/info/functions/getenv.xml:1.8 Tue Jan 18 17:53:28 2005 +++ phpdoc/en/reference/info/functions/getenv.xml Sun Feb 4 22:42:28 2007 @@ -1,22 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.getenv"> - <refnamediv> - <refname>getenv</refname> - <refpurpose>Gets the value of an environment variable</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>getenv</methodname> - <methodparam><type>string</type><parameter>varname</parameter></methodparam> - </methodsynopsis> - <para> - Returns the value of the environment variable - <parameter>varname</parameter>, or &false; on an error. - <informalexample> - <programlisting role="php"> +<refentry id="function.getenv"> + <refnamediv> + <refname>getenv</refname> + <refpurpose>Gets the value of an environment variable</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>getenv</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> + <para> + Returns the value of the environment variable + <parameter>varname</parameter>, or &false; on an error. + <informalexample> + <programlisting role="php"> <![CDATA[ <?php // Example use of getenv() @@ -26,23 +26,23 @@ $ip = $_SERVER['REMOTE_ADDR']; ?> ]]> - </programlisting> - </informalexample> - </para> - <para> - You can see a list of all the environmental variables by using - <function>phpinfo</function>. You can find out what many of them - mean by taking a look at the <ulink url="&url.cgispecs;">CGI - specification</ulink>, specifically the <ulink - url="&url.cgispec;">page on environmental variables</ulink>. - </para> - <para> - See also <function>putenv</function>, - <function>apache_getenv</function>&listendand; - <link linkend="language.variables.superglobals">Superglobals</link>. - </para> - </refsect1> - </refentry> + </programlisting> + </informalexample> + </para> + <para> + You can see a list of all the environmental variables by using + <function>phpinfo</function>. You can find out what many of them + mean by taking a look at the <ulink url="&url.cgispecs;">CGI + specification</ulink>, specifically the <ulink + url="&url.cgispec;">page on environmental variables</ulink>. + </para> + <para> + See also <function>putenv</function>, + <function>apache_getenv</function>&listendand; + <link linkend="language.variables.superglobals">Superglobals</link>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/getlastmod.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/info/functions/getlastmod.xml diff -u phpdoc/en/reference/info/functions/getlastmod.xml:1.7 phpdoc/en/reference/info/functions/getlastmod.xml:1.8 --- phpdoc/en/reference/info/functions/getlastmod.xml:1.7 Thu Dec 18 11:47:08 2003 +++ phpdoc/en/reference/info/functions/getlastmod.xml Sun Feb 4 22:42:28 2007 @@ -1,53 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.getlastmod"> - <refnamediv> - <refname>getlastmod</refname> - <refpurpose>Gets time of last page modification</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>getlastmod</methodname> - <void/> - </methodsynopsis> - <para> - Returns the time of the last modification of the current - page. The value returned is a Unix timestamp, suitable for - feeding to <function>date</function>. Returns &false; on error. - </para> - <para> - <example> - <title><function>getlastmod</function> example</title> - <programlisting role="php"> +<refentry id="function.getlastmod"> + <refnamediv> + <refname>getlastmod</refname> + <refpurpose>Gets time of last page modification</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>getlastmod</methodname> + <void/> + </methodsynopsis> + <para> + Returns the time of the last modification of the current + page. The value returned is a Unix timestamp, suitable for + feeding to <function>date</function>. Returns &false; on error. + </para> + <para> + <example> + <title><function>getlastmod</function> example</title> + <programlisting role="php"> <![CDATA[ <?php // outputs e.g. 'Last modified: March 04 1998 20:43:59.' echo "Last modified: " . date ("F d Y H:i:s.", getlastmod()); ?> ]]> - </programlisting> - </example> - </para> - <note> - <simpara> - If you're interested in getting the last modification time - of a different file, consider using <function>filemtime</function>. - </simpara> - </note> - <para> - See also - <function>date</function>, - <function>getmyuid</function>, - <function>getmygid</function>, - <function>get_current_user</function>, - <function>getmyinode</function>, - <function>getmypid</function>, and - <function>filemtime</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <note> + <simpara> + If you're interested in getting the last modification time + of a different file, consider using <function>filemtime</function>. + </simpara> + </note> + <para> + See also + <function>date</function>, + <function>getmyuid</function>, + <function>getmygid</function>, + <function>get_current_user</function>, + <function>getmyinode</function>, + <function>getmypid</function>, and + <function>filemtime</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/getmygid.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/info/functions/getmygid.xml diff -u phpdoc/en/reference/info/functions/getmygid.xml:1.2 phpdoc/en/reference/info/functions/getmygid.xml:1.3 --- phpdoc/en/reference/info/functions/getmygid.xml:1.2 Wed Apr 17 06:39:27 2002 +++ phpdoc/en/reference/info/functions/getmygid.xml Sun Feb 4 22:42:28 2007 @@ -1,29 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.75 --> - <refentry id="function.getmygid"> - <refnamediv> - <refname>getmygid</refname> - <refpurpose>Get PHP script owner's GID</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>getmygid</methodname> - <void/> - </methodsynopsis> - <simpara> - Returns the group ID of the current script, or &false; on error. - </simpara> - <simpara> - See also <function>getmyuid</function>, - <function>getmypid</function>, - <function>get_current_user</function>, - <function>getmyinode</function>, and - <function>getlastmod</function>. - </simpara> - </refsect1> - </refentry> +<refentry id="function.getmygid"> + <refnamediv> + <refname>getmygid</refname> + <refpurpose>Get PHP script owner's GID</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>getmygid</methodname> + <void/> + </methodsynopsis> + <simpara> + Returns the group ID of the current script, or &false; on error. + </simpara> + <simpara> + See also <function>getmyuid</function>, + <function>getmypid</function>, + <function>get_current_user</function>, + <function>getmyinode</function>, and + <function>getlastmod</function>. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/getmyinode.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/info/functions/getmyinode.xml diff -u phpdoc/en/reference/info/functions/getmyinode.xml:1.3 phpdoc/en/reference/info/functions/getmyinode.xml:1.4 --- phpdoc/en/reference/info/functions/getmyinode.xml:1.3 Sat Feb 22 04:24:24 2003 +++ phpdoc/en/reference/info/functions/getmyinode.xml Sun Feb 4 22:42:28 2007 @@ -1,31 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.getmyinode"> - <refnamediv> - <refname>getmyinode</refname> - <refpurpose>Gets the inode of the current script</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>getmyinode</methodname> - <void/> - </methodsynopsis> - <para> - Returns the current script's inode, or &false; on error. - </para> - <para> - See also - <function>getmygid</function>, - <function>getmyuid</function>, - <function>get_current_user</function>, - <function>getmypid</function>, and - <function>getlastmod</function>. - </para> - &note.no-windows; - </refsect1> - </refentry> +<refentry id="function.getmyinode"> + <refnamediv> + <refname>getmyinode</refname> + <refpurpose>Gets the inode of the current script</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>getmyinode</methodname> + <void/> + </methodsynopsis> + <para> + Returns the current script's inode, or &false; on error. + </para> + <para> + See also + <function>getmygid</function>, + <function>getmyuid</function>, + <function>get_current_user</function>, + <function>getmypid</function>, and + <function>getlastmod</function>. + </para> + &note.no-windows; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/getmypid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/info/functions/getmypid.xml diff -u phpdoc/en/reference/info/functions/getmypid.xml:1.3 phpdoc/en/reference/info/functions/getmypid.xml:1.4 --- phpdoc/en/reference/info/functions/getmypid.xml:1.3 Sat Feb 22 04:24:24 2003 +++ phpdoc/en/reference/info/functions/getmypid.xml Sun Feb 4 22:42:28 2007 @@ -1,37 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.getmypid"> - <refnamediv> - <refname>getmypid</refname> - <refpurpose>Gets PHP's process ID</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>getmypid</methodname> - <void/> - </methodsynopsis> - <para> - Returns the current PHP process ID, or &false; on error. - </para> - <warning> - <para> - Process IDs are not unique, thus they are a weak entropy - source. We recommend against relying on pids in - security-dependent contexts. - </para> - </warning> - <para> - See also - <function>getmygid</function>, - <function>getmyuid</function>, - <function>get_current_user</function>, - <function>getmyinode</function>, and - <function>getlastmod</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.getmypid"> + <refnamediv> + <refname>getmypid</refname> + <refpurpose>Gets PHP's process ID</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>getmypid</methodname> + <void/> + </methodsynopsis> + <para> + Returns the current PHP process ID, or &false; on error. + </para> + <warning> + <para> + Process IDs are not unique, thus they are a weak entropy + source. We recommend against relying on pids in + security-dependent contexts. + </para> + </warning> + <para> + See also + <function>getmygid</function>, + <function>getmyuid</function>, + <function>get_current_user</function>, + <function>getmyinode</function>, and + <function>getlastmod</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/getmyuid.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/info/functions/getmyuid.xml diff -u phpdoc/en/reference/info/functions/getmyuid.xml:1.2 phpdoc/en/reference/info/functions/getmyuid.xml:1.3 --- phpdoc/en/reference/info/functions/getmyuid.xml:1.2 Wed Apr 17 06:39:27 2002 +++ phpdoc/en/reference/info/functions/getmyuid.xml Sun Feb 4 22:42:28 2007 @@ -1,29 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.getmyuid"> - <refnamediv> - <refname>getmyuid</refname> - <refpurpose>Gets PHP script owner's UID</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>getmyuid</methodname> - <void/> - </methodsynopsis> - <simpara> - Returns the user ID of the current script, or &false; on error. - </simpara> - <simpara> - See also <function>getmygid</function>, - <function>getmypid</function>, - <function>get_current_user</function>, - <function>getmyinode</function>, and - <function>getlastmod</function>. - </simpara> - </refsect1> - </refentry> +<refentry id="function.getmyuid"> + <refnamediv> + <refname>getmyuid</refname> + <refpurpose>Gets PHP script owner's UID</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>getmyuid</methodname> + <void/> + </methodsynopsis> + <simpara> + Returns the user ID of the current script, or &false; on error. + </simpara> + <simpara> + See also <function>getmygid</function>, + <function>getmypid</function>, + <function>get_current_user</function>, + <function>getmyinode</function>, and + <function>getlastmod</function>. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/getopt.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/info/functions/getopt.xml diff -u phpdoc/en/reference/info/functions/getopt.xml:1.11 phpdoc/en/reference/info/functions/getopt.xml:1.12 --- phpdoc/en/reference/info/functions/getopt.xml:1.11 Wed Feb 8 15:19:51 2006 +++ phpdoc/en/reference/info/functions/getopt.xml Sun Feb 4 22:42:28 2007 @@ -1,50 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> - <refentry id="function.getopt"> - <refnamediv> - <refname>getopt</refname> - <refpurpose>Gets options from the command line argument list</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>getopt</methodname> - <methodparam><type>string</type><parameter>options</parameter></methodparam> - <!-- <methodparam choice="opt"><type>array</type><parameter>longopts</parameter></methodparam> --> - </methodsynopsis> - <para> - Returns an associative array of option / argument pairs based on the - options format specified in <parameter>options</parameter>, or &false; - on an error. - </para> - <para> - <informalexample> - <programlisting role="php"> +<!-- $Revision: 1.12 $ --> +<refentry id="function.getopt"> + <refnamediv> + <refname>getopt</refname> + <refpurpose>Gets options from the command line argument list</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>getopt</methodname> + <methodparam><type>string</type><parameter>options</parameter></methodparam> + <!-- <methodparam choice="opt"><type>array</type><parameter>longopts</parameter></methodparam> --> + </methodsynopsis> + <para> + Returns an associative array of option / argument pairs based on the + options format specified in <parameter>options</parameter>, or &false; + on an error. + </para> + <para> + <informalexample> + <programlisting role="php"> <![CDATA[ <?php // parse the command line ($GLOBALS['argv']) $options = getopt("f:hp:"); ?> ]]> - </programlisting> - </informalexample> - </para> - <para> - The <parameter>options</parameter> parameter may contain the following - elements: individual characters, and characters followed by a colon to - indicate an option argument is to follow. For example, an option string - <literal>x</literal> recognizes an option <literal>-x</literal>, and an - option string <literal>x:</literal> recognizes an option and argument - <literal>-x argument</literal>. It does not matter if an argument has - leading white space. - </para> - <para> - This function will return an array of option / argument pairs. If an - option does not have an argument, the value will be set to &false;. - </para> - &note.no-windows; - </refsect1> - </refentry> + </programlisting> + </informalexample> + </para> + <para> + The <parameter>options</parameter> parameter may contain the following + elements: individual characters, and characters followed by a colon to + indicate an option argument is to follow. For example, an option string + <literal>x</literal> recognizes an option <literal>-x</literal>, and an + option string <literal>x:</literal> recognizes an option and argument + <literal>-x argument</literal>. It does not matter if an argument has + leading white space. + </para> + <para> + This function will return an array of option / argument pairs. If an + option does not have an argument, the value will be set to &false;. + </para> + &note.no-windows; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/getrusage.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/info/functions/getrusage.xml diff -u phpdoc/en/reference/info/functions/getrusage.xml:1.6 phpdoc/en/reference/info/functions/getrusage.xml:1.7 --- phpdoc/en/reference/info/functions/getrusage.xml:1.6 Mon Dec 15 16:51:14 2003 +++ phpdoc/en/reference/info/functions/getrusage.xml Sun Feb 4 22:42:28 2007 @@ -1,29 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.getrusage"> - <refnamediv> - <refname>getrusage</refname> - <refpurpose>Gets the current resource usages</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>getrusage</methodname> - <methodparam choice="opt"><type>int</type><parameter>who</parameter></methodparam> - </methodsynopsis> - <para> - This is an interface to getrusage(2). It returns an associative - array containing the data returned from the system call. If who - is 1, getrusage will be called with RUSAGE_CHILDREN. - </para> - <para> - All entries are accessible by using their documented field names. - </para> - <para> - <example> - <title><function>getrusage</function> example</title> - <programlisting role="php"> +<refentry id="function.getrusage"> + <refnamediv> + <refname>getrusage</refname> + <refpurpose>Gets the current resource usages</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>getrusage</methodname> + <methodparam choice="opt"><type>int</type><parameter>who</parameter></methodparam> + </methodsynopsis> + <para> + This is an interface to getrusage(2). It returns an associative + array containing the data returned from the system call. If who + is 1, getrusage will be called with RUSAGE_CHILDREN. + </para> + <para> + All entries are accessible by using their documented field names. + </para> + <para> + <example> + <title><function>getrusage</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $dat = getrusage(); @@ -33,13 +33,13 @@ echo $dat["ru_utime.tv_usec"]; // user time used (microseconds) ?> ]]> - </programlisting> - </example> - See your system's man page on getrusage(2) for more details. - </para> - &note.no-windows; - </refsect1> - </refentry> + </programlisting> + </example> + See your system's man page on getrusage(2) for more details. + </para> + &note.no-windows; + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/ini-get-all.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/info/functions/ini-get-all.xml diff -u phpdoc/en/reference/info/functions/ini-get-all.xml:1.8 phpdoc/en/reference/info/functions/ini-get-all.xml:1.9 --- phpdoc/en/reference/info/functions/ini-get-all.xml:1.8 Thu Dec 18 11:47:08 2003 +++ phpdoc/en/reference/info/functions/ini-get-all.xml Sun Feb 4 22:42:28 2007 @@ -1,42 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.23 --> - <refentry id="function.ini-get-all"> - <refnamediv> - <refname>ini_get_all</refname> - <refpurpose>Gets all configuration options</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>ini_get_all</methodname> - <methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam> - </methodsynopsis> - <para> - Returns all the registered configuration options as an - associative array. If the optional <parameter>extension</parameter> - parameter is set, returns only options specific for that - extension. - </para> - <para> - The returned array uses the directive name as the array key, with - elements of that array being <literal>global_value</literal> (set in - &php.ini;), <literal>local_value</literal> (perhaps set with - <function>ini_set</function> or &htaccess;), and - <literal>access</literal> (the access level). See the manual section - on <link linkend="configuration.changes">configuration changes</link> - for information on what access levels mean. - </para> - <note> - <para> - It's possible for a directive to have multiple access levels, which is - why <literal>access</literal> shows the appropriate bitmask values. - </para> - </note> - <para> - <example> - <title>A <function>ini_get_all</function> example</title> - <programlisting role="php"> +<refentry id="function.ini-get-all"> + <refnamediv> + <refname>ini_get_all</refname> + <refpurpose>Gets all configuration options</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>ini_get_all</methodname> + <methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam> + </methodsynopsis> + <para> + Returns all the registered configuration options as an + associative array. If the optional <parameter>extension</parameter> + parameter is set, returns only options specific for that + extension. + </para> + <para> + The returned array uses the directive name as the array key, with + elements of that array being <literal>global_value</literal> (set in + &php.ini;), <literal>local_value</literal> (perhaps set with + <function>ini_set</function> or &htaccess;), and + <literal>access</literal> (the access level). See the manual section + on <link linkend="configuration.changes">configuration changes</link> + for information on what access levels mean. + </para> + <note> + <para> + It's possible for a directive to have multiple access levels, which is + why <literal>access</literal> shows the appropriate bitmask values. + </para> + </note> + <para> + <example> + <title>A <function>ini_get_all</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $inis = ini_get_all(); @@ -45,11 +45,11 @@ ?> ]]> - </programlisting> - <para> - Partial output may look like: - </para> - <screen> + </programlisting> + <para> + Partial output may look like: + </para> + <screen> <![CDATA[ Array ( @@ -70,18 +70,18 @@ ) ]]> - </screen> - </example> - </para> - <para> - See also: <function>ini_get</function>, - <function>ini_restore</function>, - <function>ini_set</function>, - <function>get_loaded_extensions</function>, and - <function>phpinfo</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also: <function>ini_get</function>, + <function>ini_restore</function>, + <function>ini_set</function>, + <function>get_loaded_extensions</function>, and + <function>phpinfo</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/ini-get.xml?r1=1.13&r2=1.14&diff_format=u Index: phpdoc/en/reference/info/functions/ini-get.xml diff -u phpdoc/en/reference/info/functions/ini-get.xml:1.13 phpdoc/en/reference/info/functions/ini-get.xml:1.14 --- phpdoc/en/reference/info/functions/ini-get.xml:1.13 Thu Dec 16 10:56:56 2004 +++ phpdoc/en/reference/info/functions/ini-get.xml Sun Feb 4 22:42:28 2007 @@ -1,47 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.13 $ --> +<!-- $Revision: 1.14 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.64 --> - <refentry id="function.ini-get"> - <refnamediv> - <refname>ini_get</refname> - <refpurpose>Gets the value of a configuration option</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ini_get</methodname> - <methodparam><type>string</type><parameter>varname</parameter></methodparam> - </methodsynopsis> - <para> - Returns the value of the configuration option on success. Failure, such - as querying for a non-existent value, will return an empty string. - </para> - <note> - <title>When querying boolean values</title> - <para> - A boolean ini value of <literal>off</literal> will be returned as an - empty string or "0" while a boolean ini value of <literal>on</literal> will - be returned as "1". - </para> - </note> - <note> - <title>When querying memory size values</title> - <para> - Many ini memory size values, such as - <link linkend="ini.upload-max-filesize">upload_max_filesize</link>, are - stored in the &php.ini; file in shorthand notation. - <function>ini_get</function> will return the exact string stored in the - &php.ini; file and <emphasis>NOT</emphasis> its <type>integer</type> - equivalent. Attempting normal arithmetic functions on these values - will not have otherwise expected results. The example below shows one - way to convert shorthand notation into bytes, much like how the PHP - source does it. - </para> - </note> - <para> - <example> - <title>A few <function>ini_get</function> examples</title> - <programlisting role="php"> +<refentry id="function.ini-get"> + <refnamediv> + <refname>ini_get</refname> + <refpurpose>Gets the value of a configuration option</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ini_get</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> + <para> + Returns the value of the configuration option on success. Failure, such + as querying for a non-existent value, will return an empty string. + </para> + <note> + <title>When querying boolean values</title> + <para> + A boolean ini value of <literal>off</literal> will be returned as an + empty string or "0" while a boolean ini value of <literal>on</literal> will + be returned as "1". + </para> + </note> + <note> + <title>When querying memory size values</title> + <para> + Many ini memory size values, such as + <link linkend="ini.upload-max-filesize">upload_max_filesize</link>, are + stored in the &php.ini; file in shorthand notation. + <function>ini_get</function> will return the exact string stored in the + &php.ini; file and <emphasis>NOT</emphasis> its <type>integer</type> + equivalent. Attempting normal arithmetic functions on these values + will not have otherwise expected results. The example below shows one + way to convert shorthand notation into bytes, much like how the PHP + source does it. + </para> + </note> + <para> + <example> + <title>A few <function>ini_get</function> examples</title> + <programlisting role="php"> <![CDATA[ <?php /* @@ -55,7 +55,7 @@ echo 'display_errors = ' . ini_get('display_errors') . "\n"; echo 'register_globals = ' . ini_get('register_globals') . "\n"; echo 'post_max_size = ' . ini_get('post_max_size') . "\n"; -echo 'post_max_size+1 = ' . (ini_get('post_max_size')+1) . "\n"; +echo 'post_max_size+1 = ' . (ini_get('post_max_size')+1) . "\n"; echo 'post_max_size in bytes = ' . return_bytes(ini_get('post_max_size')); function return_bytes($val) { @@ -76,11 +76,11 @@ ?> ]]> - </programlisting> - <para> - This script will produce: - </para> - <screen> + </programlisting> + <para> + This script will produce: + </para> + <screen> <![CDATA[ display_errors = 1 @@ -90,18 +90,18 @@ post_max_size in bytes = 8388608 ]]> - </screen> - </example> - </para> - <para> - See also - <function>get_cfg_var</function>, - <function>ini_get_all</function>, - <function>ini_restore</function>, and - <function>ini_set</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also + <function>get_cfg_var</function>, + <function>ini_get_all</function>, + <function>ini_restore</function>, and + <function>ini_set</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/ini-restore.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/info/functions/ini-restore.xml diff -u phpdoc/en/reference/info/functions/ini-restore.xml:1.7 phpdoc/en/reference/info/functions/ini-restore.xml:1.8 --- phpdoc/en/reference/info/functions/ini-restore.xml:1.7 Wed Mar 10 23:04:29 2004 +++ phpdoc/en/reference/info/functions/ini-restore.xml Sun Feb 4 22:42:28 2007 @@ -1,28 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.23 --> - <refentry id="function.ini-restore"> - <refnamediv> - <refname>ini_restore</refname> - <refpurpose>Restores the value of a configuration option</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>ini_restore</methodname> - <methodparam><type>string</type><parameter>varname</parameter></methodparam> - </methodsynopsis> - <para> - Restores a given configuration option to its original value. - </para> - <para> - See also - <function>ini_get</function>, - <function>ini_get_all</function>, and - <function>ini_set</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.ini-restore"> + <refnamediv> + <refname>ini_restore</refname> + <refpurpose>Restores the value of a configuration option</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>void</type><methodname>ini_restore</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + </methodsynopsis> + <para> + Restores a given configuration option to its original value. + </para> + <para> + See also + <function>ini_get</function>, + <function>ini_get_all</function>, and + <function>ini_set</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/ini-set.xml?r1=1.46&r2=1.47&diff_format=u Index: phpdoc/en/reference/info/functions/ini-set.xml diff -u phpdoc/en/reference/info/functions/ini-set.xml:1.46 phpdoc/en/reference/info/functions/ini-set.xml:1.47 --- phpdoc/en/reference/info/functions/ini-set.xml:1.46 Mon Aug 1 16:09:53 2005 +++ phpdoc/en/reference/info/functions/ini-set.xml Sun Feb 4 22:42:28 2007 @@ -1,39 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.46 $ --> +<!-- $Revision: 1.47 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.23 --> - <refentry id="function.ini-set"> - <refnamediv> - <refname>ini_set</refname> - <refpurpose>Sets the value of a configuration option</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ini_set</methodname> - <methodparam><type>string</type><parameter>varname</parameter></methodparam> - <methodparam><type>string</type><parameter>newvalue</parameter></methodparam> - </methodsynopsis> - <para> - Sets the value of the given configuration option. Returns the old - value on success, &false; on failure. The configuration option - will keep this new value during the script's execution, and will - be restored at the script's ending. - </para> - <para> - Not all the available options can be changed using - <function>ini_set</function>. There is a list of all available options in - the <link linkend="ini.list">appendix</link>. - </para> - <para> - See also: <function>get_cfg_var</function>, - <function>ini_get</function>, - <function>ini_get_all</function>, - <function>ini_restore</function> &listendand; - <link linkend="configuration.changes">How to change configuration - settings</link> - </para> - </refsect1> - </refentry> +<refentry id="function.ini-set"> + <refnamediv> + <refname>ini_set</refname> + <refpurpose>Sets the value of a configuration option</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ini_set</methodname> + <methodparam><type>string</type><parameter>varname</parameter></methodparam> + <methodparam><type>string</type><parameter>newvalue</parameter></methodparam> + </methodsynopsis> + <para> + Sets the value of the given configuration option. Returns the old + value on success, &false; on failure. The configuration option + will keep this new value during the script's execution, and will + be restored at the script's ending. + </para> + <para> + Not all the available options can be changed using + <function>ini_set</function>. There is a list of all available options in + the <link linkend="ini.list">appendix</link>. + </para> + <para> + See also: <function>get_cfg_var</function>, + <function>ini_get</function>, + <function>ini_get_all</function>, + <function>ini_restore</function> &listendand; + <link linkend="configuration.changes">How to change configuration + settings</link> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/main.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/info/functions/main.xml diff -u phpdoc/en/reference/info/functions/main.xml:1.5 phpdoc/en/reference/info/functions/main.xml:1.6 --- phpdoc/en/reference/info/functions/main.xml:1.5 Wed Nov 16 10:44:45 2005 +++ phpdoc/en/reference/info/functions/main.xml Sun Feb 4 22:42:28 2007 @@ -1,65 +1,65 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id="function.main"> - <refnamediv> - <refname>main</refname> - <refpurpose>Dummy for <function>main</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - There is no function named <function>main</function> except - in the PHP source. In PHP 4.3.0, a new type of error handling - in the PHP source (php_error_docref) was introduced. One feature - is to provide links to a manual page in PHP error messages when - the PHP directives <link linkend="ini.html-errors">html_errors</link> - (on by default) and <link linkend="ini.docref-root">docref_root</link> - (on by default until PHP 4.3.2) are set. - </para> - <para> - Sometimes error messages refer to a manual page for the function - <function>main</function> which is why this page exists. Please - add a user comment below that mentions what PHP function caused the - error that linked to <function>main</function> and it will be - fixed and properly documented. - </para> - <para> - <table> - <title>Known errors that point to <function>main</function></title> - <tgroup cols="2"> - <thead> - <row> - <entry>Function name</entry> - <entry>No longer points here as of</entry> - </row> - </thead> - <tbody> - <row> - <entry><function>include</function></entry> - <entry>5.1.0</entry> - </row> - <row> - <entry><function>include_once</function></entry> - <entry>5.1.0</entry> - </row> - <row> - <entry><function>require</function></entry> - <entry>5.1.0</entry> - </row> - <row> - <entry><function>require_once</function></entry> - <entry>5.1.0</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - See also <link linkend="ini.html-errors">html_errors</link> - and <link linkend="ini.display-errors">display_errors</link>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id="function.main"> + <refnamediv> + <refname>main</refname> + <refpurpose>Dummy for <function>main</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + There is no function named <function>main</function> except + in the PHP source. In PHP 4.3.0, a new type of error handling + in the PHP source (php_error_docref) was introduced. One feature + is to provide links to a manual page in PHP error messages when + the PHP directives <link linkend="ini.html-errors">html_errors</link> + (on by default) and <link linkend="ini.docref-root">docref_root</link> + (on by default until PHP 4.3.2) are set. + </para> + <para> + Sometimes error messages refer to a manual page for the function + <function>main</function> which is why this page exists. Please + add a user comment below that mentions what PHP function caused the + error that linked to <function>main</function> and it will be + fixed and properly documented. + </para> + <para> + <table> + <title>Known errors that point to <function>main</function></title> + <tgroup cols="2"> + <thead> + <row> + <entry>Function name</entry> + <entry>No longer points here as of</entry> + </row> + </thead> + <tbody> + <row> + <entry><function>include</function></entry> + <entry>5.1.0</entry> + </row> + <row> + <entry><function>include_once</function></entry> + <entry>5.1.0</entry> + </row> + <row> + <entry><function>require</function></entry> + <entry>5.1.0</entry> + </row> + <row> + <entry><function>require_once</function></entry> + <entry>5.1.0</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + See also <link linkend="ini.html-errors">html_errors</link> + and <link linkend="ini.display-errors">display_errors</link>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/memory-get-peak-usage.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/info/functions/memory-get-peak-usage.xml diff -u phpdoc/en/reference/info/functions/memory-get-peak-usage.xml:1.3 phpdoc/en/reference/info/functions/memory-get-peak-usage.xml:1.4 --- phpdoc/en/reference/info/functions/memory-get-peak-usage.xml:1.3 Sun Jan 28 16:49:30 2007 +++ phpdoc/en/reference/info/functions/memory-get-peak-usage.xml Sun Feb 4 22:42:28 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.memory-get-peak-usage"> <refnamediv> <refname>memory_get_peak_usage</refname> @@ -10,7 +10,7 @@ &reftitle.description; <methodsynopsis> <type>int</type><methodname>memory_get_peak_usage</methodname> - <methodparam><type>bool</type><parameter>real_usage</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>real_usage</parameter></methodparam> </methodsynopsis> <para> Returns the peak of memory, in bytes, that's been allocated to your PHP http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/memory-get-usage.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/info/functions/memory-get-usage.xml diff -u phpdoc/en/reference/info/functions/memory-get-usage.xml:1.4 phpdoc/en/reference/info/functions/memory-get-usage.xml:1.5 --- phpdoc/en/reference/info/functions/memory-get-usage.xml:1.4 Sun Jan 28 16:49:30 2007 +++ phpdoc/en/reference/info/functions/memory-get-usage.xml Sun Feb 4 22:42:28 2007 @@ -1,35 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id="function.memory-get-usage"> - <refnamediv> - <refname>memory_get_usage</refname> - <refpurpose>Returns the amount of memory allocated to PHP</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>memory_get_usage</methodname> - <methodparam><type>bool</type><parameter>real_usage</parameter></methodparam> - </methodsynopsis> - <para> - Returns the amount of memory, in bytes, that's currently being - allocated to your PHP script. - </para> - <para> - <function>memory_get_usage</function> will only be defined if your PHP - is compiled with the <literal>--enable-memory-limit</literal> - configuration option. - </para> - <para> - <parameter>real_usage</parameter> was added as of PHP 5.2.0. - </para> - <para> - <example> - <title>A <function>memory_get_usage</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.5 $ --> +<refentry id="function.memory-get-usage"> + <refnamediv> + <refname>memory_get_usage</refname> + <refpurpose>Returns the amount of memory allocated to PHP</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>memory_get_usage</methodname> + <methodparam choice="opt"><type>bool</type><parameter>real_usage</parameter></methodparam> + </methodsynopsis> + <para> + Returns the amount of memory, in bytes, that's currently being + allocated to your PHP script. + </para> + <para> + <function>memory_get_usage</function> will only be defined if your PHP + is compiled with the <literal>--enable-memory-limit</literal> + configuration option. + </para> + <para> + <parameter>real_usage</parameter> was added as of PHP 5.2.0. + </para> + <para> + <example> + <title>A <function>memory_get_usage</function> example</title> + <programlisting role="php"> <![CDATA[ <?php -// This is only an example, the numbers below will +// This is only an example, the numbers below will // differ depending on your system echo memory_get_usage() . "\n"; // 36640 @@ -44,15 +44,15 @@ ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>memory_get_peak_usage</function> and - <link linkend="ini.memory-limit">memory_limit</link>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>memory_get_peak_usage</function> and + <link linkend="ini.memory-limit">memory_limit</link>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/php-ini-scanned-files.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/info/functions/php-ini-scanned-files.xml diff -u phpdoc/en/reference/info/functions/php-ini-scanned-files.xml:1.4 phpdoc/en/reference/info/functions/php-ini-scanned-files.xml:1.5 --- phpdoc/en/reference/info/functions/php-ini-scanned-files.xml:1.4 Fri Aug 13 04:34:35 2004 +++ phpdoc/en/reference/info/functions/php-ini-scanned-files.xml Sun Feb 4 22:42:28 2007 @@ -1,42 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id="function.php-ini-scanned-files"> - <refnamediv> - <refname>php_ini_scanned_files</refname> - <refpurpose>Return a list of .ini files parsed from the additional ini dir</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>php_ini_scanned_files</methodname> - <void/> - </methodsynopsis> - <simpara> - <function>php_ini_scanned_files</function> returns a comma-separated - list of configuration files parsed after &php.ini;. These files are - found in a directory defined by the - <option role="configure">--with-config-file-scan-dir</option> option - which is set during compilation. - </simpara> - <simpara> - Returns a comma-separated string of .ini files on success. If the - directive <option - role="configure">--with-config-files-scan-dir</option> wasn't set, - &false; is returned. If it was set and the directory was empty, an - empty string is returned. If a file is unrecognizable, the file will - still make it into the returned string but a PHP error will also result. - This PHP error will be seen both at compile time and while using - <function>php_ini_scanned_files</function>. - </simpara> - <simpara> - The returned configuration files also include the path as declared in - the <option role="configure">--with-config-file-scan-dir</option> - option. Also, each comma is followed by a newline. - </simpara> - <para> - <example> - <title>A simple example to list the returned ini files</title> - <programlisting role="php"> +<!-- $Revision: 1.5 $ --> +<refentry id="function.php-ini-scanned-files"> + <refnamediv> + <refname>php_ini_scanned_files</refname> + <refpurpose>Return a list of .ini files parsed from the additional ini dir</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>php_ini_scanned_files</methodname> + <void/> + </methodsynopsis> + <simpara> + <function>php_ini_scanned_files</function> returns a comma-separated + list of configuration files parsed after &php.ini;. These files are + found in a directory defined by the + <option role="configure">--with-config-file-scan-dir</option> option + which is set during compilation. + </simpara> + <simpara> + Returns a comma-separated string of .ini files on success. If the + directive <option + role="configure">--with-config-files-scan-dir</option> wasn't set, + &false; is returned. If it was set and the directory was empty, an + empty string is returned. If a file is unrecognizable, the file will + still make it into the returned string but a PHP error will also result. + This PHP error will be seen both at compile time and while using + <function>php_ini_scanned_files</function>. + </simpara> + <simpara> + The returned configuration files also include the path as declared in + the <option role="configure">--with-config-file-scan-dir</option> + option. Also, each comma is followed by a newline. + </simpara> + <para> + <example> + <title>A simple example to list the returned ini files</title> + <programlisting role="php"> <![CDATA[ <?php if ($filelist = php_ini_scanned_files()) { @@ -50,14 +50,14 @@ } ?> ]]> - </programlisting> - </example> - </para> - <simpara> - See also <function>ini_set</function> and <function>phpinfo</function>. - </simpara> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <simpara> + See also <function>ini_set</function> and <function>phpinfo</function>. + </simpara> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/php-logo-guid.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/info/functions/php-logo-guid.xml diff -u phpdoc/en/reference/info/functions/php-logo-guid.xml:1.8 phpdoc/en/reference/info/functions/php-logo-guid.xml:1.9 --- phpdoc/en/reference/info/functions/php-logo-guid.xml:1.8 Sun Jul 3 06:25:02 2005 +++ phpdoc/en/reference/info/functions/php-logo-guid.xml Sun Feb 4 22:42:28 2007 @@ -1,27 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.3 --> - <refentry id="function.php-logo-guid"> - <refnamediv> - <refname>php_logo_guid</refname> - <refpurpose>Gets the logo guid</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>php_logo_guid</methodname> - <void/> - </methodsynopsis> - <para> - This function returns the ID which can be used to display the PHP logo - using the built-in image. - Logo is displayed only if <link linkend="ini.expose-php">expose_php</link> - is On. - </para> - <para> - <example> - <title><function>php_logo_guid</function> example</title> - <programlisting role="php"> +<refentry id="function.php-logo-guid"> + <refnamediv> + <refname>php_logo_guid</refname> + <refpurpose>Gets the logo guid</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>php_logo_guid</methodname> + <void/> + </methodsynopsis> + <para> + This function returns the ID which can be used to display the PHP logo + using the built-in image. + Logo is displayed only if <link linkend="ini.expose-php">expose_php</link> + is On. + </para> + <para> + <example> + <title><function>php_logo_guid</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -30,18 +30,18 @@ ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>phpinfo</function>, - <function>phpversion</function>, - <function>phpcredits</function> and - <function>zend_logo_guid</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>phpinfo</function>, + <function>phpversion</function>, + <function>phpcredits</function> and + <function>zend_logo_guid</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/php-sapi-name.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/info/functions/php-sapi-name.xml diff -u phpdoc/en/reference/info/functions/php-sapi-name.xml:1.9 phpdoc/en/reference/info/functions/php-sapi-name.xml:1.10 --- phpdoc/en/reference/info/functions/php-sapi-name.xml:1.9 Wed Feb 8 15:44:09 2006 +++ phpdoc/en/reference/info/functions/php-sapi-name.xml Sun Feb 4 22:42:28 2007 @@ -1,29 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.25 --> - <refentry id="function.php-sapi-name"> - <refnamediv> - <refname>php_sapi_name</refname> - <refpurpose> - Returns the type of interface between web server and PHP - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>php_sapi_name</methodname> - <void/> - </methodsynopsis> - <simpara> - <function>php_sapi_name</function> returns a lowercase string - which describes the type of interface between web server and PHP - (Server API, SAPI). In CGI PHP, this string is "cgi", in mod_php - for Apache, this string is "apache" and so on. - </simpara> - <para> - <example> - <title><function>php_sapi_name</function> example</title> - <programlisting role="php"> +<refentry id="function.php-sapi-name"> + <refnamediv> + <refname>php_sapi_name</refname> + <refpurpose>Returns the type of interface between web server and PHP</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>php_sapi_name</methodname> + <void/> + </methodsynopsis> + <simpara> + <function>php_sapi_name</function> returns a lowercase string + which describes the type of interface between web server and PHP + (Server API, SAPI). In CGI PHP, this string is "cgi", in mod_php + for Apache, this string is "apache" and so on. + </simpara> + <para> + <example> + <title><function>php_sapi_name</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $sapi_type = php_sapi_name(); @@ -34,14 +32,14 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <link linkend="reserved.constants.core">PHP_SAPI</link>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <link linkend="reserved.constants.core">PHP_SAPI</link>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/php-uname.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/info/functions/php-uname.xml diff -u phpdoc/en/reference/info/functions/php-uname.xml:1.11 phpdoc/en/reference/info/functions/php-uname.xml:1.12 --- phpdoc/en/reference/info/functions/php-uname.xml:1.11 Sat Oct 23 06:54:47 2004 +++ phpdoc/en/reference/info/functions/php-uname.xml Sun Feb 4 22:42:28 2007 @@ -1,71 +1,69 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> +<!-- $Revision: 1.12 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.7 --> - <refentry id="function.php-uname"> - <refnamediv> - <refname>php_uname</refname> - <refpurpose> - Returns information about the operating system PHP is running on - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>php_uname</methodname> - <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam> - </methodsynopsis> - <para> - <function>php_uname</function> returns a description of the operating - system PHP is running on. For the name of just the operating system, - consider using the <constant>PHP_OS</constant> constant, but be - reminded this constant will contain the operating system PHP was - <emphasis>built</emphasis> on. - </para> - <para> - On Unix, the output reverts to displaying the operating system - information PHP was built on if it cannot determine the currently - running OS. - </para> - <para> - <parameter>mode</parameter> is a single character that defines what - information is returned: - <itemizedlist> - <listitem> - <simpara> - <literal>'a'</literal>: This is the default. Contains all modes in the sequence <literal>"s n r v m"</literal>. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>'s'</literal>: Operating system name. eg. <literal>FreeBSD</literal>. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>'n'</literal>: Host name. eg. <literal>localhost.example.com</literal>. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>'r'</literal>: Release name. eg. <literal>5.1.2-RELEASE</literal>. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>'v'</literal>: Version information. Varies a lot between operating systems. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>'m'</literal>: Machine type. eg. <literal>i386</literal>. - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - <example> - <title>Some <function>php_uname</function> examples</title> - <programlisting role="php"> +<refentry id="function.php-uname"> + <refnamediv> + <refname>php_uname</refname> + <refpurpose>Returns information about the operating system PHP is running on</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>php_uname</methodname> + <methodparam choice="opt"><type>string</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + <para> + <function>php_uname</function> returns a description of the operating + system PHP is running on. For the name of just the operating system, + consider using the <constant>PHP_OS</constant> constant, but be + reminded this constant will contain the operating system PHP was + <emphasis>built</emphasis> on. + </para> + <para> + On Unix, the output reverts to displaying the operating system + information PHP was built on if it cannot determine the currently + running OS. + </para> + <para> + <parameter>mode</parameter> is a single character that defines what + information is returned: + <itemizedlist> + <listitem> + <simpara> + <literal>'a'</literal>: This is the default. Contains all modes in the sequence <literal>"s n r v m"</literal>. + </simpara> + </listitem> + <listitem> + <simpara> + <literal>'s'</literal>: Operating system name. eg. <literal>FreeBSD</literal>. + </simpara> + </listitem> + <listitem> + <simpara> + <literal>'n'</literal>: Host name. eg. <literal>localhost.example.com</literal>. + </simpara> + </listitem> + <listitem> + <simpara> + <literal>'r'</literal>: Release name. eg. <literal>5.1.2-RELEASE</literal>. + </simpara> + </listitem> + <listitem> + <simpara> + <literal>'v'</literal>: Version information. Varies a lot between operating systems. + </simpara> + </listitem> + <listitem> + <simpara> + <literal>'m'</literal>: Machine type. eg. <literal>i386</literal>. + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + <example> + <title>Some <function>php_uname</function> examples</title> + <programlisting role="php"> <![CDATA[ <?php echo php_uname(); @@ -90,18 +88,18 @@ ?> ]]> - </programlisting> - </example> - </para> - <para> - There are also some related - <link linkend="language.constants.predefined">Predefined PHP - constants</link> that may come in handy, for example: - </para> - <para> - <example> - <title>A few OS related constant examples</title> - <programlisting role="php"> + </programlisting> + </example> + </para> + <para> + There are also some related + <link linkend="language.constants.predefined">Predefined PHP + constants</link> that may come in handy, for example: + </para> + <para> + <example> + <title>A few OS related constant examples</title> + <programlisting role="php"> <![CDATA[ <?php // *nix @@ -115,16 +113,16 @@ echo PATH_SEPARATOR; // ; ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>phpversion</function>, - <function>php_sapi_name</function>, and - <function>phpinfo</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>phpversion</function>, + <function>php_sapi_name</function>, and + <function>phpinfo</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/phpcredits.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/info/functions/phpcredits.xml diff -u phpdoc/en/reference/info/functions/phpcredits.xml:1.7 phpdoc/en/reference/info/functions/phpcredits.xml:1.8 --- phpdoc/en/reference/info/functions/phpcredits.xml:1.7 Thu Jun 23 16:53:18 2005 +++ phpdoc/en/reference/info/functions/phpcredits.xml Sun Feb 4 22:42:28 2007 @@ -1,59 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.18 --> - <refentry id="function.phpcredits"> - <refnamediv> - <refname>phpcredits</refname> - <refpurpose>Prints out the credits for PHP</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>phpcredits</methodname> - <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam> - </methodsynopsis> - <para> - This function prints out the credits listing the PHP developers, - modules, etc. It generates the appropriate HTML codes to insert - the information in a page. <parameter>flag</parameter> is - optional, and it defaults to <constant>CREDITS_ALL</constant>. - To generate a custom credits page, you may want to use the - <parameter>flag</parameter> parameter. For example to print - the general credits, you will use somewhere in your code: - </para> - <para> - <informalexample> - <programlisting role="php"> +<refentry id="function.phpcredits"> + <refnamediv> + <refname>phpcredits</refname> + <refpurpose>Prints out the credits for PHP</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>phpcredits</methodname> + <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam> + </methodsynopsis> + <para> + This function prints out the credits listing the PHP developers, + modules, etc. It generates the appropriate HTML codes to insert + the information in a page. <parameter>flag</parameter> is + optional, and it defaults to <constant>CREDITS_ALL</constant>. + To generate a custom credits page, you may want to use the + <parameter>flag</parameter> parameter. For example to print + the general credits, you will use somewhere in your code: + </para> + <para> + <informalexample> + <programlisting role="php"> <![CDATA[ <?php phpcredits(CREDITS_GENERAL); ?> ]]> - </programlisting> - </informalexample> - </para> - <para> - And if you want to print the core developers and the - documentation group, in a page of its own, you will use: - </para> - <para> - <informalexample> - <programlisting role="php"> + </programlisting> + </informalexample> + </para> + <para> + And if you want to print the core developers and the + documentation group, in a page of its own, you will use: + </para> + <para> + <informalexample> + <programlisting role="php"> <![CDATA[ <?php phpcredits(CREDITS_GROUP + CREDITS_DOCS + CREDITS_FULLPAGE); ?> ]]> - </programlisting> - </informalexample> - </para> - <para> - And if you feel like embedding all the credits in your page, then - code like the one below will do it: - </para> - <para> - <informalexample> - <programlisting role="php"> + </programlisting> + </informalexample> + </para> + <para> + And if you feel like embedding all the credits in your page, then + code like the one below will do it: + </para> + <para> + <informalexample> + <programlisting role="php"> <![CDATA[ <html> <head> @@ -68,76 +68,76 @@ </body> </html> ]]> - </programlisting> - </informalexample> - </para> - <para> - <table> - <title>Pre-defined <function>phpcredits</function> flags</title> - <tgroup cols="2"> - <thead> - <row> - <entry>name</entry> - <entry>description</entry> - </row> - </thead> - <tbody> - <row> - <entry>CREDITS_ALL</entry> - <entry> - All the credits, equivalent to using: CREDITS_DOCS + - CREDITS_GENERAL + CREDITS_GROUP + CREDITS_MODULES + - CREDITS_FULLPAGE. It generates a complete stand-alone HTML - page with the appropriate tags. - </entry> - </row> - <row> - <entry>CREDITS_DOCS</entry> - <entry>The credits for the documentation team</entry> - </row> - <row> - <entry>CREDITS_FULLPAGE</entry> - <entry> - Usually used in combination with the other flags. Indicates - that a complete stand-alone HTML page needs to be - printed including the information indicated by the other - flags. - </entry> - </row> - <row> - <entry>CREDITS_GENERAL</entry> - <entry> - General credits: Language design and concept, PHP 4.0 - authors and SAPI module. - </entry> - </row> - <row> - <entry>CREDITS_GROUP</entry> - <entry>A list of the core developers</entry> - </row> - <row> - <entry>CREDITS_MODULES</entry> - <entry> - A list of the extension modules for PHP, and their authors - </entry> - </row> - <row> - <entry>CREDITS_SAPI</entry> - <entry> - A list of the server API modules for PHP, and their authors - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - See also <function>phpinfo</function>, - <function>phpversion</function> and - <function>php_logo_guid</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </informalexample> + </para> + <para> + <table> + <title>Pre-defined <function>phpcredits</function> flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>name</entry> + <entry>description</entry> + </row> + </thead> + <tbody> + <row> + <entry>CREDITS_ALL</entry> + <entry> + All the credits, equivalent to using: CREDITS_DOCS + + CREDITS_GENERAL + CREDITS_GROUP + CREDITS_MODULES + + CREDITS_FULLPAGE. It generates a complete stand-alone HTML + page with the appropriate tags. + </entry> + </row> + <row> + <entry>CREDITS_DOCS</entry> + <entry>The credits for the documentation team</entry> + </row> + <row> + <entry>CREDITS_FULLPAGE</entry> + <entry> + Usually used in combination with the other flags. Indicates + that a complete stand-alone HTML page needs to be + printed including the information indicated by the other + flags. + </entry> + </row> + <row> + <entry>CREDITS_GENERAL</entry> + <entry> + General credits: Language design and concept, PHP 4.0 + authors and SAPI module. + </entry> + </row> + <row> + <entry>CREDITS_GROUP</entry> + <entry>A list of the core developers</entry> + </row> + <row> + <entry>CREDITS_MODULES</entry> + <entry> + A list of the extension modules for PHP, and their authors + </entry> + </row> + <row> + <entry>CREDITS_SAPI</entry> + <entry> + A list of the server API modules for PHP, and their authors + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + See also <function>phpinfo</function>, + <function>phpversion</function> and + <function>php_logo_guid</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/phpinfo.xml?r1=1.14&r2=1.15&diff_format=u Index: phpdoc/en/reference/info/functions/phpinfo.xml diff -u phpdoc/en/reference/info/functions/phpinfo.xml:1.14 phpdoc/en/reference/info/functions/phpinfo.xml:1.15 --- phpdoc/en/reference/info/functions/phpinfo.xml:1.14 Thu Jun 23 16:53:18 2005 +++ phpdoc/en/reference/info/functions/phpinfo.xml Sun Feb 4 22:42:28 2007 @@ -1,126 +1,126 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.14 $ --> +<!-- $Revision: 1.15 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.phpinfo"> - <refnamediv> - <refname>phpinfo</refname> - <refpurpose>Outputs lots of PHP information</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>phpinfo</methodname> - <methodparam choice="opt"><type>int</type><parameter>what</parameter></methodparam> - </methodsynopsis> - <para> - Outputs a large amount of information about the current state of - PHP. This includes information about PHP compilation options and - extensions, the PHP version, server information and environment - (if compiled as a module), the PHP environment, OS version - information, paths, master and local values of configuration - options, HTTP headers, and the PHP License. - </para> - <para> - Because every system is setup differently, - <function>phpinfo</function> is commonly used to check <link - linkend="configuration">configuration settings</link> and for - available <link - linkend="language.variables.predefined">predefined - variables</link> on a given system. Also, - <function>phpinfo</function> is a valuable debugging tool as it - contains all EGPCS (Environment, GET, POST, Cookie, Server) data. - </para> - <para> - The output may be customized by passing one or more of the - following <emphasis>constants</emphasis> bitwise values summed - together in the optional <parameter>what</parameter> parameter. - One can also combine the respective constants or bitwise values - together with the <link - linkend="language.operators.bitwise">or</link> operator. - </para> - <para> - <table> - <title><function>phpinfo</function> options</title> - <tgroup cols="3"> - <thead> - <row> - <entry>Name (constant)</entry> - <entry>Value</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>INFO_GENERAL</entry> - <entry>1</entry> - <entry> - The configuration line, &php.ini; location, build date, Web - Server, System and more. - </entry> - </row> - <row> - <entry>INFO_CREDITS</entry> - <entry>2</entry> - <entry> - PHP Credits. See also <function>phpcredits</function>. - </entry> - </row> - <row> - <entry>INFO_CONFIGURATION</entry> - <entry>4</entry> - <entry> - Current Local and Master values for PHP directives. See - also <function>ini_get</function>. - </entry> - </row> - <row> - <entry>INFO_MODULES</entry> - <entry>8</entry> - <entry> - Loaded modules and their respective settings. See also - <function>get_loaded_extensions</function>. - </entry> - </row> - <row> - <entry>INFO_ENVIRONMENT</entry> - <entry>16</entry> - <entry> - Environment Variable information that's also available in - <varname>$_ENV</varname>. - </entry> - </row> - <row> - <entry>INFO_VARIABLES</entry> - <entry>32</entry> - <entry> - Shows all <link linkend="language.variables.predefined"> - predefined variables</link> from EGPCS (Environment, GET, - POST, Cookie, Server). - </entry> - </row> - <row> - <entry>INFO_LICENSE</entry> - <entry>64</entry> - <entry> - PHP License information. See also the <ulink - url="&url.php.license;">license FAQ</ulink>. - </entry> - </row> - <row> - <entry>INFO_ALL</entry> - <entry>-1</entry> - <entry> - Shows all of the above. This is the default value. - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - <para> - <example> - <title><function>phpinfo</function> examples</title> - <programlisting role="php"> +<refentry id="function.phpinfo"> + <refnamediv> + <refname>phpinfo</refname> + <refpurpose>Outputs lots of PHP information</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>phpinfo</methodname> + <methodparam choice="opt"><type>int</type><parameter>what</parameter></methodparam> + </methodsynopsis> + <para> + Outputs a large amount of information about the current state of + PHP. This includes information about PHP compilation options and + extensions, the PHP version, server information and environment + (if compiled as a module), the PHP environment, OS version + information, paths, master and local values of configuration + options, HTTP headers, and the PHP License. + </para> + <para> + Because every system is setup differently, + <function>phpinfo</function> is commonly used to check <link + linkend="configuration">configuration settings</link> and for + available <link + linkend="language.variables.predefined">predefined + variables</link> on a given system. Also, + <function>phpinfo</function> is a valuable debugging tool as it + contains all EGPCS (Environment, GET, POST, Cookie, Server) data. + </para> + <para> + The output may be customized by passing one or more of the + following <emphasis>constants</emphasis> bitwise values summed + together in the optional <parameter>what</parameter> parameter. + One can also combine the respective constants or bitwise values + together with the <link + linkend="language.operators.bitwise">or</link> operator. + </para> + <para> + <table> + <title><function>phpinfo</function> options</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Name (constant)</entry> + <entry>Value</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>INFO_GENERAL</entry> + <entry>1</entry> + <entry> + The configuration line, &php.ini; location, build date, Web + Server, System and more. + </entry> + </row> + <row> + <entry>INFO_CREDITS</entry> + <entry>2</entry> + <entry> + PHP Credits. See also <function>phpcredits</function>. + </entry> + </row> + <row> + <entry>INFO_CONFIGURATION</entry> + <entry>4</entry> + <entry> + Current Local and Master values for PHP directives. See + also <function>ini_get</function>. + </entry> + </row> + <row> + <entry>INFO_MODULES</entry> + <entry>8</entry> + <entry> + Loaded modules and their respective settings. See also + <function>get_loaded_extensions</function>. + </entry> + </row> + <row> + <entry>INFO_ENVIRONMENT</entry> + <entry>16</entry> + <entry> + Environment Variable information that's also available in + <varname>$_ENV</varname>. + </entry> + </row> + <row> + <entry>INFO_VARIABLES</entry> + <entry>32</entry> + <entry> + Shows all <link linkend="language.variables.predefined"> + predefined variables</link> from EGPCS (Environment, GET, + POST, Cookie, Server). + </entry> + </row> + <row> + <entry>INFO_LICENSE</entry> + <entry>64</entry> + <entry> + PHP License information. See also the <ulink + url="&url.php.license;">license FAQ</ulink>. + </entry> + </row> + <row> + <entry>INFO_ALL</entry> + <entry>-1</entry> + <entry> + Shows all of the above. This is the default value. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + <example> + <title><function>phpinfo</function> examples</title> + <programlisting role="php"> <![CDATA[ <?php @@ -133,36 +133,36 @@ ?> ]]> - </programlisting> - </example> - </para> - <note> - <para> - Parts of the information displayed are disabled when the - <link linkend="ini.expose-php">expose_php</link> configuration setting - is set to <literal>off</literal>. This includes the PHP and Zend logos, - and the credits. - </para> - </note> - <note> - <para> - <function>phpinfo</function> outputs plain text instead of HTML when - using the CLI mode. - </para> - </note> - <para> - See also <function>phpversion</function>, - <function>phpcredits</function>, - <function>php_logo_guid</function>, - <function>ini_get</function>, - <function>ini_set</function>, - <function>get_loaded_extensions</function>, - and the section on <link - linkend="language.variables.predefined">Predefined - Variables</link>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <note> + <para> + Parts of the information displayed are disabled when the + <link linkend="ini.expose-php">expose_php</link> configuration setting + is set to <literal>off</literal>. This includes the PHP and Zend logos, + and the credits. + </para> + </note> + <note> + <para> + <function>phpinfo</function> outputs plain text instead of HTML when + using the CLI mode. + </para> + </note> + <para> + See also <function>phpversion</function>, + <function>phpcredits</function>, + <function>php_logo_guid</function>, + <function>ini_get</function>, + <function>ini_set</function>, + <function>get_loaded_extensions</function>, + and the section on <link + linkend="language.variables.predefined">Predefined + Variables</link>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/phpversion.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/info/functions/phpversion.xml diff -u phpdoc/en/reference/info/functions/phpversion.xml:1.6 phpdoc/en/reference/info/functions/phpversion.xml:1.7 --- phpdoc/en/reference/info/functions/phpversion.xml:1.6 Fri Dec 3 23:40:27 2004 +++ phpdoc/en/reference/info/functions/phpversion.xml Sun Feb 4 22:42:28 2007 @@ -1,34 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.phpversion"> - <refnamediv> - <refname>phpversion</refname> - <refpurpose>Gets the current PHP version</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>phpversion</methodname> - <methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam> - </methodsynopsis> - <para> - Returns a string containing the version of the currently running - PHP parser. If the optional <parameter>extension</parameter> parameter is - specified, <function>phpversion</function> returns the version of that - extension, or &false; if there is no version information associated or - the extension isn't enabled. - </para> - <note> - <para> - This information is also available in the predefined constant - <constant>PHP_VERSION</constant>. - </para> - </note> - <para> - <example> - <title><function>phpversion</function> example</title> - <programlisting role="php"> +<refentry id="function.phpversion"> + <refnamediv> + <refname>phpversion</refname> + <refpurpose>Gets the current PHP version</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>phpversion</methodname> + <methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam> + </methodsynopsis> + <para> + Returns a string containing the version of the currently running + PHP parser. If the optional <parameter>extension</parameter> parameter is + specified, <function>phpversion</function> returns the version of that + extension, or &false; if there is no version information associated or + the extension isn't enabled. + </para> + <note> + <para> + This information is also available in the predefined constant + <constant>PHP_VERSION</constant>. + </para> + </note> + <para> + <example> + <title><function>phpversion</function> example</title> + <programlisting role="php"> <![CDATA[ <?php // prints e.g. 'Current PHP version: 4.1.1' @@ -38,19 +38,19 @@ echo phpversion('tidy'); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>version_compare</function>, - <function>phpinfo</function>, - <function>phpcredits</function>, - <function>php_logo_guid</function>, and - <function>zend_version</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>version_compare</function>, + <function>phpinfo</function>, + <function>phpcredits</function>, + <function>php_logo_guid</function>, and + <function>zend_version</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/putenv.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/info/functions/putenv.xml diff -u phpdoc/en/reference/info/functions/putenv.xml:1.6 phpdoc/en/reference/info/functions/putenv.xml:1.7 --- phpdoc/en/reference/info/functions/putenv.xml:1.6 Thu Jun 23 16:53:18 2005 +++ phpdoc/en/reference/info/functions/putenv.xml Sun Feb 4 22:42:28 2007 @@ -1,63 +1,63 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.putenv"> - <refnamediv> - <refname>putenv</refname> - <refpurpose>Sets the value of an environment variable</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>putenv</methodname> - <methodparam><type>string</type><parameter>setting</parameter></methodparam> - </methodsynopsis> - <para> - Adds <parameter>setting</parameter> to the server environment. The - environment variable will only exist for the duration of the current - request. At the end of the request the environment is restored to its - original state. - </para> - <para> - Setting certain environment variables may be a potential security breach. - The <literal>safe_mode_allowed_env_vars</literal> directive contains a - comma-delimited list of prefixes. In Safe Mode, the user may only alter - environment variables whose names begin with the prefixes supplied by - this directive. By default, users will only be able to set environment - variables that begin with <literal>PHP_</literal> (e.g. - <literal>PHP_FOO=BAR</literal>). Note: if this directive is empty, PHP - will let the user modify ANY environment variable! - </para> - <para> - The <literal>safe_mode_protected_env_vars</literal> directive contains a - comma-delimited list of environment variables, that the end user won't be - able to change using <function>putenv</function>. These variables will - be protected even if <literal>safe_mode_allowed_env_vars</literal> is set - to allow to change them. - </para> - <warning> - <para> - These directives have only effect when <link - linkend="features.safe-mode">safe-mode</link> itself is enabled! - </para> - </warning> - <para> - <example> - <title>Setting an environment variable</title> - <programlisting role="php"> +<refentry id="function.putenv"> + <refnamediv> + <refname>putenv</refname> + <refpurpose>Sets the value of an environment variable</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>putenv</methodname> + <methodparam><type>string</type><parameter>setting</parameter></methodparam> + </methodsynopsis> + <para> + Adds <parameter>setting</parameter> to the server environment. The + environment variable will only exist for the duration of the current + request. At the end of the request the environment is restored to its + original state. + </para> + <para> + Setting certain environment variables may be a potential security breach. + The <literal>safe_mode_allowed_env_vars</literal> directive contains a + comma-delimited list of prefixes. In Safe Mode, the user may only alter + environment variables whose names begin with the prefixes supplied by + this directive. By default, users will only be able to set environment + variables that begin with <literal>PHP_</literal> (e.g. + <literal>PHP_FOO=BAR</literal>). Note: if this directive is empty, PHP + will let the user modify ANY environment variable! + </para> + <para> + The <literal>safe_mode_protected_env_vars</literal> directive contains a + comma-delimited list of environment variables, that the end user won't be + able to change using <function>putenv</function>. These variables will + be protected even if <literal>safe_mode_allowed_env_vars</literal> is set + to allow to change them. + </para> + <warning> + <para> + These directives have only effect when <link + linkend="features.safe-mode">safe-mode</link> itself is enabled! + </para> + </warning> + <para> + <example> + <title>Setting an environment variable</title> + <programlisting role="php"> <![CDATA[ <?php putenv("UNIQID=$uniqid"); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>getenv</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>getenv</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/restore-include-path.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/info/functions/restore-include-path.xml diff -u phpdoc/en/reference/info/functions/restore-include-path.xml:1.3 phpdoc/en/reference/info/functions/restore-include-path.xml:1.4 --- phpdoc/en/reference/info/functions/restore-include-path.xml:1.3 Mon Dec 15 16:51:14 2003 +++ phpdoc/en/reference/info/functions/restore-include-path.xml Sun Feb 4 22:42:28 2007 @@ -1,27 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> - <refentry id="function.restore-include-path"> - <refnamediv> - <refname>restore_include_path</refname> - <refpurpose> - Restores the value of the include_path configuration option - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>restore_include_path</methodname> - <void /> - </methodsynopsis> - <simpara> - Restores the <link linkend="ini.include-path">include_path</link> - configuration option back to its original master value as set in - &php.ini; - </simpara> - <para> - <example> - <title><function>restore_include_path</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.4 $ --> +<refentry id="function.restore-include-path"> + <refnamediv> + <refname>restore_include_path</refname> + <refpurpose>Restores the value of the include_path configuration option</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>void</type><methodname>restore_include_path</methodname> + <void /> + </methodsynopsis> + <simpara> + Restores the <link linkend="ini.include-path">include_path</link> + configuration option back to its original master value as set in + &php.ini; + </simpara> + <para> + <example> + <title><function>restore_include_path</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -41,17 +39,17 @@ ?> ]]> - </programlisting> - </example> - </para> - <simpara> - See also <function>ini_restore</function>, - <function>set_include_path</function>, - <function>get_include_path</function>, and - <function>include</function>. - </simpara> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <simpara> + See also <function>ini_restore</function>, + <function>set_include_path</function>, + <function>get_include_path</function>, and + <function>include</function>. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/set-include-path.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/info/functions/set-include-path.xml diff -u phpdoc/en/reference/info/functions/set-include-path.xml:1.3 phpdoc/en/reference/info/functions/set-include-path.xml:1.4 --- phpdoc/en/reference/info/functions/set-include-path.xml:1.3 Thu Nov 4 03:40:37 2004 +++ phpdoc/en/reference/info/functions/set-include-path.xml Sun Feb 4 22:42:28 2007 @@ -1,28 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> - <refentry id="function.set-include-path"> - <refnamediv> - <refname>set_include_path</refname> - <refpurpose> - Sets the include_path configuration option - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>set_include_path</methodname> - <methodparam><type>string</type><parameter>new_include_path</parameter></methodparam> - </methodsynopsis> - <simpara> - Sets the <link linkend="ini.include-path">include_path</link> - configuration option for the duration of the script. Returns the old - <link linkend="ini.include-path">include_path</link> on success or - &false; on failure. - </simpara> - <para> - <example> - <title><function>set_include_path</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.4 $ --> +<refentry id="function.set-include-path"> + <refnamediv> + <refname>set_include_path</refname> + <refpurpose>Sets the include_path configuration option</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>set_include_path</methodname> + <methodparam><type>string</type><parameter>new_include_path</parameter></methodparam> + </methodsynopsis> + <simpara> + Sets the <link linkend="ini.include-path">include_path</link> + configuration option for the duration of the script. Returns the old + <link linkend="ini.include-path">include_path</link> on success or + &false; on failure. + </simpara> + <para> + <example> + <title><function>set_include_path</function> example</title> + <programlisting role="php"> <![CDATA[ <?php // Works as of PHP 4.3.0 @@ -32,39 +30,39 @@ ini_set('include_path', '/inc'); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> + <para> + <example> + <title>Adding to the include path</title> + <para> + Making use of the <constant>PATH_SEPARATOR</constant> + constant, it is possible to extend the include path + regardless of the operating system. </para> <para> - <example> - <title>Adding to the include path</title> - <para> - Making use of the <constant>PATH_SEPARATOR</constant> - constant, it is possible to extend the include path - regardless of the operating system. - </para> - <para> - In this example we add <filename>/usr/lib/pear</filename> - to the end of the existing <literal>include_path</literal>. - </para> - <programlisting role="php"> + In this example we add <filename>/usr/lib/pear</filename> + to the end of the existing <literal>include_path</literal>. + </para> + <programlisting role="php"> <![CDATA[ <?php $path = '/usr/lib/pear'; set_include_path(get_include_path() . PATH_SEPARATOR . $path); ?> ]]> - </programlisting> - </example> - </para> - <simpara> - See also <function>ini_set</function>, - <function>get_include_path</function>, - <function>restore_include_path</function>, and - <function>include</function>. - </simpara> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <simpara> + See also <function>ini_set</function>, + <function>get_include_path</function>, + <function>restore_include_path</function>, and + <function>include</function>. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/set-magic-quotes-runtime.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/info/functions/set-magic-quotes-runtime.xml diff -u phpdoc/en/reference/info/functions/set-magic-quotes-runtime.xml:1.3 phpdoc/en/reference/info/functions/set-magic-quotes-runtime.xml:1.4 --- phpdoc/en/reference/info/functions/set-magic-quotes-runtime.xml:1.3 Wed Feb 5 02:38:39 2003 +++ phpdoc/en/reference/info/functions/set-magic-quotes-runtime.xml Sun Feb 4 22:42:28 2007 @@ -1,31 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.set-magic-quotes-runtime"> - <refnamediv> - <refname>set_magic_quotes_runtime</refname> - <refpurpose> - Sets the current active configuration setting of - magic_quotes_runtime - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>set_magic_quotes_runtime</methodname> - <methodparam><type>int</type><parameter>new_setting</parameter></methodparam> - </methodsynopsis> - <simpara> - Set the current active configuration setting of <link - linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> (0 - for off, 1 for on). - </simpara> - <simpara> - See also: <function>get_magic_quotes_gpc</function> and - <function>get_magic_quotes_runtime</function>. - </simpara> - </refsect1> - </refentry> +<refentry id="function.set-magic-quotes-runtime"> + <refnamediv> + <refname>set_magic_quotes_runtime</refname> + <refpurpose>Sets the current active configuration setting of magic_quotes_runtime</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>set_magic_quotes_runtime</methodname> + <methodparam><type>int</type><parameter>new_setting</parameter></methodparam> + </methodsynopsis> + <simpara> + Set the current active configuration setting of <link + linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> (0 + for off, 1 for on). + </simpara> + <simpara> + See also: <function>get_magic_quotes_gpc</function> and + <function>get_magic_quotes_runtime</function>. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/set-time-limit.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/info/functions/set-time-limit.xml diff -u phpdoc/en/reference/info/functions/set-time-limit.xml:1.7 phpdoc/en/reference/info/functions/set-time-limit.xml:1.8 --- phpdoc/en/reference/info/functions/set-time-limit.xml:1.7 Wed Feb 4 17:47:00 2004 +++ phpdoc/en/reference/info/functions/set-time-limit.xml Sun Feb 4 22:42:28 2007 @@ -1,58 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.72 --> - <refentry id="function.set-time-limit"> - <refnamediv> - <refname>set_time_limit</refname> - <refpurpose>Limits the maximum execution time</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>set_time_limit</methodname> - <methodparam><type>int</type><parameter>seconds</parameter></methodparam> - </methodsynopsis> - <simpara> - Set the number of seconds a script is allowed to run. If this is - reached, the script returns a fatal error. The default limit is - 30 seconds or, if it exists, the - <literal>max_execution_time</literal> value defined in the &php.ini;. - If <parameter>seconds</parameter> is set to zero, no time limit is - imposed. - </simpara> - <simpara> - When called, <function>set_time_limit</function> restarts the - timeout counter from zero. In other words, if the timeout is the - default 30 seconds, and 25 seconds into script execution a call - such as set_time_limit(20) is made, the script will run for a - total of 45 seconds before timing out. - </simpara> - <warning> - <para> - <function>set_time_limit</function> has no effect when PHP is - running in &safemode;. There is no workaround other than turning - off safe mode or changing the time limit in the &php.ini;. - </para> - </warning> - <note> - <para> - The <function>set_time_limit</function> function and the - configuration directive <link - linkend="ini.max-execution-time">max_execution_time</link> only - affect the execution time of the script itself. Any time spent - on activity that happens outside the execution of the script - such as system calls using <function>system</function>, stream - operations, database queries, etc. is not included when determining the - maximum time that the script has been running. - </para> - </note> - <simpara> - See also: <link - linkend="ini.max-execution-time">max_execution_time</link> and <link - linkend="ini.max-input-time">max_input_time</link> ini directives. - </simpara> - </refsect1> - </refentry> +<refentry id="function.set-time-limit"> + <refnamediv> + <refname>set_time_limit</refname> + <refpurpose>Limits the maximum execution time</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>void</type><methodname>set_time_limit</methodname> + <methodparam><type>int</type><parameter>seconds</parameter></methodparam> + </methodsynopsis> + <simpara> + Set the number of seconds a script is allowed to run. If this is + reached, the script returns a fatal error. The default limit is + 30 seconds or, if it exists, the + <literal>max_execution_time</literal> value defined in the &php.ini;. + If <parameter>seconds</parameter> is set to zero, no time limit is + imposed. + </simpara> + <simpara> + When called, <function>set_time_limit</function> restarts the + timeout counter from zero. In other words, if the timeout is the + default 30 seconds, and 25 seconds into script execution a call + such as set_time_limit(20) is made, the script will run for a + total of 45 seconds before timing out. + </simpara> + <warning> + <para> + <function>set_time_limit</function> has no effect when PHP is + running in &safemode;. There is no workaround other than turning + off safe mode or changing the time limit in the &php.ini;. + </para> + </warning> + <note> + <para> + The <function>set_time_limit</function> function and the + configuration directive <link + linkend="ini.max-execution-time">max_execution_time</link> only + affect the execution time of the script itself. Any time spent + on activity that happens outside the execution of the script + such as system calls using <function>system</function>, stream + operations, database queries, etc. is not included when determining the + maximum time that the script has been running. + </para> + </note> + <simpara> + See also: <link + linkend="ini.max-execution-time">max_execution_time</link> and <link + linkend="ini.max-input-time">max_input_time</link> ini directives. + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/sys-get-temp-dir.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/info/functions/sys-get-temp-dir.xml diff -u phpdoc/en/reference/info/functions/sys-get-temp-dir.xml:1.1 phpdoc/en/reference/info/functions/sys-get-temp-dir.xml:1.2 --- phpdoc/en/reference/info/functions/sys-get-temp-dir.xml:1.1 Fri May 19 13:20:58 2006 +++ phpdoc/en/reference/info/functions/sys-get-temp-dir.xml Sun Feb 4 22:42:28 2007 @@ -1,27 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> - <refentry id="function.sys-get-temp-dir"> - <refnamediv> - <refname>sys_get_temp_dir</refname> - <refpurpose> - Returns directory path used for temporary files - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>sys_get_temp_dir</methodname> - <void/> - </methodsynopsis> - <para> - This function returns the path of the directory PHP stores temporary - files in by default. - </para> - <para> - See also <function>tmpfile</function>, <function>tempnam</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.2 $ --> +<refentry id="function.sys-get-temp-dir"> + <refnamediv> + <refname>sys_get_temp_dir</refname> + <refpurpose>Returns directory path used for temporary files</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>sys_get_temp_dir</methodname> + <void/> + </methodsynopsis> + <para> + This function returns the path of the directory PHP stores temporary + files in by default. + </para> + <para> + See also <function>tmpfile</function>, <function>tempnam</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/version-compare.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/info/functions/version-compare.xml diff -u phpdoc/en/reference/info/functions/version-compare.xml:1.10 phpdoc/en/reference/info/functions/version-compare.xml:1.11 --- phpdoc/en/reference/info/functions/version-compare.xml:1.10 Thu Jun 23 16:53:18 2005 +++ phpdoc/en/reference/info/functions/version-compare.xml Sun Feb 4 22:42:28 2007 @@ -1,72 +1,68 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.2 --> - <refentry id="function.version-compare"> - <refnamediv> - <refname>version_compare</refname> - <refpurpose> - Compares two "PHP-standardized" version number strings - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>version_compare</methodname> - <methodparam><type>string</type><parameter>version1</parameter></methodparam> - <methodparam><type>string</type><parameter>version2</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter> - operator - </parameter></methodparam> - </methodsynopsis> - <para> - <function>version_compare</function> compares two - "PHP-standardized" version number strings. This is useful if you - would like to write programs working only on some versions of - PHP. - </para> - <para> - <function>version_compare</function> returns -1 if the first - version is lower than the second, 0 if they are equal, and +1 if - the second is lower. - </para> - <para> - The function first replaces <literal>_</literal>, <literal>-</literal> - and <literal>+</literal> with a dot <literal>.</literal> in the version - strings and also inserts dots <literal>.</literal> before and after any - non number so that for example '4.3.2RC1' becomes '4.3.2.RC.1'. Then it - splits the results like if you were using explode('.', $ver). Then it - compares the parts starting from left to right. If a part contains - special version strings these are handled in the following order: - <literal>dev</literal> &lt; <literal>alpha</literal> = - <literal>a</literal> &lt; <literal>beta</literal> = - <literal>b</literal> &lt; <literal>RC</literal> &lt; - <literal>pl</literal>. This way not only versions with different levels - like '4.1' and '4.1.2' can be compared but also any PHP specific version - containing development state. - </para> - <para> - If you specify the third optional <parameter>operator</parameter> - argument, you can test for a particular relationship. The - possible operators are: <literal>&lt;</literal>, - <literal>lt</literal>, <literal>&lt;=</literal>, - <literal>le</literal>, <literal>&gt;</literal>, - <literal>gt</literal>, <literal>&gt;=</literal>, - <literal>ge</literal>, <literal>==</literal>, - <literal>=</literal>, <literal>eq</literal>, - <literal>!=</literal>, <literal>&lt;&gt;</literal>, - <literal>ne</literal> respectively. Using this argument, the - function will return &true; if the relationship is the one specified - by the operator, &false; otherwise. - </para> - <note> - <para> - <constant>PHP_VERSION</constant> constant holds current PHP version. - </para> - </note> - <para> - <example> - <title><function>version_compare</function> example</title> - <programlisting role="php"> +<refentry id="function.version-compare"> + <refnamediv> + <refname>version_compare</refname> + <refpurpose>Compares two "PHP-standardized" version number strings</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>mixed</type><methodname>version_compare</methodname> + <methodparam><type>string</type><parameter>version1</parameter></methodparam> + <methodparam><type>string</type><parameter>version2</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>operator</parameter></methodparam> + </methodsynopsis> + <para> + <function>version_compare</function> compares two + "PHP-standardized" version number strings. This is useful if you + would like to write programs working only on some versions of + PHP. + </para> + <para> + <function>version_compare</function> returns -1 if the first + version is lower than the second, 0 if they are equal, and +1 if + the second is lower. + </para> + <para> + The function first replaces <literal>_</literal>, <literal>-</literal> + and <literal>+</literal> with a dot <literal>.</literal> in the version + strings and also inserts dots <literal>.</literal> before and after any + non number so that for example '4.3.2RC1' becomes '4.3.2.RC.1'. Then it + splits the results like if you were using explode('.', $ver). Then it + compares the parts starting from left to right. If a part contains + special version strings these are handled in the following order: + <literal>dev</literal> &lt; <literal>alpha</literal> = + <literal>a</literal> &lt; <literal>beta</literal> = + <literal>b</literal> &lt; <literal>RC</literal> &lt; + <literal>pl</literal>. This way not only versions with different levels + like '4.1' and '4.1.2' can be compared but also any PHP specific version + containing development state. + </para> + <para> + If you specify the third optional <parameter>operator</parameter> + argument, you can test for a particular relationship. The + possible operators are: <literal>&lt;</literal>, + <literal>lt</literal>, <literal>&lt;=</literal>, + <literal>le</literal>, <literal>&gt;</literal>, + <literal>gt</literal>, <literal>&gt;=</literal>, + <literal>ge</literal>, <literal>==</literal>, + <literal>=</literal>, <literal>eq</literal>, + <literal>!=</literal>, <literal>&lt;&gt;</literal>, + <literal>ne</literal> respectively. Using this argument, the + function will return &true; if the relationship is the one specified + by the operator, &false; otherwise. + </para> + <note> + <para> + <constant>PHP_VERSION</constant> constant holds current PHP version. + </para> + </note> + <para> + <example> + <title><function>version_compare</function> example</title> + <programlisting role="php"> <![CDATA[ <?php // prints -1 @@ -77,11 +73,11 @@ echo version_compare("4.0.6", "4.0.6", "eq"); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/zend-logo-guid.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/info/functions/zend-logo-guid.xml diff -u phpdoc/en/reference/info/functions/zend-logo-guid.xml:1.9 phpdoc/en/reference/info/functions/zend-logo-guid.xml:1.10 --- phpdoc/en/reference/info/functions/zend-logo-guid.xml:1.9 Sun Jan 28 01:33:50 2007 +++ phpdoc/en/reference/info/functions/zend-logo-guid.xml Sun Feb 4 22:42:28 2007 @@ -1,25 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.39 --> - <refentry id="function.zend-logo-guid"> - <refnamediv> - <refname>zend_logo_guid</refname> - <refpurpose>Gets the Zend guid</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>zend_logo_guid</methodname> - <void/> - </methodsynopsis> - <para> - This function returns the ID which can be used to display the Zend logo - using the built-in image. - </para> - <para> - <example> - <title><function>zend_logo_guid</function> example</title> - <programlisting role="php"> +<refentry id="function.zend-logo-guid"> + <refnamediv> + <refname>zend_logo_guid</refname> + <refpurpose>Gets the Zend guid</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>zend_logo_guid</methodname> + <void/> + </methodsynopsis> + <para> + This function returns the ID which can be used to display the Zend logo + using the built-in image. + </para> + <para> + <example> + <title><function>zend_logo_guid</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -28,14 +28,14 @@ ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>php_logo_guid</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>php_logo_guid</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/zend-version.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/info/functions/zend-version.xml diff -u phpdoc/en/reference/info/functions/zend-version.xml:1.9 phpdoc/en/reference/info/functions/zend-version.xml:1.10 --- phpdoc/en/reference/info/functions/zend-version.xml:1.9 Thu Dec 18 11:47:08 2003 +++ phpdoc/en/reference/info/functions/zend-version.xml Sun Feb 4 22:42:28 2007 @@ -1,42 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/info.xml, last change in rev 1.11 --> - <refentry id="function.zend-version"> - <refnamediv> - <refname>zend_version</refname> - <refpurpose>Gets the version of the current Zend engine</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>zend_version</methodname> - <void/> - </methodsynopsis> - <para> - Returns a string containing the version of the currently running - Zend Engine. - </para> - <para> - <example> - <title><function>zend_version</function> example</title> - <programlisting role="php"> +<refentry id="function.zend-version"> + <refnamediv> + <refname>zend_version</refname> + <refpurpose>Gets the version of the current Zend engine</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>zend_version</methodname> + <void/> + </methodsynopsis> + <para> + Returns a string containing the version of the currently running + Zend Engine. + </para> + <para> + <example> + <title><function>zend_version</function> example</title> + <programlisting role="php"> <![CDATA[ <?php // prints e.g. 'Zend engine version: 1.0.4' echo "Zend engine version: " . zend_version(); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>phpinfo</function>, - <function>phpcredits</function>, - <function>php_logo_guid</function>, and - <function>phpversion</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>phpinfo</function>, + <function>phpcredits</function>, + <function>php_logo_guid</function>, and + <function>phpversion</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: