sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 08:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Generate some standard methodsynopses based on stubs

Browse source 
Cf. <https://github.com/php/doc-en/pull/289>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352191 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2020-12-26 19:26:31 +00:00
parent a331ac8a86
commit 0c9c2dd669
183 changed files with 888 additions and 1012 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
reference/datetime/functions/gettimeofday.xml
View file

@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>gettimeofday</methodname>
<methodparam choice="opt"><type>bool</type><parameter>returnFloat</parameter><initializer>&false;</initializer></methodparam>
<type class="union"><type>array</type><type>float</type></type><methodname>gettimeofday</methodname>
<methodparam choice="opt"><type>bool</type><parameter>as_float</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
This is an interface to gettimeofday(2). It returns an
@ -24,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>returnFloat</parameter></term>
<term><parameter>as_float</parameter></term>
<listitem>
<para>
When set to &true;, a float instead of an array is returned.
@ -38,7 +38,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
By default an <type>array</type> is returned. If <parameter>returnFloat</parameter>
By default an <type>array</type> is returned. If <parameter>as_float</parameter>
is set, then a <type>float</type> is returned.
</para>
<para>
@ -100,7 +100,6 @@ Array
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/datetime/functions/microtime.xml
View file

@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>microtime</methodname>
<methodparam choice="opt"><type>bool</type><parameter>getAsFloat</parameter><initializer>&false;</initializer></methodparam>
<type class="union"><type>string</type><type>float</type></type><methodname>microtime</methodname>
<methodparam choice="opt"><type>bool</type><parameter>as_float</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<function>microtime</function> returns the current Unix timestamp with
@ -27,7 +27,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>getAsFloat</parameter></term>
<term><parameter>as_float</parameter></term>
<listitem>
<para>
If used and set to &true;, <function>microtime</function> will return a
@ -50,7 +50,7 @@
and is also expressed in seconds.
</para>
<para>
If <parameter>getAsFloat</parameter> is set to &true;, then
If <parameter>as_float</parameter> is set to &true;, then
<function>microtime</function> returns a <type>float</type>, which
represents the current time in seconds since the Unix epoch accurate to the
nearest microsecond.
@ -135,7 +135,6 @@ echo "Did nothing in $time seconds\n";
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

