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

Switch to new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249414 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-12-30 11:35:36 +00:00
parent 18e5fb4e47
commit 6b20633e2a
50 changed files with 1625 additions and 569 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
reference/array/functions/array-rand.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.13 -->
<!-- $Revision: 1.12 $ -->
<refentry xml:id="function.array-rand" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_rand</refname>
<refpurpose>Pick one or more random entries out of an array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>array_rand</methodname>
<methodparam><type>array</type><parameter>input</parameter></methodparam>
@ -15,20 +14,44 @@
</methodsynopsis>
<para>
<function>array_rand</function> is rather useful when you want to
pick one or more random entries out of an array. It takes an
<parameter>input</parameter> array and an optional argument
<parameter>num_req</parameter> which specifies how many entries you
want to pick - if not specified, it defaults to 1.
pick one or more random entries out of an array.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
The input array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>num_req</parameter></term>
<listitem>
<para>
Specifies how many entries you want to pick - if not specified,
defaults to 1.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If you are picking only one entry, <function>array_rand</function>
returns the key for a random entry. Otherwise, it returns an array
of keys for the random entries. This is done so that you can pick
random keys as well as values out of the array.
</para>
&note.randomseed;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_rand</function> example</title>
@ -45,8 +68,17 @@ echo $input[$rand_keys[1]] . "\n";
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.randomseed;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>shuffle</function>.
<simplelist>
<member><function>shuffle</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

80
reference/array/functions/array-reduce.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<!-- $Revision: 1.12 $ -->
<refentry xml:id="function.array-reduce" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_reduce</refname>
<refpurpose>Iteratively reduce the array to a single value using a callback function</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>array_reduce</methodname>
<methodparam><type>array</type><parameter>input</parameter></methodparam>
@ -18,12 +17,54 @@
<function>array_reduce</function> applies iteratively the
<parameter>function</parameter> function to the elements of the
array <parameter>input</parameter>, so as to reduce the array to
a single value. If the optional <parameter>initial</parameter> is
available, it will be used at the beginning of the process, or as
a final result in case the array is empty.
a single value.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
The input array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
The callback function.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>initial</parameter></term>
<listitem>
<para>
If the optional <parameter>initial</parameter> is available, it will
be used at the beginning of the process, or as a final result in case
the array is empty.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the resulting value.
</para>
<para>
If the array is empty and <parameter>initial</parameter> is not passed,
<function>array_reduce</function> returns &null;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_reduce</function> example</title>
@ -50,19 +91,24 @@ $d = array_reduce($x, "rsum", 1);
?>
]]>
</programlisting>
<para>
This will result in <varname>$b</varname> containing
<literal>15</literal>, <varname>$c</varname> containing
<literal>1200</literal> (= 10*1*2*3*4*5), and <varname>$d</varname>
containing <literal>1</literal>.
</para>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
This will result in <varname>$b</varname> containing
<literal>15</literal>, <varname>$c</varname> containing
<literal>1200</literal> (= 10*1*2*3*4*5), and
<varname>$d</varname> containing <literal>1</literal>.
</para>
<para>
See also <function>array_filter</function>,
<function>array_map</function>,
<function>array_unique</function>, and
<function>array_count_values</function>.
<simplelist>
<member><function>array_filter</function></member>
<member><function>array_map</function></member>
<member><function>array_unique</function></member>
<member><function>array_count_values</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

67
reference/array/functions/array-sum.xml
View file

@ -1,21 +1,68 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.59 -->
<!-- $Revision: 1.14 $ -->
<refentry xml:id="function.array-sum" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_sum</refname>
<refpurpose>Calculate the sum of values in an array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>number</type><methodname>array_sum</methodname>
<methodparam><type>array</type><parameter>array</parameter></methodparam>
</methodsynopsis>
<para>
<function>array_sum</function> returns the sum of values
in an array as an integer or float.
<function>array_sum</function> returns the sum of values in an array.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The input array.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the sum of values as an integer or float.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>4.2.1</entry>
<entry>
PHP versions prior to 4.2.1 modified the passed array itself and
converted strings to numbers (which most of the time converted them
to zero, depending on their value).
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_sum</function> examples</title>
@ -39,14 +86,6 @@ sum(b) = 6.9
</screen>
</example>
</para>
<note>
<para>
PHP versions prior to 4.2.1 modified the passed array
itself and converted strings to numbers (which most
of the time converted them to zero, depending on
their value).
</para>
</note>
</refsect1>
</refentry>

