mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Documentation for new functions in PHP5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@142099 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Andrey Hristov
parent
f27a13f34b
commit
909c25dafa
4 changed files with 500 additions and 0 deletions
110
reference/array/functions/array-diff-uassoc.xml
Normal file
110
reference/array/functions/array-diff-uassoc.xml
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- splitted from ./en/functions/array.xml, last change in rev 1.14 -->
|
||||
<refentry id="function.array-diff-uassoc">
|
||||
<refnamediv>
|
||||
<refname>array_diff_uassoc</refname>
|
||||
<refpurpose>Computes the difference of arrays with additional index check which is performed by a user supplied callback function.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>array_diff_assoc</methodname>
|
||||
<methodparam><type>array</type><parameter>array1</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>array2</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter> ...</parameter></methodparam>
|
||||
<methodparam><type>callback</type><parameter>key_compare_func</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>array_diff_uassoc</function> returns an <type>array</type>
|
||||
containing all the values from <parameter>array1</parameter>
|
||||
that are not present in any of the other arguments.
|
||||
Note that the keys are used in the comparison unlike
|
||||
<function>array_diff</function>. This comparison is done by a user supplied callback function.
|
||||
It must return an integer less than, equal
|
||||
to, or greater than zero if the first argument is considered to
|
||||
be respectively less than, equal to, or greater than the
|
||||
second. This is unlike <function>array_diff_assoc</function> where an
|
||||
internal function for comparing the indices is used.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>array_diff_uassoc</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
function key_compare_func($a, $b) {
|
||||
if ($a === $b) return 0;
|
||||
return ($a > $b)? 1:-1;
|
||||
}
|
||||
|
||||
$array1 = array("a" => "green", "b" => "brown", "c" => "blue", "red");
|
||||
$array2 = array("a" => "green", "yellow", "red");
|
||||
$result = array_diff_uassoc($array1, $array2, "key_compare_func");
|
||||
|
||||
/* The result is:
|
||||
Array
|
||||
(
|
||||
[b] => brown
|
||||
[c] => blue
|
||||
[0] => red
|
||||
)
|
||||
*/
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<simpara>
|
||||
In our example above you see the <literal>"a" => "green"</literal>
|
||||
pair is present in both arrays and thus it is not in the ouput from the
|
||||
function. Unlike this, the pair <literal>0 => "red"</literal>
|
||||
is in the ouput because in the second argument <literal>"red"</literal>
|
||||
has key which is <literal>1</literal>.
|
||||
</simpara>
|
||||
<simpara>
|
||||
The equality of 2 indices is checked by the user supplied callback function.
|
||||
</simpara>
|
||||
<note>
|
||||
<simpara>
|
||||
Please note that this function only checks one dimension of a n-dimensional
|
||||
array. Of course you can check deeper dimensions by using, for example,
|
||||
<literal>array_diff_uassoc($array1[0], $array2[0], "key_compare_func");</literal>.
|
||||
</simpara>
|
||||
</note>
|
||||
<para>
|
||||
See also
|
||||
<function>array_diff</function>,
|
||||
<function>array_diff_assoc</function>,
|
||||
<function>array_udiff</function>,
|
||||
<function>array_udiff_assoc</function>,
|
||||
<function>array_udiff_uassoc</function>,
|
||||
<function>array_intersect</function>,
|
||||
<function>array_intersect_assoc</function>,
|
||||
<function>array_uintersect</function>,
|
||||
<function>array_uintersect_assoc</function> and
|
||||
<function>array_uintersect_uassoc</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
130
reference/array/functions/array-udiff-assoc.xml
Normal file
130
reference/array/functions/array-udiff-assoc.xml
Normal file
|
|
@ -0,0 +1,130 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- splitted from ./en/functions/array.xml, last change in rev 1.14 -->
|
||||
<refentry id="function.array-udiff-assoc">
|
||||
<refnamediv>
|
||||
<refname>array_udiff_assoc</refname>
|
||||
<refpurpose>Computes the difference of arrays with additional index check. The data is compared by using a callback function.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>array_udiff_assoc</methodname>
|
||||
<methodparam><type>array</type><parameter>array1</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>array2</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter> ...</parameter></methodparam>
|
||||
<methodparam><type>callback</type><parameter>data_compare_func</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>array_udiff_assoc</function> returns an <type>array</type>
|
||||
containing all the values from <parameter>array1</parameter>
|
||||
that are not present in any of the other arguments.
|
||||
Note that the keys are used in the comparison unlike
|
||||
<function>array_diff</function> and <function>array_udiff</function>.
|
||||
The comparison of arrays' data is performed by using an user-supplied
|
||||
callback. In this aspect the behaviour is opposite to the behaviour of
|
||||
<function>array_diff_assoc</function> which uses internal function for
|
||||
comparison.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>array_udiff_assoc</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
class cr {
|
||||
private $priv_member;
|
||||
function cr($val) {
|
||||
$this->priv_member = $val;
|
||||
}
|
||||
static function comp_func_cr($a, $b) {
|
||||
if ($a->priv_member === $b->priv_member) return 0;
|
||||
return ($a->priv_member > $b->priv_member)? 1:-1;
|
||||
}
|
||||
}
|
||||
$a = array("0.1" => new cr(9), "0.5" => new cr(12), 0 => new cr(23), 1=> new cr(4), 2 => new cr(-15),);
|
||||
$b = array("0.2" => new cr(9), "0.5" => new cr(22), 0 => new cr( 3), 1=> new cr(4), 2 => new cr(-15),);
|
||||
|
||||
$result = array_udiff_assoc($a, $b, array("cr", "comp_func_cr"));
|
||||
print_r($result);
|
||||
?>
|
||||
|
||||
/* The result is:
|
||||
Array
|
||||
(
|
||||
[0.1] => cr Object
|
||||
(
|
||||
[priv_member:private] => 9
|
||||
)
|
||||
|
||||
[0.5] => cr Object
|
||||
(
|
||||
[priv_member:private] => 12
|
||||
)
|
||||
|
||||
[0] => cr Object
|
||||
(
|
||||
[priv_member:private] => 23
|
||||
)
|
||||
)
|
||||
*/
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<simpara>
|
||||
In our example above you see the <literal>"1" => new cr(4)</literal>
|
||||
pair is present in both arrays and thus it is not in the ouput from the
|
||||
function.
|
||||
</simpara>
|
||||
<simpara>
|
||||
For comparison is used the user supplied callback function.
|
||||
It must return an integer less than, equal
|
||||
to, or greater than zero if the first argument is considered to
|
||||
be respectively less than, equal to, or greater than the
|
||||
second.
|
||||
</simpara>
|
||||
<note>
|
||||
<simpara>
|
||||
Please note that this function only checks one dimension of a n-dimensional
|
||||
array. Of course you can check deeper dimensions by using, for example,
|
||||
<literal>array_udiff_assoc($array1[0], $array2[0], "some_comparison_func");</literal>.
|
||||
</simpara>
|
||||
</note>
|
||||
<para>
|
||||
See also
|
||||
<function>array_diff</function>,
|
||||
<function>array_diff_assoc</function>,
|
||||
<function>array_diff_uassoc</function>,
|
||||
<function>array_udiff</function>,
|
||||
<function>array_udiff_uassoc</function>,
|
||||
<function>array_intersect</function>,
|
||||
<function>array_intersect_assoc</function>,
|
||||
<function>array_uintersect</function>,
|
||||
<function>array_uintersect_assoc</function> and
|
||||
<function>array_uintersect_uassoc</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
139
reference/array/functions/array-udiff-uassoc.xml
Normal file
139
reference/array/functions/array-udiff-uassoc.xml
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- splitted from ./en/functions/array.xml, last change in rev 1.14 -->
|
||||
<refentry id="function.array-udiff-assoc">
|
||||
<refnamediv>
|
||||
<refname>array_udiff_uassoc</refname>
|
||||
<refpurpose>Computes the difference of arrays with additional index check. The data is compared by using a callback function. The index check is done by a callback function also</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>array_udiff_uassoc</methodname>
|
||||
<methodparam><type>array</type><parameter>array1</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>array2</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter> ...</parameter></methodparam>
|
||||
<methodparam><type>callback</type><parameter>data_compare_func</parameter></methodparam>
|
||||
<methodparam><type>callback</type><parameter>key_compare_func</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>array_udiff_uassoc</function> returns an <type>array</type>
|
||||
containing all the values from <parameter>array1</parameter>
|
||||
that are not present in any of the other arguments.
|
||||
Note that the keys are used in the comparison unlike
|
||||
<function>array_diff</function> and <function>array_udiff</function>.
|
||||
The comparison of arrays' data is performed by using an user-supplied
|
||||
callback : <parameter>data_compare_func</parameter>. In this aspect
|
||||
the behaviour is opposite to the behaviour of
|
||||
<function>array_diff_assoc</function> which uses internal function for
|
||||
comparison. The comparison of keys (indices) is done also by the
|
||||
callback function <parameter>key_compare_func</parameter>. This
|
||||
behaviour is unlike what <function>array_udiff_assoc</function> does, since
|
||||
the latter compares the indices by using an internal function.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>array_udiff_uassoc</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
class cr {
|
||||
private $priv_member;
|
||||
function cr($val) {
|
||||
$this->priv_member = $val;
|
||||
}
|
||||
static function comp_func_cr($a, $b) {
|
||||
if ($a->priv_member === $b->priv_member) return 0;
|
||||
return ($a->priv_member > $b->priv_member)? 1:-1;
|
||||
}
|
||||
static function comp_func_key($a, $b) {
|
||||
if ($a === $b) return 0;
|
||||
return ($a > $b)? 1:-1;
|
||||
}
|
||||
}
|
||||
$a = array("0.1" => new cr(9), "0.5" => new cr(12), 0 => new cr(23), 1=> new cr(4), 2 => new cr(-15),);
|
||||
$b = array("0.2" => new cr(9), "0.5" => new cr(22), 0 => new cr( 3), 1=> new cr(4), 2 => new cr(-15),);
|
||||
|
||||
$result = array_udiff_uassoc($a, $b, array("cr", "comp_func_cr"), array("cr","comp_func_key"));
|
||||
print_r($result);
|
||||
?>
|
||||
|
||||
/* The result is:
|
||||
Array
|
||||
(
|
||||
[0.1] => cr Object
|
||||
(
|
||||
[priv_member:private] => 9
|
||||
)
|
||||
|
||||
[0.5] => cr Object
|
||||
(
|
||||
[priv_member:private] => 12
|
||||
)
|
||||
|
||||
[0] => cr Object
|
||||
(
|
||||
[priv_member:private] => 23
|
||||
)
|
||||
)
|
||||
*/
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<simpara>
|
||||
In our example above you see the <literal>"1" => new cr(4)</literal>
|
||||
pair is present in both arrays and thus it is not in the ouput from the
|
||||
function. Keep in mind that you have to supply 2 callback functions.
|
||||
</simpara>
|
||||
<simpara>
|
||||
For comparison is used the user supplied callback function.
|
||||
It must return an integer less than, equal
|
||||
to, or greater than zero if the first argument is considered to
|
||||
be respectively less than, equal to, or greater than the
|
||||
second.
|
||||
</simpara>
|
||||
<note>
|
||||
<simpara>
|
||||
Please note that this function only checks one dimension of a n-dimensional
|
||||
array. Of course you can check deeper dimensions by using, for example,
|
||||
<literal>array_udiff_assoc($array1[0], $array2[0], "some_comparison_func");</literal>.
|
||||
</simpara>
|
||||
</note>
|
||||
<para>
|
||||
See also
|
||||
<function>array_diff</function>,
|
||||
<function>array_diff_assoc</function>,
|
||||
<function>array_diff_uassoc</function>,
|
||||
<function>array_udiff</function>,
|
||||
<function>array_udiff_assoc</function>,
|
||||
<function>array_intersect</function>,
|
||||
<function>array_intersect_assoc</function>,
|
||||
<function>array_uintersect</function>,
|
||||
<function>array_uintersect_assoc</function> and
|
||||
<function>array_uintersect_uassoc</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
121
reference/array/functions/array-udiff.xml
Normal file
121
reference/array/functions/array-udiff.xml
Normal file
|
|
@ -0,0 +1,121 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- splitted from ./en/functions/array.xml, last change in rev 1.14 -->
|
||||
<refentry id="function.array-udiff">
|
||||
<refnamediv>
|
||||
<refname>array_udiff</refname>
|
||||
<refpurpose>Computes the difference of arrays by using callback function for data comparison.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>array_udiff</methodname>
|
||||
<methodparam><type>array</type><parameter>array1</parameter></methodparam>
|
||||
<methodparam><type>array</type><parameter>array2</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array</type><parameter> ...</parameter></methodparam>
|
||||
<methodparam><type>callback</type><parameter>data_compare_func</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>array_udiff</function> returns an array
|
||||
containing all the values of <parameter>array1</parameter>
|
||||
that are not present in any of the other arguments.
|
||||
Note that keys are preserved. For the comparison of the data
|
||||
<parameter>data_compare_function</parameter> is used.
|
||||
It must return an integer less than, equal
|
||||
to, or greater than zero if the first argument is considered to
|
||||
be respectively less than, equal to, or greater than the
|
||||
second. This is unlike <function>array_diff</function> which uses an
|
||||
internal function for comparing the data.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>array_udiff</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
class cr {
|
||||
private $priv_member;
|
||||
function cr($val) {
|
||||
$this->priv_member = $val;
|
||||
}
|
||||
static function comp_func_cr($a, $b) {
|
||||
if ($a->priv_member === $b->priv_member) return 0;
|
||||
return ($a->priv_member > $b->priv_member)? 1:-1;
|
||||
}
|
||||
}
|
||||
$a = array("0.1" => new cr(9), "0.5" => new cr(12), 0 => new cr(23), 1=> new cr(4), 2 => new cr(-15),);
|
||||
$b = array("0.2" => new cr(9), "0.5" => new cr(22), 0 => new cr( 3), 1=> new cr(4), 2 => new cr(-15),);
|
||||
|
||||
$result = array_udiff($a, $b, array("cr", "comp_func_cr"));
|
||||
print_r($result);
|
||||
|
||||
/* The result is:
|
||||
Array
|
||||
(
|
||||
[0.5] => cr Object
|
||||
(
|
||||
[priv_member:private] => 12
|
||||
)
|
||||
|
||||
[0] => cr Object
|
||||
(
|
||||
[priv_member:private] => 23
|
||||
)
|
||||
|
||||
)
|
||||
*/
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<note>
|
||||
<simpara>
|
||||
Two elements are considered equal if and only if
|
||||
<literal>(string) $elem1 === (string) $elem2</literal>. In words:
|
||||
when the string representation is the same.
|
||||
</simpara>
|
||||
</note>
|
||||
<note>
|
||||
<simpara>
|
||||
Please note that this function only checks one dimension of a n-dimensional
|
||||
array. Of course you can check deeper dimensions by using
|
||||
<literal>array_udiff($array1[0], $array2[0], "data_compare_func");</literal>.
|
||||
</simpara>
|
||||
</note>
|
||||
<para>
|
||||
See also
|
||||
<function>array_diff</function>,
|
||||
<function>array_diff_assoc</function>,
|
||||
<function>array_diff_uassoc</function>,
|
||||
<function>array_udiff_assoc</function>,
|
||||
<function>array_udiff_uassoc</function>,
|
||||
<function>array_intersect</function>,
|
||||
<function>array_intersect_assoc</function>,
|
||||
<function>array_uintersect</function>,
|
||||
<function>array_uintersect_assoc</function> and
|
||||
<function>array_uintersect_uassoc</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:1
|
||||
sgml-indent-data:t
|
||||
indent-tabs-mode:nil
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
Loading…
Reference in a new issue