mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Properly document the word "element" as an array key/value pair, and "value"
as the value. This almost closes bug #20394 git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@135353 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
parent
de3748e109
commit
db8088a4bc
4 changed files with 64 additions and 12 deletions
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.current">
|
||||
<refnamediv>
|
||||
|
@ -19,8 +19,8 @@
|
|||
</para>
|
||||
<para>
|
||||
The <function>current</function> function simply returns the
|
||||
array element that's currently being pointed by the internal
|
||||
pointer. It does not move the pointer in any way. If the
|
||||
value of the array element that's currently being pointed to by the
|
||||
internal pointer. It does not move the pointer in any way. If the
|
||||
internal pointer points beyond the end of the elements list,
|
||||
<function>current</function> returns &false;.
|
||||
<warning>
|
||||
|
@ -35,6 +35,24 @@
|
|||
</para>
|
||||
</warning>
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>Example use of <function>current</function> and friends</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$transport = array('foot', 'bike', 'car', 'plane');
|
||||
$mode = current($transport); // $mode = 'foot';
|
||||
$mode = next($transport); // $mode = 'bike';
|
||||
$mode = current($transport); // $mode = 'bike';
|
||||
$mode = prev($transport); // $mode = 'foot';
|
||||
$mode = end($transport); // $mode = 'plane';
|
||||
$mode = current($transport); // $mode = 'plane';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
See also <function>end</function>, <function>key</function>,
|
||||
<function>next</function>, <function>prev</function>, and
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.end">
|
||||
<refnamediv>
|
||||
|
@ -16,7 +16,8 @@
|
|||
</methodsynopsis>
|
||||
<para>
|
||||
<function>end</function> advances <parameter>array</parameter>'s
|
||||
internal pointer to the last element, and returns that element.
|
||||
internal pointer to the last element, and returns the value from
|
||||
the last element.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.next">
|
||||
<refnamediv>
|
||||
|
@ -15,15 +15,14 @@
|
|||
<methodparam><type>array</type><parameter>array</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns the array element in the next place that's pointed by the
|
||||
internal array pointer, or &false; if
|
||||
there are no more elements.
|
||||
Returns the array value in the next place that's pointed to by the
|
||||
internal array pointer, or &false; if there are no more elements.
|
||||
</para>
|
||||
<para>
|
||||
<function>next</function> behaves like
|
||||
<function>current</function>, with one difference. It advances
|
||||
the internal array pointer one place forward before returning the
|
||||
element. That means it returns the next array element and
|
||||
element value. That means it returns the next array value and
|
||||
advances the internal array pointer by one. If advancing the
|
||||
internal array pointer results in going beyond the end of the
|
||||
element list, <function>next</function> returns &false;.
|
||||
|
@ -37,6 +36,23 @@
|
|||
</para>
|
||||
</warning>
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>Example use of <function>next</function> and friends</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$transport = array('foot', 'bike', 'car', 'plane');
|
||||
$mode = current($transport); // $mode = 'foot';
|
||||
$mode = next($transport); // $mode = 'bike';
|
||||
$mode = next($transport); // $mode = 'car';
|
||||
$mode = prev($transport); // $mode = 'bike';
|
||||
$mode = end($transport); // $mode = 'plane';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
See also
|
||||
<function>current</function>, <function>end</function>,
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.prev">
|
||||
<refnamediv>
|
||||
|
@ -13,7 +13,7 @@
|
|||
<methodparam><type>array</type><parameter>array</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Returns the array element in the previous place that's pointed by
|
||||
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.
|
||||
<warning>
|
||||
|
@ -30,6 +30,23 @@
|
|||
<function>next</function>, except it rewinds the internal array
|
||||
pointer one place instead of advancing it.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>Example use of <function>prev</function> and friends</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$transport = array('foot', 'bike', 'car', 'plane');
|
||||
$mode = current($transport); // $mode = 'foot';
|
||||
$mode = next($transport); // $mode = 'bike';
|
||||
$mode = next($transport); // $mode = 'car';
|
||||
$mode = prev($transport); // $mode = 'bike';
|
||||
$mode = end($transport); // $mode = 'plane';
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
See also <function>current</function>, <function>end</function>,
|
||||
<function>next</function>, and <function>reset</function>.
|
||||
|
|
Loading…
Reference in a new issue