60
reference/array/functions/array-unshift.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<!-- $Revision: 1.16 $ -->
<refentry xml:id="function.array-unshift" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>array_unshift</refname>
<refpurpose>Prepend one or more elements to the beginning of an array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>array_unshift</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
@ -15,16 +14,44 @@
<methodparam choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
<function>array_unshift</function> prepends passed elements to
the front of the <parameter>array</parameter>. Note that the list
of elements is prepended as a whole, so that the prepended
elements stay in the same order. All numerical array keys will be
modified to start counting from zero while literal keys won't be touched.
<function>array_unshift</function> prepends passed elements to the front
of the <parameter>array</parameter>. Note that the list of elements is
prepended as a whole, so that the prepended elements stay in the same
order. All numerical array keys will be modified to start counting from
zero while literal keys won't be touched.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
Returns the new number of elements in the
<parameter>array</parameter>.
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The input array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem>
<para>
The prepended variable.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the new number of elements in the <parameter>array</parameter>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>array_unshift</function> example</title>
@ -51,10 +78,15 @@ Array
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>array_shift</function>,
<function>array_push</function>, and
<function>array_pop</function>.
<simplelist>
<member><function>array_shift</function></member>
<member><function>array_push</function></member>
<member><function>array_pop</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

88
reference/array/functions/arsort.xml
View file

@ -1,30 +1,63 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<!-- $Revision: 1.15 $ -->
<refentry xml:id="function.arsort" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>arsort</refname>
<refpurpose>Sort an array in reverse order and maintain index association</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>arsort</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam>
</methodsynopsis>
<para>
This function sorts an array such that array indices maintain
their correlation with the array elements they are associated
with. This is used mainly when sorting associative arrays where
the actual element order is significant.
This function sorts an array such that array indices maintain their
correlation with the array elements they are associated with.
</para>
<para>
This is used mainly when sorting associative arrays where the actual
element order is significant.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The input array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sort_flags</parameter></term>
<listitem>
<para>
You may modify the behavior of the sort using the optional parameter
<parameter>sort_flags</parameter>, for details see
<function>sort</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
<example>
<title><function>arsort</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>arsort</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$fruits = array("d" => "lemon", "a" => "orange", "b" => "banana", "c" => "apple");
@ -34,29 +67,32 @@ foreach ($fruits as $key => $val) {
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
a = orange
d = lemon
b = banana
c = apple
]]>
</screen>
</example>
<para>
The fruits have been sorted in reverse alphabetical order, and
the index associated with each element has been maintained.
</screen>
<para>
The fruits have been sorted in reverse alphabetical order, and
the index associated with each element has been maintained.
</para>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
You may modify the behavior of the sort using the optional
parameter <parameter>sort_flags</parameter>, for details
see <function>sort</function>.
</para>
<para>
See also <function>asort</function>, <function>rsort</function>,
<function>ksort</function>, and <function>sort</function>.
<simplelist>
<member><function>asort</function></member>
<member><function>rsort</function></member>
<member><function>ksort</function></member>
<member><function>sort</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

57
reference/array/functions/krsort.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<!-- $Revision: 1.15 $ -->
<refentry xml:id="function.krsort" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>krsort</refname>
<refpurpose>Sort an array by key in reverse order</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>krsort</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
@ -17,9 +16,40 @@
Sorts an array by key in reverse order, maintaining key to data
correlations. This is useful mainly for associative arrays.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The input array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sort_flags</parameter></term>
<listitem>
<para>
You may modify the behavior of the sort using the optional parameter
<parameter>sort_flags</parameter>, for details see
<function>sort</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>krsort</function> example</title>
@ -45,16 +75,19 @@ a = orange
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
You may modify the behavior of the sort using the optional
parameter <parameter>sort_flags</parameter>, for details
see <function>sort</function>.
<simplelist>
<member><function>asort</function></member>
<member><function>arsort</function></member>
<member><function>ksort</function></member>
<member><function>sort</function></member>
<member><function>natsort</function></member>
<member><function>rsort</function></member>
</simplelist>
</para>
<simpara>
See also <function>asort</function>, <function>arsort</function>,
<function>ksort</function>, <function>sort</function>,
<function>natsort</function>, and <function>rsort</function>.
</simpara>
</refsect1>
</refentry>

76
reference/array/functions/prev.xml
View file

@ -1,38 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<!-- $Revision: 1.12 $ -->
<refentry xml:id="function.prev" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>prev</refname>
<refpurpose>Rewind the internal array pointer</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>prev</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
</methodsynopsis>
<para>
Rewind the internal array pointer.
</para>
<para>
<function>prev</function> behaves just like <function>next</function>,
except it rewinds the internal array pointer one place instead of advancing it.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The input array.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the array value in the previous place that's pointed to by
the internal array pointer, or &false; if there are no more
elements.
</para>
&return.falseproblem;
<note>
<simpara>
You won't be able to distinguish the beginning of an array from a
<type>boolean</type> &false; element. To properly traverse an array
which may contain &false; elements, see the <function>each</function>
function.
</simpara>
</note>
<para>
<function>prev</function> behaves just like
<function>next</function>, except it rewinds the internal array
pointer one place instead of advancing it.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Example use of <function>prev</function> and friends</title>
@ -50,10 +61,29 @@ $mode = end($transport); // $mode = 'plane';
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&return.falseproblem;
<note>
<simpara>
You won't be able to distinguish the beginning of an array from a
<type>boolean</type> &false; element. To properly traverse an array
which may contain &false; elements, see the <function>each</function>
function.
</simpara>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>current</function>, <function>end</function>,
<function>next</function>, <function>reset</function>,
and <function>each</function>.
<simplelist>
<member><function>current</function></member>
<member><function>end</function></member>
<member><function>next</function></member>
<member><function>reset</function></member>
<member><function>each</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

