php-doc-en/reference/spl/arrayiterator/key.xml
2014-09-05 07:44:07 +00:00

73 lines
1.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.key" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ArrayIterator::key</refname>
<refpurpose>Return current array key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>ArrayIterator::key</methodname>
<void/>
</methodsynopsis>
<para>
This function returns the current array key
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The current <type>array</type> key.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ArrayIterator::key</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$array = array('key' => 'value');
$arrayobject = new ArrayObject($array);
$iterator = $arrayobject->getIterator();
echo $iterator->key(); //key
?>
]]>
</programlisting>
</example>
</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:"~/.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
-->