19
reference/datetime/functions/strptime.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.strptime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refentry xml:id="function.strptime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>strptime</refname>
<refpurpose>
@ -10,13 +10,13 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>strptime</methodname>
<methodparam><type>string</type><parameter>date</parameter></methodparam>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>strptime</methodname>
<methodparam><type>string</type><parameter>timestamp</parameter></methodparam>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
<function>strptime</function> returns an array with the
<parameter>date</parameter> parsed, or &false; on error.
<parameter>timestamp</parameter> parsed, or &false; on error.
</para>
<para>
Month and weekday names and other language dependent strings respect the
@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>date</parameter> (<type>string</type>)</term>
<term><parameter>timestamp</parameter> (<type>string</type>)</term>
<listitem>
<para>
The string to parse (e.g. returned from <function>strftime</function>).
@ -40,7 +40,7 @@
<term><parameter>format</parameter> (<type>string</type>)</term>
<listitem>
<para>
The format used in <parameter>date</parameter> (e.g. the same as
The format used in <parameter>timestamp</parameter> (e.g. the same as
used in <function>strftime</function>). Note that some of the format
options available to <function>strftime</function> may not have any
effect within <function>strptime</function>; the exact subset that are
@ -108,7 +108,7 @@
</row>
<row>
<entry><literal>"unparsed"</literal></entry>
<entry>the <parameter>date</parameter> part which was not
<entry>the <parameter>timestamp</parameter> part which was not
recognized using the specified <parameter>format</parameter></entry>
</row>
</tbody>
@ -199,7 +199,6 @@ Array
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/errorfunc/functions/error-get-last.xml
View file

@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>error_get_last</methodname>
<type class="union"><type>array</type><type>null</type></type><methodname>error_get_last</methodname>
<void/>
</methodsynopsis>
<para>
@ -70,7 +70,6 @@ Array
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

14
reference/exec/functions/exec.xml
View file

@ -10,10 +10,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>exec</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>exec</methodname>
<methodparam><type>string</type><parameter>command</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">output</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">return_var</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">output</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">result_code</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>exec</function> executes the given
@ -49,10 +49,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>return_var</parameter></term>
<term><parameter>result_code</parameter></term>
<listitem>
<para>
If the <parameter>return_var</parameter> argument is present
If the <parameter>result_code</parameter> argument is present
along with the <parameter>output</parameter> argument, then the
return status of the executed command will be written to this
variable.
@ -70,6 +70,9 @@
command and have all the data from the command passed directly back without
any interference, use the <function>passthru</function> function.
</para>
<para>
Returns &false; on failure.
</para>
<para>
To get the output of the executed command, be sure to set and use the
<parameter>output</parameter> parameter.
@ -128,7 +131,6 @@ Array
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

27
reference/exec/functions/proc-nice.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.proc-nice' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="function.proc-nice" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>proc_nice</refname>
<refpurpose>Change the priority of the current process</refpurpose>
@ -10,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>proc_nice</methodname>
<methodparam><type>int</type><parameter>increment</parameter></methodparam>
<methodparam><type>int</type><parameter>priority</parameter></methodparam>
</methodsynopsis>
<para>
<function>proc_nice</function> changes the priority of the current
process by the amount specified in <parameter>increment</parameter>. A
positive <parameter>increment</parameter> will lower the priority of the
current process, whereas a negative <parameter>increment</parameter>
process by the amount specified in <parameter>priority</parameter>. A
positive <parameter>priority</parameter> will lower the priority of the
current process, whereas a negative <parameter>priority</parameter>
will raise the priority.
</para>
<para>
@ -30,7 +30,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>increment</parameter></term>
<term><parameter>priority</parameter></term>
<listitem>
<para>
The new priority value, the value of this may differ on platforms.
@ -40,7 +40,7 @@
wheras a positive value have a lower priority.
</para>
<para>
For Windows the <parameter>increment</parameter> parameter have the
For Windows the <parameter>priority</parameter> parameter have the
following meanings:
</para>
<informaltable>
@ -55,32 +55,32 @@
<row>
<entry valign="top">High priority</entry>
<entry valign="top">
<parameter>increment</parameter> <literal>&lt; -9</literal>
<parameter>priority</parameter> <literal>&lt; -9</literal>
</entry>
</row>
<row>
<entry valign="top">Above normal priority</entry>
<entry valign="top">
<parameter>increment</parameter> <literal>&lt; -4</literal>
<parameter>priority</parameter> <literal>&lt; -4</literal>
</entry>
</row>
<row>
<entry valign="top">Normal priority</entry>
<entry valign="top">
<parameter>increment</parameter> <literal>&lt; 5</literal> &amp;
<parameter>increment</parameter> <literal>&gt; -5</literal>
<parameter>priority</parameter> <literal>&lt; 5</literal> &amp;
<parameter>priority</parameter> <literal>&gt; -5</literal>
</entry>
</row>
<row>
<entry valign="top">Below normal priority</entry>
<entry valign="top">
<parameter>increment</parameter> <literal>&gt; 5</literal>
<parameter>priority</parameter> <literal>&gt; 5</literal>
</entry>
</row>
<row>
<entry valign="top">Idle priority</entry>
<entry valign="top">
<parameter>increment</parameter> <literal>&gt; 9</literal>
<parameter>priority</parameter> <literal>&gt; 9</literal>
</entry>
</row>
</tbody>
@ -162,7 +162,6 @@ proc_nice(-20);
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/exec/functions/system.xml
View file

@ -10,9 +10,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>system</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>system</methodname>
<methodparam><type>string</type><parameter>command</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">return_var</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">result_code</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>system</function> is just like the C version of the
@ -44,10 +44,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>return_var</parameter></term>
<term><parameter>result_code</parameter></term>
<listitem>
<para>
If the <parameter>return_var</parameter> argument is present, then the
If the <parameter>result_code</parameter> argument is present, then the
return status of the executed command will be written to this
variable.
</para>
@ -112,7 +112,6 @@ echo '
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/basename.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.basename">
<refentry xml:id="function.basename" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>basename</refname>
<refpurpose>Returns trailing name component of path</refpurpose>
@ -11,7 +11,7 @@
<methodsynopsis>
<type>string</type><methodname>basename</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>suffix</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>suffix</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Given a string containing the path to a file or directory, this function
@ -113,7 +113,6 @@ echo "6) ".basename("/");
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/chgrp.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.chgrp">
<refentry xml:id="function.chgrp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>chgrp</refname>
<refpurpose>Changes file group</refpurpose>
@ -11,7 +11,7 @@
<methodsynopsis>
<type>bool</type><methodname>chgrp</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>mixed</type><parameter>group</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>int</type></type><parameter>group</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to change the group of the file <parameter>filename</parameter>
@ -96,7 +96,6 @@ printf($format, $filename, date('r'), filegroup($filename));
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/filesystem/functions/chmod.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.chmod">
<refentry xml:id="function.chmod" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>chmod</refname>
<refpurpose>Changes file mode</refpurpose>
@ -11,11 +11,11 @@
<methodsynopsis>
<type>bool</type><methodname>chmod</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam><type>int</type><parameter>permissions</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to change the mode of the specified file to that given in
<parameter>mode</parameter>.
<parameter>permissions</parameter>.
</para>
</refsect1>
@ -32,12 +32,12 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<term><parameter>permissions</parameter></term>
<listitem>
<para>
Note that <parameter>mode</parameter> is not automatically
Note that <parameter>permissions</parameter> is not automatically
assumed to be an octal value, so to ensure the expected operation,
you need to prefix <parameter>mode</parameter> with a zero (0).
you need to prefix <parameter>permissions</parameter> with a zero (0).
Strings such as "g+w" will not work properly.
</para>
<para>
@ -54,7 +54,7 @@ chmod("/somedir/somefile", 0755); // octal; correct value of mode
</informalexample>
</para>
<para>
The <parameter>mode</parameter> parameter consists of three octal
The <parameter>permissions</parameter> parameter consists of three octal
number components specifying access restrictions for the owner,
the user group in which the owner is in, and to everybody else in
this order. One component can be computed by adding up the needed
@ -124,7 +124,6 @@ chmod("/somedir/somefile", 0750);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/chown.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.chown">
<refentry xml:id="function.chown" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>chown</refname>
<refpurpose>Changes file owner</refpurpose>
@ -11,7 +11,7 @@
<methodsynopsis>
<type>bool</type><methodname>chown</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>mixed</type><parameter>user</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>int</type></type><parameter>user</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to change the owner of the file <parameter>filename</parameter>
@ -115,7 +115,6 @@ Array
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/clearstatcache.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.clearstatcache">
<refentry xml:id="function.clearstatcache" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>clearstatcache</refname>
<refpurpose>Clears file status cache</refpurpose>
@ -11,7 +11,7 @@
<methodsynopsis>
<type>void</type><methodname>clearstatcache</methodname>
<methodparam choice="opt"><type>bool</type><parameter>clear_realpath_cache</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
When you use <function>stat</function>, <function>lstat</function>, or
@ -136,7 +136,6 @@ UID @ Sun, 12 Oct 2008 20:48:28 +0100: ross
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/filesystem/functions/fclose.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fclose">
<refentry xml:id="function.fclose" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fclose</refname>
<refpurpose>Closes an open file pointer</refpurpose>
@ -10,10 +10,10 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fclose</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
</methodsynopsis>
<para>
The file pointed to by <parameter>handle</parameter> is closed.
The file pointed to by <parameter>stream</parameter> is closed.
</para>
</refsect1>
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The file pointer must be valid, and must point to a file successfully
@ -72,7 +72,6 @@ fclose($handle);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/filesystem/functions/feof.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.feof">
<refentry xml:id="function.feof" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>feof</refname>
<refpurpose>Tests for end-of-file on a file pointer</refpurpose>
@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>feof</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
</methodsynopsis>
<para>
Tests for end-of-file on a file pointer.
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
&fs.validfp.all;
</listitem>
@ -98,7 +98,6 @@ fclose($file);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/filesystem/functions/fflush.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fflush">
<refentry xml:id="function.fflush" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fflush</refname>
<refpurpose>Flushes the output to a file</refpurpose>
@ -10,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fflush</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
</methodsynopsis>
<para>
This function forces a write of all buffered output to the resource
pointed to by the file <parameter>handle</parameter>.
pointed to by the file <parameter>stream</parameter>.
</para>
</refsect1>
@ -23,7 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
&fs.validfp.all;
</listitem>
@ -73,7 +73,6 @@ fclose($file);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/filesystem/functions/fgetc.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fgetc">
<refentry xml:id="function.fgetc" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fgetc</refname>
<refpurpose>Gets character from file pointer</refpurpose>
@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fgetc</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<type class="union"><type>string</type><type>false</type></type><methodname>fgetc</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
</methodsynopsis>
<para>
Gets a character from the given file pointer.
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
&fs.validfp.all;
</listitem>
@ -35,7 +35,7 @@
&reftitle.returnvalues;
<para>
Returns a string containing a single character read from the file pointed
to by <parameter>handle</parameter>. Returns &false; on EOF.
to by <parameter>stream</parameter>. Returns &false; on EOF.
</para>
&return.falseproblem;
</refsect1>
@ -81,7 +81,6 @@ while (false !== ($char = fgetc($fp))) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/filegroup.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.filegroup">
<refentry xml:id="function.filegroup" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>filegroup</refname>
<refpurpose>Gets file group</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>filegroup</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>filegroup</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
@ -85,7 +85,6 @@ print_r(posix_getgrgid(filegroup($filename)));
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

8
reference/filesystem/functions/fileperms.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fileperms">
<refentry xml:id="function.fileperms" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fileperms</refname>
<refpurpose>Gets file permissions</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fileperms</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>fileperms</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
@ -51,6 +51,9 @@
documentation is recommended if parsing the non-permission bits of the
return value is required.
</para>
<para>
Returns &false; on failure.
</para>
</refsect1>
<refsect1 role="examples">
@ -165,7 +168,6 @@ echo $info;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/filesize.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.filesize">
<refentry xml:id="function.filesize" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>filesize</refname>
<refpurpose>Gets file size</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>filesize</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>filesize</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
@ -84,7 +84,6 @@ echo $filename . ': ' . filesize($filename) . ' bytes';
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/filetype.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.filetype">
<refentry xml:id="function.filetype" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>filetype</refname>
<refpurpose>Gets file type</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>filetype</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>filetype</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
@ -92,7 +92,6 @@ echo filetype('/etc/'); // dir
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

13
reference/filesystem/functions/flock.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.flock">
<refentry xml:id="function.flock" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>flock</refname>
<refpurpose>Portable advisory file locking</refpurpose>
@ -10,9 +10,9 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>flock</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>int</type><parameter>operation</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">wouldblock</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">would_block</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>flock</function> allows you to perform a simple reader/writer
@ -37,7 +37,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
&fs.file.pointer;
</listitem>
@ -73,7 +73,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wouldblock</parameter></term>
<term><parameter>would_block</parameter></term>
<listitem>
<para>
The optional third argument is set to 1 if the lock would block
@ -172,7 +172,7 @@ fclose($fp);
</note>
<warning>
<para>
Assigning another value to <parameter>handle</parameter> argument in
Assigning another value to <parameter>stream</parameter> argument in
subsequent code will release the lock.
</para>
</warning>
@ -193,7 +193,6 @@ fclose($fp);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/filesystem/functions/fnmatch.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fnmatch">
<refentry xml:id="function.fnmatch" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fnmatch</refname>
<refpurpose>Match filename against a pattern</refpurpose>
@ -11,11 +11,11 @@
<methodsynopsis>
<type>bool</type><methodname>fnmatch</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>fnmatch</function> checks if the passed <parameter>string</parameter> would
<function>fnmatch</function> checks if the passed <parameter>filename</parameter> would
match the given shell wildcard <parameter>pattern</parameter>.
</para>
</refsect1>
@ -33,7 +33,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The tested string. This function is especially useful for filenames,
@ -151,7 +151,6 @@ if (fnmatch("*gr[ae]y", $color)) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/filesystem/functions/fpassthru.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fpassthru">
<refentry xml:id="function.fpassthru" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fpassthru</refname>
<refpurpose>Output all remaining data on a file pointer</refpurpose>
@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fpassthru</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
</methodsynopsis>
<para>
Reads to EOF on the given file pointer from the current position and
@ -34,7 +34,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
&fs.validfp.all;
</listitem>
@ -48,7 +48,7 @@
<para>
If an error occurs, <function>fpassthru</function> returns
&false;. Otherwise, <function>fpassthru</function> returns
the number of characters read from <parameter>handle</parameter>
the number of characters read from <parameter>stream</parameter>
and passed through to the output.
</para>
</refsect1>
@ -111,7 +111,6 @@ exit;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/filesystem/functions/fread.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fread">
<refentry xml:id="function.fread" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fread</refname>
<refpurpose>Binary-safe file read</refpurpose>
@ -10,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>fread</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
<function>fread</function> reads up to
<parameter>length</parameter> bytes from the file pointer
referenced by <parameter>handle</parameter>. Reading stops as soon as one
referenced by <parameter>stream</parameter>. Reading stops as soon as one
of the following conditions is met:
<itemizedlist>
<listitem>
@ -52,7 +52,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
&fs.file.pointer;
</listitem>
@ -199,7 +199,6 @@ fclose($handle);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/filesystem/functions/fscanf.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fscanf">
<refentry xml:id="function.fscanf" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fscanf</refname>
<refpurpose>Parses input from a file according to a format</refpurpose>
@ -9,15 +9,15 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>fscanf</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<type class="union"><type>array</type><type>int</type><type>false</type><type>null</type></type><methodname>fscanf</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam rep="repeat"><type>mixed</type><parameter role="reference">vars</parameter></methodparam>
</methodsynopsis>
<para>
The function <function>fscanf</function> is similar to
<function>sscanf</function>, but it takes its input from a file
associated with <parameter>handle</parameter> and interprets the
associated with <parameter>stream</parameter> and interprets the
input according to the specified <parameter>format</parameter>, which is
described in the documentation for <function>sprintf</function>.
</para>
@ -36,7 +36,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
&fs.file.pointer;
</listitem>
@ -62,6 +62,11 @@
function will return the number of assigned values. The optional
parameters must be passed by reference.
</para>
<para>
If there are more substrings expected in the <parameter>format</parameter>
than there are available within <parameter>string</parameter>,
&null; will be returned. On other errors, &false; will be returned.
</para>
</refsect1>
<refsect1 role="examples">
@ -113,7 +118,6 @@ luigi florist it
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/filesystem/functions/fseek.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fseek">
<refentry xml:id="function.fseek" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fseek</refname>
<refpurpose>Seeks on a file pointer</refpurpose>
@ -10,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fseek</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter><initializer>SEEK_SET</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter><initializer><constant>SEEK_SET</constant></initializer></methodparam>
</methodsynopsis>
<para>
Sets the file position indicator for the file referenced by
<parameter>handle</parameter>. The new position, measured in bytes
<parameter>stream</parameter>. The new position, measured in bytes
from the beginning of the file, is obtained by adding
<parameter>offset</parameter> to the position specified by
<parameter>whence</parameter>.
@ -35,7 +35,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
&fs.file.pointer;
</listitem>
@ -133,7 +133,6 @@ fseek($fp, 0);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/filesystem/functions/fstat.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fstat">
<refentry xml:id="function.fstat" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fstat</refname>
<refpurpose>Gets information about a file using an open file pointer</refpurpose>
@ -9,12 +9,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>fstat</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>fstat</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
</methodsynopsis>
<para>
Gathers the statistics of the file opened by the file
pointer <parameter>handle</parameter>. This function is similar to the
pointer <parameter>stream</parameter>. This function is similar to the
<function>stat</function> function except that it operates
on an open file pointer instead of a filename.
</para>
@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
&fs.file.pointer;
</listitem>
@ -39,6 +39,7 @@
<para>
Returns an array with the statistics of the file; the format of the array
is described in detail on the <function>stat</function> manual page.
Returns &false; on failure.
</para>
</refsect1>
@ -97,7 +98,6 @@ Array
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

13
reference/filesystem/functions/ftell.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ftell">
<refentry xml:id="function.ftell" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ftell</refname>
<refpurpose>Returns the current position of the file read/write pointer</refpurpose>
@ -9,11 +9,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ftell</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<type class="union"><type>int</type><type>false</type></type><methodname>ftell</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
</methodsynopsis>
<para>
Returns the position of the file pointer referenced by <parameter>handle</parameter>.
Returns the position of the file pointer referenced by <parameter>stream</parameter>.
</para>
</refsect1>
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The file pointer must be valid, and must point to a file successfully
@ -40,7 +40,7 @@
&reftitle.returnvalues;
<para>
Returns the position of the file pointer referenced by
<parameter>handle</parameter> as an integer; i.e., its offset into the file stream.
<parameter>stream</parameter> as an integer; i.e., its offset into the file stream.
</para>
<para>
If an error occurs, returns &false;.
@ -86,7 +86,6 @@ fclose($fp);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/filesystem/functions/ftruncate.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.14 -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ftruncate">
<refentry xml:id="function.ftruncate" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ftruncate</refname>
<refpurpose>Truncates a file to a given length</refpurpose>
@ -11,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ftruncate</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
Takes the filepointer, <parameter>handle</parameter>, and truncates the file to
Takes the filepointer, <parameter>stream</parameter>, and truncates the file to
length, <parameter>size</parameter>.
</para>
</refsect1>
@ -25,14 +25,14 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The file pointer.
</para>
<note>
<para>
The <parameter>handle</parameter> must be open for writing.
The <parameter>stream</parameter> must be open for writing.
</para>
</note>
</listitem>
@ -107,7 +107,6 @@ fclose($handle);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/glob.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.glob">
<refentry xml:id="function.glob" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>glob</refname>
<refpurpose>Find pathnames matching a pattern</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>glob</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>glob</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
@ -189,7 +189,6 @@ quickref.txt size 137820
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/lchgrp.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.lchgrp">
<refentry xml:id="function.lchgrp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>lchgrp</refname>
<refpurpose>Changes group ownership of symlink</refpurpose>
@ -11,7 +11,7 @@
<methodsynopsis>
<type>bool</type><methodname>lchgrp</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>mixed</type><parameter>group</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>int</type></type><parameter>group</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to change the group of the symlink <parameter>filename</parameter>
@ -94,7 +94,6 @@ lchgrp($link, 8);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/lchown.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.lchown">
<refentry xml:id="function.lchown" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>lchown</refname>
<refpurpose>Changes user ownership of symlink</refpurpose>
@ -11,7 +11,7 @@
<methodsynopsis>
<type>bool</type><methodname>lchown</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>mixed</type><parameter>user</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>int</type></type><parameter>user</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to change the owner of the symlink <parameter>filename</parameter>
@ -92,7 +92,6 @@ lchown($link, 8);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/linkinfo.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.linkinfo">
<refentry xml:id="function.linkinfo" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>linkinfo</refname>
<refpurpose>Gets information about a link</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>linkinfo</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>linkinfo</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
@ -78,7 +78,6 @@ echo linkinfo('/vmlinuz'); // 835
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

8
reference/filesystem/functions/lstat.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.lstat">
<refentry xml:id="function.lstat" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>lstat</refname>
<refpurpose>Gives information about a file or symbolic link</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>lstat</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>lstat</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
@ -44,6 +44,9 @@
link, the status of the symbolic link is returned, not the status of the
file pointed to by the symbolic link.
</para>
<para>
On failure, &false; is returned.
</para>
</refsect1>
<refsect1 role="examples">
@ -104,7 +107,6 @@ Array
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

23
reference/filesystem/functions/move-uploaded-file.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.move-uploaded-file">
<refentry xml:id="function.move-uploaded-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>move_uploaded_file</refname>
<refpurpose>Moves an uploaded file to a new location</refpurpose>
@ -10,15 +10,15 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>move_uploaded_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>destination</parameter></methodparam>
<methodparam><type>string</type><parameter>from</parameter></methodparam>
<methodparam><type>string</type><parameter>to</parameter></methodparam>
</methodsynopsis>
<para>
This function checks to ensure that the file designated by
<parameter>filename</parameter> is a valid upload file (meaning
<parameter>from</parameter> is a valid upload file (meaning
that it was uploaded via PHP's HTTP POST upload mechanism). If
the file is valid, it will be moved to the filename given by
<parameter>destination</parameter>.
<parameter>to</parameter>.
</para>
<para>
This sort of check is especially important if there is any chance
@ -33,7 +33,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<term><parameter>from</parameter></term>
<listitem>
<para>
The filename of the uploaded file.
@ -41,7 +41,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>destination</parameter></term>
<term><parameter>to</parameter></term>
<listitem>
<para>
The destination of the moved file.
@ -58,13 +58,13 @@
Returns &true; on success.
</para>
<para>
If <parameter>filename</parameter> is not a valid upload file,
If <parameter>from</parameter> is not a valid upload file,
then no action will occur, and
<function>move_uploaded_file</function> will return
&false;.
</para>
<para>
If <parameter>filename</parameter> is a valid upload file, but
If <parameter>from</parameter> is a valid upload file, but
cannot be moved for some reason, no action will occur, and
<function>move_uploaded_file</function> will return
&false;. Additionally, a warning will be issued.
@ -103,8 +103,8 @@ foreach ($_FILES["pictures"]["error"] as $key => $error) {
<function>move_uploaded_file</function> is
<link linkend="ini.open-basedir">open_basedir</link>
aware. However, restrictions are placed only on the
<parameter>destination</parameter> path as to allow the moving
of uploaded files in which <parameter>filename</parameter> may conflict
<parameter>to</parameter> path as to allow the moving
of uploaded files in which <parameter>from</parameter> may conflict
with such restrictions. <function>move_uploaded_file</function> ensures
the safety of this operation by allowing only those files uploaded
through PHP to be moved.
@ -128,7 +128,6 @@ foreach ($_FILES["pictures"]["error"] as $key => $error) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/filesystem/functions/parse-ini-file.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.parse-ini-file">
<refentry xml:id="function.parse-ini-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>parse_ini_file</refname>
<refpurpose>Parse a configuration file</refpurpose>
@ -9,10 +9,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>parse_ini_file</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>parse_ini_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>process_sections</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scanner_mode</parameter><initializer>INI_SCANNER_NORMAL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scanner_mode</parameter><initializer><constant>INI_SCANNER_NORMAL</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>parse_ini_file</function> loads in the
@ -329,7 +329,6 @@ also_five = ${five}
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

13
reference/filesystem/functions/parse-ini-string.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.parse-ini-string">
<refentry xml:id="function.parse-ini-string" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>parse_ini_string</refname>
<refpurpose>Parse a configuration string</refpurpose>
@ -9,14 +9,14 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>parse_ini_string</methodname>
<methodparam><type>string</type><parameter>ini</parameter></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>parse_ini_string</methodname>
<methodparam><type>string</type><parameter>ini_string</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>process_sections</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scanner_mode</parameter><initializer>INI_SCANNER_NORMAL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scanner_mode</parameter><initializer><constant>INI_SCANNER_NORMAL</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>parse_ini_string</function> returns the settings in string
<parameter>ini</parameter> in an associative array.
<parameter>ini_string</parameter> in an associative array.
</para>
<para>
The structure of the ini string is the same as the &php.ini;'s.
@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>ini</parameter></term>
<term><parameter>ini_string</parameter></term>
<listitem>
<para>
The contents of the ini file being parsed.
@ -97,7 +97,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

17
reference/filesystem/functions/pathinfo.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.pathinfo">
<refentry xml:id="function.pathinfo" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pathinfo</refname>
<refpurpose>Returns information about a file path</refpurpose>
@ -9,14 +9,14 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>pathinfo</methodname>
<type class="union"><type>array</type><type>string</type></type><methodname>pathinfo</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>PATHINFO_DIRNAME | PATHINFO_BASENAME | PATHINFO_EXTENSION | PATHINFO_FILENAME</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PATHINFO_ALL</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>pathinfo</function> returns information about
<parameter>path</parameter>: either an associative array or a string,
depending on <parameter>options</parameter>.
depending on <parameter>flags</parameter>.
</para>
<note>
<para>
@ -47,7 +47,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<term><parameter>flags</parameter></term>
<listitem>
<para>
If present, specifies a specific element to be returned; one of
@ -56,7 +56,7 @@
<constant>PATHINFO_EXTENSION</constant> or
<constant>PATHINFO_FILENAME</constant>.
</para>
<para>If <parameter>options</parameter> is not specified, returns all
<para>If <parameter>flags</parameter> is not specified, returns all
available elements.
</para>
</listitem>
@ -68,7 +68,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If the <parameter>options</parameter> parameter is not passed, an
If the <parameter>flags</parameter> parameter is not passed, an
associative <type>array</type> containing the following elements is
returned:
<literal>dirname</literal>, <literal>basename</literal>,
@ -98,7 +98,7 @@
</para>
</note>
<para>
If <parameter>options</parameter> is present, returns a
If <parameter>flags</parameter> is present, returns a
<type>string</type> containing the requested element.
</para>
</refsect1>
@ -195,7 +195,6 @@ Array
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/popen.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.popen">
<refentry xml:id="function.popen" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>popen</refname>
<refpurpose>Opens process file pointer</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>popen</methodname>
<type class="union"><type>resource</type><type>false</type></type><methodname>popen</methodname>
<methodparam><type>string</type><parameter>command</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
@ -128,7 +128,6 @@ pclose($handle);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/readlink.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readlink">
<refentry xml:id="function.readlink" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>readlink</refname>
<refpurpose>Returns the target of a symbolic link</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>readlink</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>readlink</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
@ -77,7 +77,6 @@ echo readlink('/vmlinuz');
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/realpath.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.realpath">
<refentry xml:id="function.realpath" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>realpath</refname>
<refpurpose>Returns canonicalized absolute pathname</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>realpath</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>realpath</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
@ -142,7 +142,6 @@ C:\Program Files
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/filesystem/functions/rewind.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.rewind">
<refentry xml:id="function.rewind" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>rewind</refname>
<refpurpose>Rewind the position of a file pointer</refpurpose>
@ -10,10 +10,10 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>rewind</methodname>
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
</methodsynopsis>
<para>
Sets the file position indicator for <parameter>handle</parameter>
Sets the file position indicator for <parameter>stream</parameter>
to the beginning of the file stream.
</para>
<note>
@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>handle</parameter></term>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The file pointer must be valid, and must point to a file
@ -92,7 +92,6 @@ Foolly long sentence.
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/filesystem/functions/stat.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.stat">
<refentry xml:id="function.stat" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stat</refname>
<refpurpose>Gives information about a file</refpurpose>
@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>stat</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>stat</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
@ -313,7 +313,6 @@ if (!$stat) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

13
reference/filesystem/functions/tempnam.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.tempnam">
<refentry xml:id="function.tempnam" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tempnam</refname>
<refpurpose>Create file with unique file name</refpurpose>
@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>tempnam</methodname>
<methodparam><type>string</type><parameter>dir</parameter></methodparam>
<type class="union"><type>string</type><type>false</type></type><methodname>tempnam</methodname>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
</methodsynopsis>
<para>
@ -26,7 +26,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dir</parameter></term>
<term><parameter>directory</parameter></term>
<listitem>
<para>
The directory where the temporary filename will be created.
@ -87,9 +87,9 @@ unlink($tmpfname);
&reftitle.notes;
<note>
<simpara>
If PHP cannot create a file in the specified <parameter>dir</parameter>
If PHP cannot create a file in the specified <parameter>directory</parameter>
parameter, it falls back on the system default. On NTFS this also happens
if the specified <parameter>dir</parameter> contains more than 65534 files.
if the specified <parameter>directory</parameter> contains more than 65534 files.
</simpara>
</note>
</refsect1>
@ -106,7 +106,6 @@ unlink($tmpfname);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/funchand/functions/call-user-func-array.xml
View file

@ -11,11 +11,11 @@
<methodsynopsis>
<type>mixed</type><methodname>call_user_func_array</methodname>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam><type>array</type><parameter>param_arr</parameter></methodparam>
<methodparam><type>array</type><parameter>args</parameter></methodparam>
</methodsynopsis>
<para>
Calls the <parameter>callback</parameter> given by the first parameter with
the parameters in <parameter>param_arr</parameter>.
the parameters in <parameter>args</parameter>.
</para>
</refsect1>
@ -32,7 +32,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>param_arr</parameter></term>
<term><parameter>args</parameter></term>
<listitem>
<para>
The parameters to be passed to the callback, as an indexed array.
@ -170,7 +170,7 @@ global $bar=55
&reftitle.notes;
<note>
<para>
Before PHP 5.4, referenced variables in <parameter>param_arr</parameter>
Before PHP 5.4, referenced variables in <parameter>args</parameter>
are passed to the function by reference, regardless of whether the function
expects the respective parameter to be passed by reference. This form of
call-time pass by reference does not emit a deprecation notice, but it is
@ -201,7 +201,6 @@ global $bar=55
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/funchand/functions/forward-static-call-array.xml
View file

@ -10,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>forward_static_call_array</methodname>
<methodparam><type>callable</type><parameter>function</parameter></methodparam>
<methodparam><type>array</type><parameter>parameters</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam><type>array</type><parameter>args</parameter></methodparam>
</methodsynopsis>
<para>
Calls a user defined function or method given by the <parameter>function</parameter>
Calls a user defined function or method given by the <parameter>callback</parameter>
parameter. This function must be called within a method context, it can't be
used outside a class.
It uses the <link linkend="language.oop5.late-static-bindings">late static
@ -29,7 +29,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
The function or method to be called. This parameter may be an &array;,
@ -127,7 +127,6 @@ C other,args
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/funchand/functions/forward-static-call.xml
View file

@ -10,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>forward_static_call</methodname>
<methodparam><type>callable</type><parameter>function</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam rep="repeat"><type>mixed</type><parameter>args</parameter></methodparam>
</methodsynopsis>
<para>
Calls a user defined function or method given by the <parameter>function</parameter>
Calls a user defined function or method given by the <parameter>callback</parameter>
parameter, with the following arguments. This function must be called within a method
context, it can't be used outside a class.
It uses the <link linkend="language.oop5.late-static-bindings">late static
@ -27,7 +27,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
The function or method to be called. This parameter may be an array,
@ -119,7 +119,6 @@ C other,args
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/funchand/functions/register-tick-function.xml
View file

@ -10,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>register_tick_function</methodname>
<methodparam><type>callable</type><parameter>function</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam rep="repeat"><type>mixed</type><parameter>args</parameter></methodparam>
</methodsynopsis>
<simpara>
Registers the given <parameter>function</parameter> to be executed when a
Registers the given <parameter>callback</parameter> to be executed when a
<link linkend="control-structures.declare.ticks">tick</link> is called.
</simpara>
</refsect1>
@ -24,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
The function to register.
@ -93,7 +93,6 @@ register_tick_function(array(&$object, 'my_method'), true);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/funchand/functions/unregister-tick-function.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>unregister_tick_function</methodname>
<methodparam><type>callable</type><parameter>function</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<simpara>
De-registers the function <parameter>function</parameter> so it is
@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
The function to de-register.
@ -53,7 +53,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/image/functions/getimagesize.xml
View file

@ -8,9 +8,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>getimagesize</methodname>
<type class="union"><type>array</type><type>false</type></type><methodname>getimagesize</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">imageinfo</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">image_info</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
The <function>getimagesize</function> function will determine the
@ -21,7 +21,7 @@
</para>
<para>
<function>getimagesize</function> can also return some more information
in <parameter>imageinfo</parameter> parameter.
in <parameter>image_info</parameter> parameter.
</para>
<caution>
<para>
@ -76,7 +76,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>imageinfo</parameter></term>
<term><parameter>image_info</parameter></term>
<listitem>
<para>
This optional parameter allows you to extract some extended
@ -90,7 +90,7 @@
</para>
<note>
<para>
The <parameter>imageinfo</parameter> only supports
The <parameter>image_info</parameter> only supports
<acronym>JFIF</acronym> files.
</para>
</note>
@ -265,7 +265,6 @@ if (isset($info["APP13"])) {
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -286,4 +285,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

14
reference/image/functions/getimagesizefromstring.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- $Revision$ -->
<refentry xml:id="function.getimagesizefromstring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>getimagesizefromstring</refname>
@ -10,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>getimagesizefromstring</methodname>
<methodparam><type>string</type><parameter>imagedata</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">imageinfo</parameter></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>getimagesizefromstring</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">image_info</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Identical to <function>getimagesize</function> except that <function>getimagesizefromstring</function>
@ -28,7 +27,7 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>imagedata</parameter></term>
<term><parameter>string</parameter></term>
<listitem>
<para>
The image data, as a string.
@ -36,7 +35,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>imageinfo</parameter></term>
<term><parameter>image_info</parameter></term>
<listitem>
<para>
See <function>getimagesize</function>.
@ -84,7 +83,6 @@ $size_info2 = getimagesizefromstring($data);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

9
reference/image/functions/image-type-to-extension.xml
View file

@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>image_type_to_extension</methodname>
<methodparam><type>int</type><parameter>imagetype</parameter></methodparam>
<type class="union"><type>string</type><type>false</type></type><methodname>image_type_to_extension</methodname>
<methodparam><type>int</type><parameter>image_type</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>include_dot</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>imagetype</parameter></term>
<term><parameter>image_type</parameter></term>
<listitem>
<para>
One of the <literal>IMAGETYPE_XXX</literal> constant.
@ -44,7 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A string with the extension corresponding to the given image type.
A string with the extension corresponding to the given image type, &return.falseforfailure;.
</para>
</refsect1>
@ -75,7 +75,6 @@ imagedestroy($im);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/image/functions/image-type-to-mime-type.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>image_type_to_mime_type</methodname>
<methodparam><type>int</type><parameter>imagetype</parameter></methodparam>
<methodparam><type>int</type><parameter>image_type</parameter></methodparam>
</methodsynopsis>
<para>
The <function>image_type_to_mime_type</function> function will determine
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>imagetype</parameter></term>
<term><parameter>image_type</parameter></term>
<listitem>
<para>
One of the <literal>IMAGETYPE_XXX</literal> constants.
@ -42,7 +42,7 @@
<tgroup cols="2">
<thead>
<row>
<entry><parameter>imagetype</parameter></entry>
<entry><parameter>image_type</parameter></entry>
<entry>Returned value</entry>
</row>
</thead>
@ -157,7 +157,6 @@ header("Content-type: " . image_type_to_mime_type(IMAGETYPE_PNG));
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

13
reference/image/functions/iptcembed.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.iptcembed' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="function.iptcembed" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>iptcembed</refname>
<refpurpose>Embeds binary IPTC data into a JPEG image</refpurpose>
@ -8,9 +8,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>iptcembed</methodname>
<methodparam><type>string</type><parameter>iptcdata</parameter></methodparam>
<methodparam><type>string</type><parameter>jpeg_file_name</parameter></methodparam>
<type class="union"><type>string</type><type>bool</type></type><methodname>iptcembed</methodname>
<methodparam><type>string</type><parameter>iptc_data</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>spool</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>iptcdata</parameter></term>
<term><parameter>iptc_data</parameter></term>
<listitem>
<para>
The data to be written.
@ -30,7 +30,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>jpeg_file_name</parameter></term>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Path to the JPEG image.
@ -125,7 +125,6 @@ fclose($fp);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/image/functions/iptcparse.xml
View file

@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>iptcparse</methodname>
<methodparam><type>string</type><parameter>iptcblock</parameter></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>iptcparse</methodname>
<methodparam><type>string</type><parameter>iptc_block</parameter></methodparam>
</methodsynopsis>
<para>
Parses an <link xlink:href="&url.iptc;">IPTC</link> block into its single tags.
@ -20,7 +20,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>iptcblock</parameter></term>
<term><parameter>iptc_block</parameter></term>
<listitem>
<para>
A binary IPTC block.
@ -64,7 +64,6 @@ if(isset($info['APP13']))
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/info/functions/dl.xml
View file

@ -10,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>dl</methodname>
<methodparam><type>string</type><parameter>library</parameter></methodparam>
<methodparam><type>string</type><parameter>extension_filename</parameter></methodparam>
</methodsynopsis>
<para>
Loads the PHP extension given by the parameter
<parameter>library</parameter>.
<parameter>extension_filename</parameter>.
</para>
<para>
Use <function>extension_loaded</function> to test whether a given
@ -35,7 +35,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>library</parameter></term>
<term><parameter>extension_filename</parameter></term>
<listitem>
<para>
This parameter is <emphasis>only</emphasis> the filename of the
@ -160,7 +160,6 @@ if (!extension_loaded('sqlite')) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/info/functions/get-cfg-var.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>get_cfg_var</methodname>
<type class="union"><type>string</type><type>array</type><type>false</type></type><methodname>get_cfg_var</methodname>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>
@ -62,7 +62,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/info/functions/get-include-path.xml
View file

@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>get_include_path</methodname>
<void />
<type class="union"><type>string</type><type>false</type></type><methodname>get_include_path</methodname>
<void/>
</methodsynopsis>
<simpara>
Gets the current <link linkend="ini.include-path">include_path</link>
@ -21,7 +21,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the path, as a string.
Returns the path, as a string, &return.falseforfailure;.
</para>
</refsect1>
@ -57,7 +57,6 @@ echo ini_get('include_path');
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/info/functions/getlastmod.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>getlastmod</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>getlastmod</methodname>
<void/>
</methodsynopsis>
<para>
@ -63,7 +63,6 @@ echo "Last modified: " . date ("F d Y H:i:s.", getlastmod());
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/info/functions/getmygid.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>getmygid</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>getmygid</methodname>
<void/>
</methodsynopsis>
<simpara>
@ -38,7 +38,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/info/functions/getmyinode.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>getmyinode</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>getmyinode</methodname>
<void/>
</methodsynopsis>
<para>
@ -38,7 +38,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/info/functions/getmypid.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>getmypid</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>getmypid</methodname>
<void/>
</methodsynopsis>
<para>
@ -49,7 +49,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/info/functions/getmyuid.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>getmyuid</methodname>
<type class="union"><type>int</type><type>false</type></type><methodname>getmyuid</methodname>
<void/>
</methodsynopsis>
<simpara>
@ -38,7 +38,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

31
reference/info/functions/getopt.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.getopt">
<refentry xml:id="function.getopt" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>getopt</refname>
<refpurpose>Gets options from the command line argument list</refpurpose>
@ -10,9 +10,9 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>getopt</methodname>
<methodparam><type>string</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>longopts</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">optind</parameter></methodparam>
<methodparam><type>string</type><parameter>short_options</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>long_options</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">rest_index</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Parses options passed to the script.
@ -24,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>options</parameter></term>
<term><parameter>short_options</parameter></term>
<listitem>
<simpara>
Each character in this string will be used as option characters and
@ -41,7 +41,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>longopts</parameter></term>
<term><parameter>long_options</parameter></term>
<listitem>
<simpara>
An array of options. Each element in this array will be used as option
@ -55,10 +55,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>optind</parameter></term>
<term><parameter>rest_index</parameter></term>
<listitem>
<simpara>
If the <parameter>optind</parameter> parameter is present, then the
If the <parameter>rest_index</parameter> parameter is present, then the
index where argument parsing stopped will be written to this variable.
</simpara>
</listitem>
@ -66,7 +66,7 @@
</variablelist>
</para>
<para>
The <parameter>options</parameter> parameter may contain the following
The <parameter>short_options</parameter> parameter may contain the following
elements:
<simplelist>
<member>Individual characters (do not accept values)</member>
@ -83,10 +83,10 @@
</para>
<note>
<para>
The format for the <parameter>options</parameter> and
<parameter>longopts</parameter> is almost the same, the only difference is
that <parameter>longopts</parameter> takes an array of options (where each
element is the option) whereas <parameter>options</parameter> takes a
The format for the <parameter>short_options</parameter> and
<parameter>long_options</parameter> is almost the same, the only difference is
that <parameter>long_options</parameter> takes an array of options (where each
element is the option) whereas <parameter>short_options</parameter> takes a
string (where each character is the option).
</para>
</note>
@ -120,7 +120,7 @@
<row>
<entry>7.1.0</entry>
<entry>
Added the <parameter>optind</parameter> parameter.
Added the <parameter>rest_index</parameter> parameter.
</entry>
</row>
</tbody>
@ -249,7 +249,7 @@ array(2) {
</para>
<para>
<example xml:id="getopt.examples-4">
<title><function>getopt</function> example: Using <parameter>optind</parameter></title>
<title><function>getopt</function> example: Using <parameter>rest_index</parameter></title>
<programlisting role="php">
<![CDATA[
<?php
@ -288,7 +288,6 @@ array(1) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

16
reference/info/functions/getrusage.xml
View file

@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>getrusage</methodname>
<methodparam choice="opt"><type>int</type><parameter>who</parameter><initializer>0</initializer></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>getrusage</methodname>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This is an interface to <command>getrusage(2)</command>. It gets data returned
@ -23,10 +23,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>who</parameter></term>
<term><parameter>mode</parameter></term>
<listitem>
<para>
If <parameter>who</parameter> is 1, getrusage will be called with
If <parameter>mode</parameter> is 1, getrusage will be called with
<constant>RUSAGE_CHILDREN</constant>.
</para>
</listitem>
@ -40,6 +40,7 @@
<para>
Returns an associative array containing the data returned from the system
call. All entries are accessible by using their documented field names.
Returns &false; on failure.
</para>
</refsect1>
@ -113,17 +114,17 @@ echo $dat["ru_stime.tv_usec"]; // system time used (microseconds)
<member><literal>"ru_utime.tv_sec"</literal></member>
<member><literal>"ru_utime.tv_usec"</literal></member>
<member>
<literal>"ru_majflt"</literal> (only if <parameter>who</parameter> is
<literal>"ru_majflt"</literal> (only if <parameter>mode</parameter> is
<constant>RUSAGE_SELF</constant>)
</member>
<member>
<literal>"ru_maxrss"</literal> (only if <parameter>who</parameter> is
<literal>"ru_maxrss"</literal> (only if <parameter>mode</parameter> is
<constant>RUSAGE_SELF</constant>)
</member>
</simplelist>
</para>
<para>
If <function>getrusage</function> is called with <parameter>who</parameter>
If <function>getrusage</function> is called with <parameter>mode</parameter>
set to <literal>1</literal> (<constant>RUSAGE_CHILDREN</constant>), then
resource usage for threads are collected (meaning that internally the function
is called with <constant>RUSAGE_THREAD</constant>).
@ -154,7 +155,6 @@ echo $dat["ru_stime.tv_usec"]; // system time used (microseconds)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/info/functions/ini-get.xml
View file

@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ini_get</methodname>
<methodparam><type>string</type><parameter>varname</parameter></methodparam>
<type class="union"><type>string</type><type>false</type></type><methodname>ini_get</methodname>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>
Returns the value of the configuration option on success.
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>varname</parameter></term>
<term><parameter>option</parameter></term>
<listitem>
<para>
The configuration option name.
@ -145,7 +145,6 @@ post_max_size in bytes = 8388608
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/info/functions/ini-restore.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>ini_restore</methodname>
<methodparam><type>string</type><parameter>varname</parameter></methodparam>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>
Restores a given configuration option to its original value.
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>varname</parameter></term>
<term><parameter>option</parameter></term>
<listitem>
<para>
The configuration option name.
@ -84,7 +84,6 @@ Original value for 'y2k_compliance': 1
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/info/functions/ini-set.xml
View file

@ -9,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ini_set</methodname>
<methodparam><type>string</type><parameter>varname</parameter></methodparam>
<methodparam><type>string</type><parameter>newvalue</parameter></methodparam>
<type class="union"><type>string</type><type>false</type></type><methodname>ini_set</methodname>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Sets the value of the given configuration option. The configuration option
@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>varname</parameter></term>
<term><parameter>option</parameter></term>
<listitem>
<para>
</para>
@ -37,7 +37,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newvalue</parameter></term>
<term><parameter>value</parameter></term>
<listitem>
<para>
The new value for the option.
@ -93,7 +93,6 @@ echo ini_get('display_errors');
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

4
reference/info/functions/php-ini-loaded-file.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.php-ini-loaded-file" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>php_ini_loaded_file</refname>
@ -10,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>php_ini_loaded_file</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>php_ini_loaded_file</methodname>
<void/>
</methodsynopsis>
<para>
@ -70,7 +69,6 @@ Loaded php.ini: /usr/local/php/php.ini
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

3
reference/info/functions/php-ini-scanned-files.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>php_ini_scanned_files</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>php_ini_scanned_files</methodname>
<void/>
</methodsynopsis>
<para>
@ -75,7 +75,6 @@ if ($filelist = php_ini_scanned_files()) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/info/functions/php-sapi-name.xml
View file

@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>php_sapi_name</methodname>
<type class="union"><type>string</type><type>false</type></type><methodname>php_sapi_name</methodname>
<void/>
</methodsynopsis>
<simpara>
@ -24,7 +24,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the interface type, as a lowercase string.
Returns the interface type, as a lowercase string, &return.falseforfailure;.
</para>
<para>
Although not exhaustive, the possible return values include
@ -92,7 +92,6 @@ if (substr($sapi_type, 0, 3) == 'cgi') {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/info/functions/phpcredits.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>phpcredits</methodname>
<methodparam choice="opt"><type>int</type><parameter>flag</parameter><initializer>CREDITS_ALL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>CREDITS_ALL</constant></initializer></methodparam>
</methodsynopsis>
<para>
This function prints out the credits listing the PHP developers,
@ -24,11 +24,11 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>flag</parameter></term>
<term><parameter>flags</parameter></term>
<listitem>
<para>
To generate a custom credits page, you may want to use the
<parameter>flag</parameter> parameter.
<parameter>flags</parameter> parameter.
</para>
<para>
<table>
@ -174,7 +174,6 @@ phpcredits(CREDITS_ALL - CREDITS_FULLPAGE);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/info/functions/phpinfo.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>phpinfo</methodname>
<methodparam choice="opt"><type>int</type><parameter>what</parameter><initializer>INFO_ALL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>INFO_ALL</constant></initializer></methodparam>
</methodsynopsis>
<para>
Outputs a large amount of information about the current state of PHP.
@ -37,12 +37,12 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>what</parameter></term>
<term><parameter>flags</parameter></term>
<listitem>
<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.
together in the optional <parameter>flags</parameter> parameter.
One can also combine the respective constants or bitwise values
together with the <link
linkend="language.operators.bitwise">bitwise or operator</link>.
@ -196,7 +196,6 @@ phpinfo(INFO_MODULES);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

7
reference/info/functions/putenv.xml
View file

@ -10,10 +10,10 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>putenv</methodname>
<methodparam><type>string</type><parameter>setting</parameter></methodparam>
<methodparam><type>string</type><parameter>assignment</parameter></methodparam>
</methodsynopsis>
<para>
Adds <parameter>setting</parameter> to the server environment. The
Adds <parameter>assignment</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.
@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>setting</parameter></term>
<term><parameter>assignment</parameter></term>
<listitem>
<para>
The setting, like <literal>"FOO=BAR"</literal>
@ -70,7 +70,6 @@ putenv("UNIQID=$uniqid");
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

5
reference/info/functions/set-include-path.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>set_include_path</methodname>
<methodparam><type>string</type><parameter>new_include_path</parameter></methodparam>
<methodparam><type>string</type><parameter>include_path</parameter></methodparam>
</methodsynopsis>
<para>
Sets the <link linkend="ini.include-path">include_path</link>
@ -23,7 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>new_include_path</parameter></term>
<term><parameter>include_path</parameter></term>
<listitem>
<para>
The new value for the <link
@ -96,7 +96,6 @@ set_include_path(get_include_path() . PATH_SEPARATOR . $path);
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

12
reference/mail/functions/mail.xml
View file

@ -13,8 +13,8 @@
<methodparam><type>string</type><parameter>to</parameter></methodparam>
<methodparam><type>string</type><parameter>subject</parameter></methodparam>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>additional_headers</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>additional_parameters</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type></type><parameter>additional_headers</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>additional_params</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Sends an email.
@ -134,10 +134,10 @@ $text = str_replace("\n.", "\n..", $text);
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>additional_parameters</parameter> (optional)</term>
<term><parameter>additional_params</parameter> (optional)</term>
<listitem>
<para>
The <parameter>additional_parameters</parameter> parameter
The <parameter>additional_params</parameter> parameter
can be used to pass additional flags as command line options to the
program configured to be used when sending mail, as defined by the
<literal>sendmail_path</literal> configuration setting. For example,
@ -276,7 +276,7 @@ mail($to, $subject, $message, $headers);
<example>
<title>Sending mail with an additional command line parameter.</title>
<para>
The <parameter>additional_parameters</parameter> parameter
The <parameter>additional_params</parameter> parameter
can be used to pass an additional parameter to the program configured
to use when sending mail using the <literal>sendmail_path</literal>.
</para>
@ -419,8 +419,6 @@ mail($to, $subject, $message, implode("\r\n", $headers));
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/math/functions/acos.xml
View file

@ -7,12 +7,12 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>acos</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>acos</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns the arc cosine of <parameter>arg</parameter> in radians.
Returns the arc cosine of <parameter>num</parameter> in radians.
<function>acos</function> is the inverse function of
<function>cos</function>, which means that
<literal>a==cos(acos(a))</literal> for every value of a that is within
@ -24,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
@ -37,7 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The arc cosine of <parameter>arg</parameter> in radians.
The arc cosine of <parameter>num</parameter> in radians.
</para>
</refsect1>
<refsect1 role="seealso">
@ -52,7 +52,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

17
reference/math/functions/acosh.xml
View file

@ -7,14 +7,14 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>acosh</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>acosh</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns the inverse hyperbolic cosine of
<parameter>arg</parameter>, i.e. the value whose
hyperbolic cosine is <parameter>arg</parameter>.
<parameter>num</parameter>, i.e. the value whose
hyperbolic cosine is <parameter>num</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The value to process
@ -35,7 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The inverse hyperbolic cosine of <parameter>arg</parameter>
The inverse hyperbolic cosine of <parameter>num</parameter>
</para>
</refsect1>
<refsect1 role="seealso">
@ -50,7 +50,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/math/functions/asin.xml
View file

@ -7,12 +7,12 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>asin</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>asin</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns the arc sine of <parameter>arg</parameter> in radians.
Returns the arc sine of <parameter>num</parameter> in radians.
<function>asin</function> is the inverse function of
<function>sin</function>, which means that
<literal>a==sin(asin(a))</literal> for every value of a that is within
@ -24,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
@ -37,7 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The arc sine of <parameter>arg</parameter> in radians
The arc sine of <parameter>num</parameter> in radians
</para>
</refsect1>
<refsect1 role="seealso">
@ -52,7 +52,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

17
reference/math/functions/asinh.xml
View file

@ -7,14 +7,14 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>asinh</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>asinh</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns the inverse hyperbolic sine of
<parameter>arg</parameter>, i.e. the value whose
hyperbolic sine is <parameter>arg</parameter>.
<parameter>num</parameter>, i.e. the value whose
hyperbolic sine is <parameter>num</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
@ -35,7 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The inverse hyperbolic sine of <parameter>arg</parameter>
The inverse hyperbolic sine of <parameter>num</parameter>
</para>
</refsect1>
<refsect1 role="seealso">
@ -50,7 +50,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/math/functions/atan.xml
View file

@ -7,12 +7,12 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>atan</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>atan</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns the arc tangent of <parameter>arg</parameter> in radians.
Returns the arc tangent of <parameter>num</parameter> in radians.
<function>atan</function> is the inverse function of
<function>tan</function>, which means that
<literal>a==tan(atan(a))</literal> for every value of a that is within
@ -24,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
@ -37,7 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The arc tangent of <parameter>arg</parameter> in radians.
The arc tangent of <parameter>num</parameter> in radians.
</para>
</refsect1>
<refsect1 role="seealso">
@ -52,7 +52,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

17
reference/math/functions/atanh.xml
View file

@ -7,14 +7,14 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>atanh</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>atanh</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns the inverse hyperbolic tangent of
<parameter>arg</parameter>, i.e. the value whose
hyperbolic tangent is <parameter>arg</parameter>.
<parameter>num</parameter>, i.e. the value whose
hyperbolic tangent is <parameter>num</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
@ -35,7 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Inverse hyperbolic tangent of <parameter>arg</parameter>
Inverse hyperbolic tangent of <parameter>num</parameter>
</para>
</refsect1>
<refsect1 role="seealso">
@ -50,7 +50,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

37
reference/math/functions/base-convert.xml
View file

@ -8,22 +8,22 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>base_convert</methodname>
<methodparam><type>string</type><parameter>number</parameter></methodparam>
<methodparam><type>int</type><parameter>frombase</parameter></methodparam>
<methodparam><type>int</type><parameter>tobase</parameter></methodparam>
</methodsynopsis>
<type>string</type><methodname>base_convert</methodname>
<methodparam><type>string</type><parameter>num</parameter></methodparam>
<methodparam><type>int</type><parameter>from_base</parameter></methodparam>
<methodparam><type>int</type><parameter>to_base</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing <parameter>number</parameter>
represented in base <parameter>tobase</parameter>. The base in
which <parameter>number</parameter> is given is specified in
<parameter>frombase</parameter>. Both
<parameter>frombase</parameter> and <parameter>tobase</parameter>
Returns a string containing <parameter>num</parameter>
represented in base <parameter>to_base</parameter>. The base in
which <parameter>num</parameter> is given is specified in
<parameter>from_base</parameter>. Both
<parameter>from_base</parameter> and <parameter>to_base</parameter>
have to be between 2 and 36, inclusive. Digits in numbers with a
base higher than 10 will be represented with the letters a-z,
with a meaning 10, b meaning 11 and z meaning 35.
The case of the letters doesn't matter, i.e.
<parameter>number</parameter> is interpreted case-insensitively.
<parameter>num</parameter> is interpreted case-insensitively.
</para>
<warning>
<simpara>
@ -39,28 +39,28 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>number</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The number to convert. Any invalid characters in
<parameter>number</parameter> are silently ignored.
<parameter>num</parameter> are silently ignored.
As of PHP 7.4.0 supplying any invalid characters is deprecated.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>frombase</parameter></term>
<term><parameter>from_base</parameter></term>
<listitem>
<para>
The base <parameter>number</parameter> is in
The base <parameter>num</parameter> is in
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tobase</parameter></term>
<term><parameter>to_base</parameter></term>
<listitem>
<para>
The base to convert <parameter>number</parameter> to
The base to convert <parameter>num</parameter> to
</para>
</listitem>
</varlistentry>
@ -70,7 +70,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<parameter>number</parameter> converted to base <parameter>tobase</parameter>
<parameter>num</parameter> converted to base <parameter>to_base</parameter>
</para>
</refsect1>
@ -128,7 +128,6 @@ echo base_convert($hexadecimal, 16, 2);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

17
reference/math/functions/cos.xml
View file

@ -7,13 +7,13 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>cos</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>cos</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
<function>cos</function> returns the cosine of the <parameter>arg</parameter>
parameter. The <parameter>arg</parameter> parameter is in radians.
<function>cos</function> returns the cosine of the <parameter>num</parameter>
parameter. The <parameter>num</parameter> parameter is in radians.
</para>
</refsect1>
<refsect1 role="parameters">
@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
An angle in radians
@ -34,7 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The cosine of <parameter>arg</parameter>
The cosine of <parameter>num</parameter>
</para>
</refsect1>
<refsect1 role="examples">
@ -66,7 +66,6 @@ echo cos(M_PI); // -1
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/math/functions/cosh.xml
View file

@ -7,12 +7,12 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>cosh</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>cosh</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns the hyperbolic cosine of <parameter>arg</parameter>,
Returns the hyperbolic cosine of <parameter>num</parameter>,
defined as <literal>(exp(arg) + exp(-arg))/2</literal>.
</para>
</refsect1>
@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
@ -34,7 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The hyperbolic cosine of <parameter>arg</parameter>
The hyperbolic cosine of <parameter>num</parameter>
</para>
</refsect1>
<refsect1 role="seealso">
@ -49,7 +49,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

55
reference/math/functions/decbin.xml
View file

@ -9,11 +9,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>decbin</methodname>
<methodparam><type>int</type><parameter>number</parameter></methodparam>
<methodparam><type>int</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing a binary representation of the given
<parameter>number</parameter> argument.
<parameter>num</parameter> argument.
</para>
</refsect1>
<refsect1 role="parameters">
@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>number</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
Decimal value to convert
@ -30,30 +30,30 @@
<table>
<title>Range of inputs on 32-bit machines</title>
<tgroup cols="3">
<colspec colname="c1" />
<colspec colname="c2" />
<colspec colname="c3" />
<colspec colname="c1"/>
<colspec colname="c2"/>
<colspec colname="c3"/>
<thead>
<row>
<entry>positive <parameter>number</parameter></entry>
<entry>negative <parameter>number</parameter></entry>
<entry>positive <parameter>num</parameter></entry>
<entry>negative <parameter>num</parameter></entry>
<entry>return value</entry>
</row>
</thead>
<tbody>
<row>
<entry>0</entry>
<entry></entry>
<entry/>
<entry>0</entry>
</row>
<row>
<entry>1</entry>
<entry></entry>
<entry/>
<entry>1</entry>
</row>
<row>
<entry>2</entry>
<entry></entry>
<entry/>
<entry>10</entry>
</row>
<row>
@ -61,12 +61,12 @@
</row>
<row>
<entry>2147483646</entry>
<entry></entry>
<entry/>
<entry>1111111111111111111111111111110</entry>
</row>
<row>
<entry>2147483647 (largest signed integer)</entry>
<entry></entry>
<entry/>
<entry>1111111111111111111111111111111 (31 1's)</entry>
</row>
<row>
@ -94,30 +94,30 @@
<table>
<title>Range of inputs on 64-bit machines</title>
<tgroup cols="3">
<colspec colname="c1" />
<colspec colname="c2" />
<colspec colname="c3" />
<colspec colname="c1"/>
<colspec colname="c2"/>
<colspec colname="c3"/>
<thead>
<row>
<entry>positive <parameter>number</parameter></entry>
<entry>negative <parameter>number</parameter></entry>
<entry>positive <parameter>num</parameter></entry>
<entry>negative <parameter>num</parameter></entry>
<entry>return value</entry>
</row>
</thead>
<tbody>
<row>
<entry>0</entry>
<entry></entry>
<entry/>
<entry>0</entry>
</row>
<row>
<entry>1</entry>
<entry></entry>
<entry/>
<entry>1</entry>
</row>
<row>
<entry>2</entry>
<entry></entry>
<entry/>
<entry>10</entry>
</row>
<row>
@ -125,16 +125,16 @@
</row>
<row>
<entry>9223372036854775806</entry>
<entry></entry>
<entry/>
<entry>111111111111111111111111111111111111111111111111111111111111110</entry>
</row>
<row>
<entry>9223372036854775807 (largest signed integer)</entry>
<entry></entry>
<entry/>
<entry>111111111111111111111111111111111111111111111111111111111111111 (63 1's)</entry>
</row>
<row>
<entry></entry>
<entry/>
<entry>-9223372036854775808</entry>
<entry>1000000000000000000000000000000000000000000000000000000000000000</entry>
</row>
@ -142,12 +142,12 @@
<entry namest="c1" nameend="c3">... normal progression ...</entry>
</row>
<row>
<entry></entry>
<entry/>
<entry>-2</entry>
<entry>1111111111111111111111111111111111111111111111111111111111111110</entry>
</row>
<row>
<entry></entry>
<entry/>
<entry>-1</entry>
<entry>1111111111111111111111111111111111111111111111111111111111111111 (64 1's)</entry>
</row>
@ -163,7 +163,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Binary string representation of <parameter>number</parameter>
Binary string representation of <parameter>num</parameter>
</para>
</refsect1>
<refsect1 role="examples">
@ -209,7 +209,6 @@ echo decbin(26);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/math/functions/dechex.xml
View file

@ -7,13 +7,13 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>dechex</methodname>
<methodparam><type>int</type><parameter>number</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>dechex</methodname>
<methodparam><type>int</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing a hexadecimal representation of the given
unsigned <parameter>number</parameter> argument.
unsigned <parameter>num</parameter> argument.
</para>
<para>
The largest number that can be converted is
@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>number</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The decimal value to convert.
@ -46,7 +46,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Hexadecimal string representation of <parameter>number</parameter>.
Hexadecimal string representation of <parameter>num</parameter>.
</para>
</refsect1>
<refsect1 role="examples">
@ -108,7 +108,6 @@ ffffffff
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/math/functions/decoct.xml
View file

@ -7,13 +7,13 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>decoct</methodname>
<methodparam><type>int</type><parameter>number</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>string</type><methodname>decoct</methodname>
<methodparam><type>int</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing an octal representation of the given
<parameter>number</parameter> argument. The largest number that can be
<parameter>num</parameter> argument. The largest number that can be
converted depends on the platform in use. For 32-bit platforms this is
usually <literal>4294967295</literal> in decimal resulting in
<literal>37777777777</literal>. For 64-bit platforms this is usually
@ -26,7 +26,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>number</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
Decimal value to convert
@ -39,7 +39,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Octal string representation of <parameter>number</parameter>
Octal string representation of <parameter>num</parameter>
</para>
</refsect1>
<refsect1 role="examples">
@ -77,7 +77,6 @@ echo decoct(264);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

17
reference/math/functions/deg2rad.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.deg2rad" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.deg2rad">
<refnamediv>
<refname>deg2rad</refname>
<refpurpose>
@ -9,12 +9,12 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>deg2rad</methodname>
<methodparam><type>float</type><parameter>number</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>deg2rad</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
This function converts <parameter>number</parameter> from degrees
This function converts <parameter>num</parameter> from degrees
to the radian equivalent.
</para>
</refsect1>
@ -23,7 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>number</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
Angular value in degrees
@ -36,7 +36,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The radian equivalent of <parameter>number</parameter>
The radian equivalent of <parameter>num</parameter>
</para>
</refsect1>
<refsect1 role="examples">
@ -66,7 +66,6 @@ var_dump(deg2rad(45) === M_PI_4); // bool(true)
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/math/functions/exp.xml
View file

@ -7,12 +7,12 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>exp</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>exp</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns <constant>e</constant> raised to the power of <parameter>arg</parameter>.
Returns <constant>e</constant> raised to the power of <parameter>num</parameter>.
</para>
<note>
<para>
@ -26,7 +26,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
@ -39,7 +39,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
'e' raised to the power of <parameter>arg</parameter>
'e' raised to the power of <parameter>num</parameter>
</para>
</refsect1>
<refsect1 role="examples">
@ -75,7 +75,6 @@ echo exp(5.7);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/math/functions/expm1.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.expm1' xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.expm1">
<refnamediv>
<refname>expm1</refname>
<refpurpose>
@ -12,13 +12,13 @@
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>expm1</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
<function>expm1</function> returns the equivalent to
'exp(<parameter>arg</parameter>) - 1' computed in a way that is
accurate even if the value of <parameter>arg</parameter> is near zero,
a case where 'exp (<parameter>arg</parameter>) - 1' would be
'exp(<parameter>num</parameter>) - 1' computed in a way that is
accurate even if the value of <parameter>num</parameter> is near zero,
a case where 'exp (<parameter>num</parameter>) - 1' would be
inaccurate due to subtraction of two numbers that are nearly equal.
</para>
</refsect1>
@ -27,7 +27,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
@ -40,7 +40,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
'e' to the power of <parameter>arg</parameter> minus one
'e' to the power of <parameter>num</parameter> minus one
</para>
</refsect1>
<refsect1 role="seealso">
@ -53,7 +53,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

21
reference/math/functions/fdiv.xml
View file

@ -7,15 +7,15 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>fdiv</methodname>
<methodparam><type>float</type><parameter>dividend</parameter></methodparam>
<methodparam><type>float</type><parameter>divisor</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>fdiv</methodname>
<methodparam><type>float</type><parameter>num1</parameter></methodparam>
<methodparam><type>float</type><parameter>num2</parameter></methodparam>
</methodsynopsis>
<para>
Returns the floating point result of dividing the
<parameter>dividend</parameter> by the <parameter>divisor</parameter>.
If the <parameter>divisor</parameter> is zero, then one of <literal>INF</literal>,
<parameter>num1</parameter> by the <parameter>num2</parameter>.
If the <parameter>num2</parameter> is zero, then one of <literal>INF</literal>,
<literal>-INF</literal>, or <literal>NAN</literal> will be returned.
</para>
<para>
@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>dividend</parameter></term>
<term><parameter>num1</parameter></term>
<listitem>
<para>
The dividend (numerator)
@ -36,7 +36,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>divisor</parameter></term>
<term><parameter>num2</parameter></term>
<listitem>
<para>
The divisor
@ -50,7 +50,7 @@
&reftitle.returnvalues;
<para>
The floating point result of
<parameter>dividend</parameter>/<parameter>divisor</parameter>
<parameter>num1</parameter>/<parameter>num2</parameter>
</para>
</refsect1>
<refsect1 role="examples">
@ -83,7 +83,6 @@ var_dump(fdiv(0.0, 0.0)); // float(NAN)
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

25
reference/math/functions/fmod.xml
View file

@ -8,19 +8,19 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>fmod</methodname>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>fmod</methodname>
<methodparam><type>float</type><parameter>num1</parameter></methodparam>
<methodparam><type>float</type><parameter>num2</parameter></methodparam>
</methodsynopsis>
<para>
Returns the floating point remainder of dividing the dividend
(<parameter>x</parameter>) by the divisor (<parameter>y</parameter>).
(<parameter>num1</parameter>) by the divisor (<parameter>num2</parameter>).
The remainder (<varname>r</varname>) is defined as: x = i * y + r, for
some integer <varname>i</varname>. If <parameter>y</parameter> is
some integer <varname>i</varname>. If <parameter>num2</parameter> is
non-zero, <varname>r</varname> has the same sign as
<parameter>x</parameter> and a magnitude less than the magnitude of
<parameter>y</parameter>.
<parameter>num1</parameter> and a magnitude less than the magnitude of
<parameter>num2</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>x</parameter></term>
<term><parameter>num1</parameter></term>
<listitem>
<para>
The dividend
@ -36,7 +36,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<term><parameter>num2</parameter></term>
<listitem>
<para>
The divisor
@ -50,7 +50,7 @@
&reftitle.returnvalues;
<para>
The floating point remainder of
<parameter>x</parameter>/<parameter>y</parameter>
<parameter>num1</parameter>/<parameter>num2</parameter>
</para>
</refsect1>
<refsect1 role="examples">
@ -82,7 +82,6 @@ $r = fmod($x, $y);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

26
reference/math/functions/intdiv.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.intdiv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>intdiv</refname>
@ -9,19 +8,19 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>intdiv</methodname>
<methodparam><type>int</type><parameter>dividend</parameter></methodparam>
<methodparam><type>int</type><parameter>divisor</parameter></methodparam>
</methodsynopsis>
<type>int</type><methodname>intdiv</methodname>
<methodparam><type>int</type><parameter>num1</parameter></methodparam>
<methodparam><type>int</type><parameter>num2</parameter></methodparam>
</methodsynopsis>
<para>
Returns the integer quotient of the division of <parameter>dividend</parameter> by <parameter>divisor</parameter>.
Returns the integer quotient of the division of <parameter>num1</parameter> by <parameter>num2</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>dividend</parameter></term>
<term><parameter>num1</parameter></term>
<listitem>
<para>
Number to be divided.
@ -29,10 +28,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>divisor</parameter></term>
<term><parameter>num2</parameter></term>
<listitem>
<para>
Number which divides the <parameter>dividend</parameter>.
Number which divides the <parameter>num1</parameter>.
</para>
</listitem>
</varlistentry>
@ -41,15 +40,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The integer quotient of the division of <parameter>dividend</parameter> by <parameter>divisor</parameter>.
The integer quotient of the division of <parameter>num1</parameter> by <parameter>num2</parameter>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
If <parameter>divisor</parameter> is <literal>0</literal>, a <classname>DivisionByZeroError</classname>
exception is thrown. If the <parameter>dividend</parameter> is <constant>PHP_INT_MIN</constant>
and the <parameter>divisor</parameter> is <literal>-1</literal>, then an
If <parameter>num2</parameter> is <literal>0</literal>, a <classname>DivisionByZeroError</classname>
exception is thrown. If the <parameter>num1</parameter> is <constant>PHP_INT_MIN</constant>
and the <parameter>num2</parameter> is <literal>-1</literal>, then an
<classname>ArithmeticError</classname> exception is thrown.
</para>
</refsect1>
@ -99,7 +98,6 @@ Fatal error: Uncaught DivisionByZeroError: Division by zero in %s on line 9
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

17
reference/math/functions/is-finite.xml
View file

@ -1,18 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.is-finite' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="function.is-finite" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>is_finite</refname>
<refpurpose>Finds whether a value is a legal finite number</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>is_finite</methodname>
<methodparam><type>float</type><parameter>val</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>is_finite</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Checks whether <parameter>val</parameter> is a legal finite
Checks whether <parameter>num</parameter> is a legal finite
on this platform.
</para>
</refsect1>
@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>val</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The value to check
@ -34,7 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&true; if <parameter>val</parameter> is a legal finite
&true; if <parameter>num</parameter> is a legal finite
number within the allowed range for a PHP float on this platform,
else &false;.
</para>
@ -49,7 +49,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

17
reference/math/functions/is-infinite.xml
View file

@ -1,18 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.is-infinite' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="function.is-infinite" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>is_infinite</refname>
<refpurpose>Finds whether a value is infinite</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>is_infinite</methodname>
<methodparam><type>float</type><parameter>val</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>is_infinite</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns &true; if <parameter>val</parameter> is infinite (positive or
Returns &true; if <parameter>num</parameter> is infinite (positive or
negative), like the result of <literal>log(0)</literal> or any value too
big to fit into a float on this platform.
</para>
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>val</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The value to check
@ -35,7 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&true; if <parameter>val</parameter> is infinite, else &false;.
&true; if <parameter>num</parameter> is infinite, else &false;.
</para>
</refsect1>
<refsect1 role="seealso">
@ -48,7 +48,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/math/functions/is-nan.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.is-nan' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="function.is-nan" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>is_nan</refname>
<refpurpose>Finds whether a value is not a number</refpurpose>
@ -10,10 +10,10 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>is_nan</methodname>
<methodparam><type>float</type><parameter>val</parameter></methodparam>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Checks whether <parameter>val</parameter> is 'not a number',
Checks whether <parameter>num</parameter> is 'not a number',
like the result of <literal>acos(1.01)</literal>.
</para>
</refsect1>
@ -23,7 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>val</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The value to check
@ -37,7 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if <parameter>val</parameter> is 'not a number',
Returns &true; if <parameter>num</parameter> is 'not a number',
else &false;.
</para>
</refsect1>
@ -80,7 +80,6 @@ bool(true)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

19
reference/math/functions/log.xml
View file

@ -7,16 +7,16 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>log</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>base</parameter><initializer>M_E</initializer></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>log</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>base</parameter><initializer><constant>M_E</constant></initializer></methodparam>
</methodsynopsis>
<para>
If the optional <parameter>base</parameter> parameter is specified,
<function>log</function> returns log<subscript>base</subscript>
<parameter>arg</parameter>, otherwise <function>log</function>
returns the natural logarithm of <parameter>arg</parameter>.
<parameter>num</parameter>, otherwise <function>log</function>
returns the natural logarithm of <parameter>num</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
@ -24,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The value to calculate the logarithm for
@ -46,7 +46,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The logarithm of <parameter>arg</parameter> to
The logarithm of <parameter>num</parameter> to
<parameter>base</parameter>, if given, or the
natural logarithm.
</para>
@ -62,7 +62,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

17
reference/math/functions/log10.xml
View file

@ -1,18 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.log10" xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.log10">
<refnamediv>
<refname>log10</refname>
<refpurpose>Base-10 logarithm</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>log10</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>float</type><methodname>log10</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns the base-10 logarithm of <parameter>arg</parameter>.
Returns the base-10 logarithm of <parameter>num</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
@ -20,7 +20,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
@ -33,7 +33,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The base-10 logarithm of <parameter>arg</parameter>
The base-10 logarithm of <parameter>num</parameter>
</para>
</refsect1>
<refsect1 role="seealso">
@ -45,7 +45,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

13
reference/math/functions/log1p.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.log1p' xmlns="http://docbook.org/ns/docbook">
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.log1p">
<refnamediv>
<refname>log1p</refname>
<refpurpose>
@ -12,12 +12,12 @@
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>log1p</methodname>
<methodparam><type>float</type><parameter>number</parameter></methodparam>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
<function>log1p</function> returns log(1 +
<parameter>number</parameter>) computed in a way that is accurate even
when the value of <parameter>number</parameter> is close to zero.
<parameter>num</parameter>) computed in a way that is accurate even
when the value of <parameter>num</parameter> is close to zero.
<function>log</function> might only return log(1) in this case
due to lack of precision.
</para>
@ -27,7 +27,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>number</parameter></term>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
@ -40,7 +40,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
log(1 + <parameter>number</parameter>)
log(1 + <parameter>num</parameter>)
</para>
</refsect1>
<refsect1 role="seealso">
@ -54,7 +54,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

Some files were not shown because too many files have changed in this diff Show more