51
reference/array/functions/reset.xml
View file

@ -1,22 +1,46 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.16 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<!-- $Revision: 1.17 $ -->
<refentry xml:id="function.reset" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>reset</refname>
<refpurpose>Set the internal pointer of an array to its first element</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>reset</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
</methodsynopsis>
<para>
<function>reset</function> rewinds <parameter>array</parameter>'s
internal pointer to the first element and returns the value of the first
array element, or &false; if the array is empty.
<function>reset</function> rewinds <parameter>array</parameter>'s internal
pointer to the first element and returns the value of the first array
element.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The input array.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the value of the first array element, or &false; if the array is
empty.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>reset</function> example</title>
@ -43,10 +67,17 @@ echo current($array) . "<br />\n"; // "step one"
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>current</function>,
<function>each</function>, <function>end</function>,
<function>next</function>, and <function>prev</function>.
<simplelist>
<member><function>current</function></member>
<member><function>each</function></member>
<member><function>end</function></member>
<member><function>next</function></member>
<member><function>prev</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

69
reference/array/functions/rsort.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<!-- $Revision: 1.16 $ -->
<refentry xml:id="function.rsort" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>rsort</refname>
<refpurpose>Sort an array in reverse order</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>rsort</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
@ -16,10 +15,40 @@
<para>
This function sorts an array in reverse order (highest to lowest).
</para>
&note.no-key-association;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The input array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sort_flags</parameter></term>
<listitem>
<para>
You may modify the behavior of the sort using the optional
parameter <parameter>sort_flags</parameter>, for details see
<function>sort</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>rsort</function> example</title>
@ -43,21 +72,27 @@ foreach ($fruits as $key => $val) {
3 = apple
]]>
</screen>
<para>
The fruits have been sorted in reverse alphabetical order.
</para>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.no-key-association;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
The fruits have been sorted in reverse alphabetical order.
</para>
<para>
You may modify the behavior of the sort using the optional
parameter <parameter>sort_flags</parameter>, for details
see <function>sort</function>.
</para>
<para>
See also <function>arsort</function>,
<function>asort</function>, <function>ksort</function>,
<function>krsort</function>,
<function>sort</function>, and <function>usort</function>.
<simplelist>
<member><function>arsort</function></member>
<member><function>asort</function></member>
<member><function>ksort</function></member>
<member><function>krsort</function></member>
<member><function>sort</function></member>
<member><function>usort</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

69
reference/array/functions/uasort.xml
View file

@ -1,40 +1,69 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.uasort" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>uasort</refname>
<refpurpose>Sort an array with a user-defined comparison function and maintain index association</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>uasort</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
<methodparam><type>callback</type><parameter>cmp_function</parameter></methodparam>
</methodsynopsis>
<para>
This function sorts an array such that array indices maintain
their correlation with the array elements they are associated
with. This is used mainly when sorting associative arrays where
the actual element order is significant. The comparison function
is user-defined.
This function sorts an array such that array indices maintain their
correlation with the array elements they are associated with, using a
user-defined comparison function.
</para>
<para>
This is used mainly when sorting associative arrays where the actual
element order is significant.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
The input array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cmp_function</parameter></term>
<listitem>
<para>
See <function>usort</function> and <function>uksort</function> for
examples of user-defined comparison functions.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
<note>
<para>
Please see <function>usort</function> and
<function>uksort</function> for examples of user-defined
comparison functions.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>usort</function>, <function>uksort</function>,
<function>sort</function>, <function>asort</function>,
<function>arsort</function>, <function>ksort</function>,
and <function>rsort</function>.
<simplelist>
<member><function>usort</function></member>
<member><function>uksort</function></member>
<member><function>asort</function></member>
<member><function>arsort</function></member>
<member><function>ksort</function></member>
<member><function>rsort</function></member>
<member><function>sort</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

23
reference/com/functions/com-create-guid.xml
View file

@ -1,23 +1,36 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.com-create-guid" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>com_create_guid</refname>
<refpurpose>Generate a globally unique identifier (GUID)</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>com_create_guid</methodname>
<void/>
</methodsynopsis>
<para>
Generates a Globally Unique Identifier (GUID) and returns it as a string.
Generates a Globally Unique Identifier (GUID).
</para>
<para>
A GUID is generated in the same way as DCE UUID's, except that the
Microsoft convention is to enclose a GUID in curly braces.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>uuid_create</function> in the PECL uuid extension.
Returns the GUID as a string.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>uuid_create</function> in the PECL uuid extension</member>
</simplelist>
</para>
</refsect1>
</refentry>

50
reference/com/functions/com-release.xml
View file

