Document the fact that key() returns NULL when the array pointer is out of bounds.

Addresses Bug #47330.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@287789 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Torben Wilson 2009-08-27 04:48:24 +00:00
parent e99cfa6a1a
commit 9bd06a0d9d

View file

@ -35,7 +35,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the index.
The <function>key</function> function simply returns the
key 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 or the array is
empty, <function>key</function> returns &null;.
</para>
</refsect1>
<refsect1 role="examples">