added documentation for the renumber 'feature' of array_shift and unshift

(bug #14791)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@85986 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2002-06-17 23:48:37 +00:00
parent d4987a894f
commit 1747b91508
2 changed files with 7 additions and 5 deletions

View file

@ -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.array-shift">
<refnamediv>
@ -18,8 +18,9 @@
<function>array_shift</function> shifts the first value of the
<parameter>array</parameter> off and returns it, shortening the
<parameter>array</parameter> by one element and moving everything
down. If <parameter>array</parameter> is empty (or is not an
array), &null; will be returned.
down. All numerical array keys will be modified to start counting from zero
while literal keys won't be touched. If <parameter>array</parameter> is empty
(or is not an array), &null; will be returned.
</para>
<para>
<example>

View file

@ -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.array-unshift">
<refnamediv>
@ -22,7 +22,8 @@
<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.
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>
<para>
Returns the new number of elements in the