@ -1,32 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/com.xml, last change in rev 1.7 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.com-release" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>com_release</refname>
<refpurpose>Decreases the components reference counter [deprecated]</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>com_release</methodname>
<void/>
<type>void</type><methodname>com_release</methodname>
<void/>
</methodsynopsis>
<para>
Decreases the components reference counter.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.0.0</entry>
<entry>
This function was removed.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<simpara>
You should never need to use this function.
</simpara>
</warning>
<note>
<simpara>This function has gone away in PHP 5.</simpara>
</note>
</refsect1>
</refentry>

40
reference/com/functions/variant-abs.xml
View file

@ -1,27 +1,49 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-abs" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_abs</refname>
<refpurpose>Returns the absolute value of a variant</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_abs</methodname>
<methodparam><type>mixed</type><parameter>val</parameter></methodparam>
</methodsynopsis>
<para>
Returns the absolute value of a variant.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>val</parameter></term>
<listitem>
<para>
The variant.
</para>
</listitem>
</varlistentry>
</variablelist>
&com.variant-arith;
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the absolute value of <parameter>val</parameter>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>abs</function>.
<simplelist>
<member><function>abs</function></member>
</simplelist>
</para>
&com.variant-arith;
</refsect1>
</refentry>

51
reference/com/functions/variant-cat.xml
View file

@ -1,32 +1,65 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-cat" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_cat</refname>
<refpurpose>concatenates two variant values together and returns the result</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_cat</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Concatenates <parameter>left</parameter> with
<parameter>right</parameter> and returns the result.
</para>
<para>
See also <xref linkend="language.operators.string"/> for the string
concatenation operator; this function is notionally equivalent to
This function is notionally equivalent to
<parameter>$left</parameter> <literal>.</literal> <parameter>$right</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
&com.variant-arith;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the result of the concatenation.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="language.operators.string"/> for the string
concatenation operator</member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

228
reference/com/functions/variant-cmp.xml
View file

@ -1,13 +1,12 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-cmp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_cmp</refname>
<refpurpose>Compares two variants</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>variant_cmp</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
@ -15,109 +14,134 @@
<methodparam choice="opt"><type>int</type><parameter>lcid</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Compares <parameter>left</parameter> with <parameter>right</parameter>
and returns one of the following values:
Compares <parameter>left</parameter> with <parameter>right</parameter>.
</para>
<para>
This function will only compare scalar values, not arrays or variant records.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lcid</parameter></term>
<listitem>
<para>
A valid Locale Identifier to use when comparing strings (this affects
string collation).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
<parameter>flags</parameter> can be one or more of the following values
OR'd together, and affects string comparisons:
<table>
<title>Variant Comparision Flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>value</entry>
<entry>meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>NORM_IGNORECASE</constant></entry>
<entry>Compare case insensitively</entry>
</row>
<row>
<entry><constant>NORM_IGNORENONSPACE</constant></entry>
<entry>Ignore nonspacing characters</entry>
</row>
<row>
<entry><constant>NORM_IGNORESYMBOLS</constant></entry>
<entry>Ignore symbols</entry>
</row>
<row>
<entry><constant>NORM_IGNOREWIDTH</constant></entry>
<entry>Ignore string width</entry>
</row>
<row>
<entry><constant>NORM_IGNOREKANATYPE</constant></entry>
<entry>Ignore Kana type</entry>
</row>
<row>
<entry><constant>NORM_IGNOREKASHIDA</constant></entry>
<entry>Ignore Arabic kashida characters</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
&com.variant-arith;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns one of the following:
<table>
<title>Variant Comparision Results</title>
<tgroup cols="2">
<thead>
<row>
<entry>value</entry>
<entry>meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>VARCMP_LT</constant></entry>
<entry><parameter>left</parameter> is less than
<parameter>right</parameter>
</entry>
</row>
<row>
<entry><constant>VARCMP_EQ</constant></entry>
<entry><parameter>left</parameter> is equal to
<parameter>right</parameter>
</entry>
</row>
<row>
<entry><constant>VARCMP_GT</constant></entry>
<entry><parameter>left</parameter> is greater than
<parameter>right</parameter>
</entry>
</row>
<row>
<entry><constant>VARCMP_NULL</constant></entry>
<entry>Either <parameter>left</parameter>,
<parameter>right</parameter> or both are &null;
</entry>
</row>
<thead>
<row>
<entry>value</entry>
<entry>meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>VARCMP_LT</constant></entry>
<entry><parameter>left</parameter> is less than
<parameter>right</parameter>
</entry>
</row>
<row>
<entry><constant>VARCMP_EQ</constant></entry>
<entry><parameter>left</parameter> is equal to
<parameter>right</parameter>
</entry>
</row>
<row>
<entry><constant>VARCMP_GT</constant></entry>
<entry><parameter>left</parameter> is greater than
<parameter>right</parameter>
</entry>
</row>
<row>
<entry><constant>VARCMP_NULL</constant></entry>
<entry>Either <parameter>left</parameter>,
<parameter>right</parameter> or both are &null;
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
This function will only compare scalar values, not arrays or variant records.
</para>
<para>
<parameter>lcid</parameter> is a valid Locale Identifier to use when
comparing strings (this affects string collation).
<parameter>flags</parameter> can be one or more of the following values
OR'd together, and affects string comparisons:
<table>
<title>Variant Comparision Flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>value</entry>
<entry>meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>NORM_IGNORECASE</constant></entry>
<entry>Compare case insensitively</entry>
</row>
<row>
<entry><constant>NORM_IGNORENONSPACE</constant></entry>
<entry>Ignore nonspacing characters</entry>
</row>
<row>
<entry><constant>NORM_IGNORESYMBOLS</constant></entry>
<entry>Ignore symbols</entry>
</row>
<row>
<entry><constant>NORM_IGNOREWIDTH</constant></entry>
<entry>Ignore string width</entry>
</row>
<row>
<entry><constant>NORM_IGNOREKANATYPE</constant></entry>
<entry>Ignore Kana type</entry>
</row>
<row>
<entry><constant>NORM_IGNOREKASHIDA</constant></entry>
<entry>Ignore Arabic kashida characters</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
&com.variant-arith;
</tgroup>
</table>
</para>
</refsect1>
</refentry>

