php-doc-en/reference/array/constants.xml
Tjerk Anne Meesters 27acde0b15 Added documentation for PR :
- add ability to use array keys with array_filter()



git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334988 c90b9560-bf6c-de11-be94-00142212c4b1
2014-09-26 16:17:15 +00:00

307 lines
7.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="array.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants.core;
<para>
<variablelist>
<varlistentry xml:id="constant.case-lower">
<term>
<constant>CASE_LOWER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>CASE_LOWER</constant> is used with
<function>array_change_key_case</function> and is used to convert array
keys to lower case. This is also the default case for
<function>array_change_key_case</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.case-upper">
<term>
<constant>CASE_UPPER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>CASE_UPPER</constant> is used with
<function>array_change_key_case</function> and is used to convert array
keys to upper case.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para> Sorting order flags:
<variablelist>
<varlistentry xml:id="constant.sort-asc">
<term>
<constant>SORT_ASC</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>SORT_ASC</constant> is used with
<function>array_multisort</function> to sort in ascending order.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sort-desc">
<term>
<constant>SORT_DESC</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>SORT_DESC</constant> is used with
<function>array_multisort</function> to sort in descending order.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para> Sorting type flags: used by various sort functions
<variablelist>
<varlistentry xml:id="constant.sort-regular">
<term>
<constant>SORT_REGULAR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>SORT_REGULAR</constant> is used to compare items normally.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sort-numeric">
<term>
<constant>SORT_NUMERIC</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>SORT_NUMERIC</constant> is used to compare items numerically.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sort-string">
<term>
<constant>SORT_STRING</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>SORT_STRING</constant> is used to compare items as strings.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sort-locale-string">
<term>
<constant>SORT_LOCALE_STRING</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>SORT_LOCALE_STRING</constant> is used to compare items as
strings, based on the current locale. Added in PHP 4.4.0 and 5.0.2.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sort-natural">
<term>
<constant>SORT_NATURAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>SORT_NATURAL</constant> is used to compare items as
strings using "natural ordering" like <function>natsort</function>. Added in PHP 5.4.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sort-flag-case">
<term>
<constant>SORT_FLAG_CASE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>SORT_FLAG_CASE</constant> can be combined
(bitwise OR) with
<constant>SORT_STRING</constant> or
<constant>SORT_NATURAL</constant> to sort strings case-insensitively. Added in PHP 5.4.0.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para> Filter flags:
<variablelist>
<varlistentry xml:id="constant.array-filter-use-key">
<term>
<constant>ARRAY_FILTER_USE_KEY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>ARRAY_FILTER_USE_KEY</constant> is used with
<function>array_filter</function> to pass each key as the first argument to the given callback function.
Added in PHP 5.6.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.array-filter-use-both">
<term>
<constant>ARRAY_FILTER_USE_BOTH</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
<constant>ARRAY_FILTER_USE_BOTH</constant> is used with
<function>array_filter</function> to pass both value and key to the given callback function.
Added in PHP 5.6.0.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry xml:id="constant.count-normal">
<term>
<constant>COUNT_NORMAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.count-recursive">
<term>
<constant>COUNT_RECURSIVE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.extr-overwrite">
<term>
<constant>EXTR_OVERWRITE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.extr-skip">
<term>
<constant>EXTR_SKIP</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.extr-prefix-same">
<term>
<constant>EXTR_PREFIX_SAME</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.extr-prefix-all">
<term>
<constant>EXTR_PREFIX_ALL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.extr-prefix-invalid">
<term>
<constant>EXTR_PREFIX_INVALID</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.extr-prefix-if-exists">
<term>
<constant>EXTR_PREFIX_IF_EXISTS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.extr-if-exists">
<term>
<constant>EXTR_IF_EXISTS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.extr-refs">
<term>
<constant>EXTR_REFS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</appendix>
<!-- 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:"~/.phpdoc/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
-->