48
reference/com/functions/variant-mod.xml
View file

@ -1,31 +1,61 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-mod" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_mod</refname>
<refpurpose>Divides two variants and returns only the remainder</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_mod</methodname>
<methodparam><type>mixed</type><parameter>left</parameter></methodparam>
<methodparam><type>mixed</type><parameter>right</parameter></methodparam>
</methodsynopsis>
<para>
Divides <parameter>left</parameter> by <parameter>right</parameter> and
returns the remainder.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>variant_div</function>,
<function>variant_idiv</function>.
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
The left operand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right</parameter></term>
<listitem>
<para>
The right operand.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
&com.variant-arith;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the remainder of the division.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>variant_div</function></member>
<member><function>variant_idiv</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

33
reference/com/functions/variant-neg.xml
View file

@ -1,25 +1,42 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-neg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_neg</refname>
<refpurpose>Performs logical negation on a variant</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_neg</methodname>
<methodparam><type>mixed</type><parameter>variant</parameter></methodparam>
</methodsynopsis>
<para>
Performs logical negation of <parameter>variant</parameter> and returns
the result.
Performs logical negation of <parameter>variant</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>variant</parameter></term>
<listitem>
<para>
The variant.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
&com.variant-arith;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the result of the logical negation.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

34
reference/com/functions/variant-not.xml
View file

@ -1,26 +1,44 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-not" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_not</refname>
<refpurpose>Performs bitwise not negation on a variant</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_not</methodname>
<methodparam><type>mixed</type><parameter>variant</parameter></methodparam>
</methodsynopsis>
<para>
Performs bitwise not negation on <parameter>variant</parameter> and
returns the result. If <parameter>variant</parameter> is &null;, the
result will also be &null;.
returns the result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>variant</parameter></term>
<listitem>
<para>
The variant.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
&com.variant-arith;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the bitwise not negation. If <parameter>variant</parameter> is
&null;, the result will also be &null;.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

46
reference/com/functions/variant-round.xml
View file

@ -1,30 +1,60 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-round" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_round</refname>
<refpurpose>Rounds a variant to the specified number of decimal places</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>variant_round</methodname>
<methodparam><type>mixed</type><parameter>variant</parameter></methodparam>
<methodparam><type>int</type><parameter>decimals</parameter></methodparam>
</methodsynopsis>
<para>
Returns the value of <parameter>variant</parameter> rounded to
<parameter>decimals</parameter> decimal places.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>round</function>.
<variablelist>
<varlistentry>
<term><parameter>variant</parameter></term>
<listitem>
<para>
The variant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>decimals</parameter></term>
<listitem>
<para>
Number of decimal places.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
&com.variant-arith;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the rounded value.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>round</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

37
reference/com/functions/variant-set.xml
View file

@ -1,25 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.variant-set" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_set</refname>
<refpurpose>Assigns a new value for a variant object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>variant_set</methodname>
<methodparam><type>variant</type><parameter>variant</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Converts <parameter>value</parameter> to a variant and assigns it to the
<parameter>variant</parameter> object; no new variant object is created,
and the old value of <parameter>variant</parameter> is freed/released.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>variant</parameter></term>
<listitem>
<para>
The variant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>

49
reference/domxml/functions/xpath-new-context.xml
View file

@ -1,26 +1,31 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/domxml.xml, last change in rev 1.38 -->
<refentry xml:id="function.xpath-new-context" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>xpath_new_context</refname>
<refpurpose>
Creates new xpath context
</refpurpose>
</refnamediv>
<refsect1>
&reftitle.description;
<methodsynopsis>
<type>XPathContext</type><methodname>xpath_new_context</methodname>
<methodparam><type>domdocument</type><parameter>dom_document</parameter></methodparam>
</methodsynopsis>
<para>
</para>
<para>
See also <function>xpath_eval</function>.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.xpath-new-context" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>xpath_new_context</refname>
<refpurpose>
Creates new xpath context
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>XPathContext</type><methodname>xpath_new_context</methodname>
<methodparam><type>domdocument</type><parameter>dom_document</parameter></methodparam>
</methodsynopsis>
<para>
Creates a new xpath context.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>xpath_eval</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

4
reference/domxml/functions/xptr-new-context.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id='function.xptr-new-context' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>xptr_new_context</refname>
@ -7,7 +7,7 @@
Create new XPath Context
</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>XPathContext</type><methodname>xptr_new_context</methodname>

36
reference/hw/functions/hw-children.xml
View file

@ -1,18 +1,46 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-children" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Children</refname>
<refpurpose>Object ids of children</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_children</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns the identifiers of the collection children.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object ids. Each id belongs to a child of the
collection with ID <parameter>objectID</parameter>.

41
reference/hw/functions/hw-childrenobj.xml
View file

@ -1,22 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-childrenobj" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_ChildrenObj</refname>
<refpurpose>Object records of children</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_childrenobj</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array of object records. Each object record
belongs to a child of the collection with ID
<parameter>objectID</parameter>.
Returns the object records of the collection children.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array of object records. Each object record belongs to a child
of the collection with ID <parameter>objectID</parameter>.
The array contains all children both documents and collections.
</para>
</refsect1>

37
reference/hw/functions/hw-document-attributes.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-document-attributes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_Attributes</refname>
<refpurpose>Object record of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_document_attributes</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
@ -19,9 +18,35 @@
For backward compatibility, <function>hw_documentattributes</function>
is also accepted. This is deprecated, however.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>hw_document_bodytag</function>,
and <function>hw_document_size</function>.
<variablelist>
<varlistentry>
<term><parameter>hw_document</parameter></term>
<listitem>
<para>
The document identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the object record of the document.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_document_bodytag</function></member>
<member><function>hw_document_size</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

39
reference/hw/functions/hw-document-content.xml
View file

@ -1,26 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-document-content" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_Content</refname>
<refpurpose>Returns content of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>hw_document_content</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Gets the content of the document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hw_document</parameter></term>
<listitem>
<para>
The document identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the content of the document. If the document is an HTML
document the content is everything after the BODY tag. Information
from the HEAD and BODY tag is in the stored in the object record.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>hw_document_attributes</function>,
<function>hw_document_size</function>,
and <function>hw_document_setcontent</function>.
<simplelist>
<member><function>hw_document_attributes</function></member>
<member><function>hw_document_size</function></member>
<member><function>hw_document_setcontent</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

42
reference/hw/functions/hw-document-size.xml
View file

@ -1,28 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-document-size" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Document_Size</refname>
<refpurpose>Size of hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>hw_document_size</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
</methodsynopsis>
<para>
Returns the size in bytes of the document.</para>
<para>
See also <function>hw_document_bodytag</function>,
and <function>hw_document_attributes</function>.
Gets the size of the document.
</para>
<para>
For backward compatibility, <function>hw_documentsize</function>
is also accepted. This is deprecated, however.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hw_document</parameter></term>
<listitem>
<para>
The document identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the size in bytes of the document.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hw_document_attributes</function></member>
<member><function>hw_document_bodytag</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

28
reference/hw/functions/hw-free-document.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.hw-free-document" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_Free_Document</refname>
<refpurpose>Frees hw_document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>hw_free_document</methodname>
<methodparam><type>int</type><parameter>hw_document</parameter></methodparam>
@ -16,6 +15,27 @@
Frees the memory occupied by the Hyperwave document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hw_document</parameter></term>
<listitem>
<para>
The document identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

40
reference/hw/functions/hw-getparents.xml
View file

@ -1,21 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.hw-getparents" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>hw_GetParents</refname>
<refpurpose>Object ids of parents</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>hw_getparents</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>objectID</parameter></methodparam>
</methodsynopsis>
<para>
Returns an indexed array of object ids. Each object id belongs to
a parent of the object with ID <parameter>objectID</parameter>.
Returns the object identifiers of the parents of an object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>objectID</parameter></term>
<listitem>
<para>
The object identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an indexed array of object ids. Each object id belongs to a parent
of the object with ID <parameter>objectID</parameter>.
</para>
</refsect1>
</refentry>

12
reference/stream/functions/stream-register-wrapper.xml
View file

@ -1,16 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.stream-register-wrapper" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stream_register_wrapper</refname>
<refpurpose>Alias of <function>stream_wrapper_register</function></refpurpose>
<refpurpose>&Alias; <function>stream_wrapper_register</function></refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<para>
This function is an alias of <function>stream_wrapper_register</function>.
This function is included for compatability with PHP 4.3.0 and PHP 4.3.1
only. <function>stream_wrapper_register</function> should be used instead.
&info.function.alias; <function>stream_wrapper_register</function>.
</para>
</refsect1>
</refentry>

26
reference/stream/functions/stream-wrapper-restore.xml
View file

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.stream-wrapper-restore" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stream_wrapper_restore</refname>
<refpurpose>Restores a previously unregistered built-in wrapper</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>stream_wrapper_restore</methodname>
<methodparam><type>string</type><parameter>protocol</parameter></methodparam>
@ -16,6 +16,26 @@
<function>stream_wrapper_unregister</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>protocol</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>

35
reference/stream/functions/stream-wrapper-unregister.xml
View file

@ -1,22 +1,41 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.stream-wrapper-unregister" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stream_wrapper_unregister</refname>
<refpurpose>Unregister a URL wrapper</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>stream_wrapper_unregister</methodname>
<methodparam><type>string</type><parameter>protocol</parameter></methodparam>
</methodsynopsis>
<para>
<function>stream_wrapper_unregister</function> allows you to
disable an already defined stream wrapper. Once the wrapper
has been disabled you may override it with a user-defined wrapper
using <function>stream_wrapper_register</function> or
reenable it later on with <function>stream_wrapper_restore</function>.
Allows you to disable an already defined stream wrapper. Once the wrapper
has been disabled you may override it with a user-defined wrapper using
<function>stream_wrapper_register</function> or reenable it later on with
<function>stream_wrapper_restore</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>protocol</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>

33
reference/tidy/functions/tidy-get-output.xml
View file

@ -1,20 +1,43 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-get-output" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_output</refname>
<refpurpose>Return a string representing the parsed tidy markup</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>tidy_get_output</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_get_output</function> returns a string with the repaired
html.
Gets a string with the repaired html.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>object</parameter></term>
<listitem>
<para>
The tidy object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the parsed tidy markup.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>tidy_get_output</function> example</title>

10
reference/tidy/functions/tidy-node-get-attr.xml
View file

@ -1,19 +1,17 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.tidy-node-get-attr" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->get_attr</refname>
<refpurpose>Return the attribute with the provided attribute id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>tidy_attr</type><methodname>tidy_node->get_attr</methodname>
<methodparam><type>int</type><parameter>attrib_id</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>

10
reference/tidy/functions/tidy-node-next.xml
View file

@ -1,19 +1,17 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.tidy-node-next" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->next</refname>
<refpurpose>Returns the next sibling to this node</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>tidy_node</type><methodname>tidy_node->next</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>

10
reference/tidy/functions/tidy-node-prev.xml
View file

@ -1,19 +1,17 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidy-node-prev" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->prev</refname>
<refpurpose>Returns the previous sibling to this node</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>tidy_node</type><methodname>tidy_node->prev</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>

17
reference/tidy/functions/tidy-reset-config.xml
View file

@ -1,12 +1,12 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-reset-config" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_reset_config</refname>
<refpurpose>Restore Tidy configuration to default values</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidy_reset_config</methodname>
<void/>
@ -14,7 +14,16 @@
<para>
This function restores the Tidy configuration to the default values.
</para>
&note.tidy.1only;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.tidy.1only;
</refsect1>
</refentry>

49
reference/tidy/functions/tidy-save-config.xml
View file

@ -1,27 +1,56 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-save-config" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_save_config</refname>
<refpurpose>Save current settings to named file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidy_save_config</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_save_config</function> saves current settings to the
specified file. Only non-default values are written.
Saves current settings to the specified file. Only non-default values are
written.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also <function>tidy_get_config</function>,
<function>tidy_getopt</function>,
<function>tidy_reset_config</function> and
<function>tidy_setopt</function>.
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Path to the config file.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.tidy.1only;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>tidy_get_config</function></member>
<member><function>tidy_getopt</function></member>
<member><function>tidy_reset_config</function></member>
<member><function>tidy_setopt</function></member>
</simplelist>
</para>
&note.tidy.1only;
</refsect1>
</refentry>

28
reference/uodbc/functions/odbc-close-all.xml
View file

@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.odbc-close-all" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_close_all</refname>
<refpurpose>Close all ODBC connections</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>odbc_close_all</methodname>
<void/>
@ -15,14 +14,23 @@
<para>
<function>odbc_close_all</function> will close down all
connections to database server(s).
<note>
<simpara>
This function will fail if there are open transactions on a
connection. This connection will remain open in this case.
</simpara>
</note>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function will fail if there are open transactions on a connection.
This connection will remain open in this case.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

47
reference/uodbc/functions/odbc-close.xml
View file

@ -1,29 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.odbc-close" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_close</refname>
<refpurpose>Close an ODBC connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>odbc_close</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
</methodsynopsis>
<para>
<function>odbc_close</function> will close down the connection to
the database server associated with the given connection
identifier.
<note>
<simpara>
This function will fail if there are open transactions on this
connection. The connection will remain open in this case.
</simpara>
</note>
Closes down the connection to the database server.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection_id</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function will fail if there are open transactions on this
connection. The connection will remain open in this case.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

31
reference/uodbc/functions/odbc-commit.xml
View file

@ -1,20 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.odbc-commit" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_commit</refname>
<refpurpose>Commit an ODBC transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>odbc_commit</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
</methodsynopsis>
<para>
<function>odbc_commit</function> commits all pending transactions
on the <parameter>connection_id</parameter> connection. &return.success;
Commits all pending transactions on the connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection_id</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>

30
reference/uodbc/functions/odbc-cursor.xml
View file

@ -1,19 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.odbc-cursor" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_cursor</refname>
<refpurpose>Get cursorname</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>odbc_cursor</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
odbc_cursor will return a cursorname for the given result_id.
Gets the cursorname for the given result_id.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
The result identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the cursor name, as a string.
</para>
</refsect1>
</refentry>

18
reference/uodbc/functions/odbc-do.xml
View file

@ -1,21 +1,15 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.odbc-do" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_do</refname>
<refpurpose>Synonym for <function>odbc_exec</function></refpurpose>
<refpurpose>&Alias; <function>odbc_exec</function></refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>odbc_do</methodname>
<methodparam><type>resource</type><parameter>conn_id</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<para>
<function>odbc_do</function> will execute a query on the given
connection.
&info.function.alias;
<function>odbc_exec</function>.
</para>
</refsect1>
</refentry>

42
reference/uodbc/functions/odbc-field-name.xml
View file

@ -1,23 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.odbc-field-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_field_name</refname>
<refpurpose>Get the columnname</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>odbc_field_name</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<para>
<function>odbc_field_name</function> will return the name of the
field occupying the given column number in the given ODBC result
identifier. Field numbering starts at 1.
&false; is returned on error.
Gets the name of the field occupying the given column number in the given
result identifier.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
The result identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_number</parameter></term>
<listitem>
<para>
The field number. Field numbering starts at 1.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the field name as a string, or &false; on error.
</para>
</refsect1>
</refentry>

43
reference/uodbc/functions/odbc-field-num.xml
View file

@ -1,23 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.odbc-field-num" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_field_num</refname>
<refpurpose>Return column number</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>odbc_field_num</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam><type>string</type><parameter>field_name</parameter></methodparam>
</methodsynopsis>
<para>
<function>odbc_field_num</function> will return the number of the
column slot that corresponds to the named field in the given ODBC
result identifier. Field numbering starts at 1.
&false; is returned on error.
Gets the number of the column slot that corresponds to the named field in
the given result identifier.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
The result identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_name</parameter></term>
<listitem>
<para>
The field name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the field number as a integer, or &false; on error.
Field numbering starts at 1.
</para>
</refsect1>
</refentry>

28
reference/uodbc/functions/odbc-field-precision.xml
View file

@ -1,26 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.odbc-field-precision" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_field_precision</refname>
<refpurpose>Synonym for <function>odbc_field_len</function></refpurpose>
<refpurpose>&Alias; <function>odbc_field_len</function></refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>odbc_field_precision</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<para>
<function>odbc_field_precision</function> will return the precision
of the field referenced by number in the given ODBC result
identifier.
&info.function.alias;
<function>odbc_field_len</function>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also: <function>odbc_field_scale</function> to get the scale of a
floating point number.
<simplelist>
<member><function>odbc_field_scale</function> to get the scale of a
floating point number.</member>
</simplelist>
</para>
</refsect1>
</refentry>

39
reference/uodbc/functions/odbc-field-scale.xml
View file

@ -1,24 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.3 -->
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.odbc-field-scale" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_field_scale</refname>
<refpurpose>Get the scale of a field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>odbc_field_scale</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<para>
<function>odbc_field_scale</function> will return the scale
of the field referenced by number in the given ODBC result
Gets the scale of the field referenced by number in the given result
identifier.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
The result identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_number</parameter></term>
<listitem>
<para>
The field number. Field numbering starts at 1.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the field scale as a integer, or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

41
reference/uodbc/functions/odbc-field-type.xml
View file

@ -1,22 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.odbc-field-type" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_field_type</refname>
<refpurpose>Datatype of a field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>odbc_field_type</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<para>
<function>odbc_field_type</function> will return the SQL type of
the field referenced by number in the given ODBC result
identifier. Field numbering starts at 1.
Gets the SQL type of the field referenced by number in the given result
identifier.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
The result identifier.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_number</parameter></term>
<listitem>
<para>
The field number. Field numbering starts at 1.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the field type as a string, or &false; on error.
</para>
</refsect1>
</refentry>

33
reference/uodbc/functions/odbc-num-fields.xml
View file

@ -1,22 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.odbc-num-fields" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_num_fields</refname>
<refpurpose>Number of columns in a result</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>odbc_num_fields</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
<function>odbc_num_fields</function> will return the number of
fields (columns) in an ODBC result. This function will return -1
on error. The argument is a valid result identifier returned by
<function>odbc_exec</function>.
Gets the number of fields (columns) in an ODBC result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
The result identifier returned by <function>odbc_exec</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of fields, or -1 on error.
</para>
</refsect1>
</refentry>

33
reference/uodbc/functions/odbc-rollback.xml
View file

@ -1,22 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.odbc-rollback" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_rollback</refname>
<refpurpose>Rollback a transaction</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>odbc_rollback</methodname>
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
</methodsynopsis>
<para>
Rolls back all pending statements on
<parameter>connection_id</parameter>. Returns
&true; on success, &false; on
failure.
Rolls back all pending statements on the connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection_id</parameter></term>
<listitem>
<para>
The connection identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>