mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
e3b9788fa7
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328297 c90b9560-bf6c-de11-be94-00142212c4b1
120 lines
2.7 KiB
XML
120 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="appenditerator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>AppendIterator::key</refname>
|
|
<refpurpose>Gets the current key</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>scalar</type><methodname>AppendIterator::key</methodname>
|
|
<void />
|
|
</methodsynopsis>
|
|
<para>
|
|
Get the current key.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The current key if it is valid or &null; otherwise.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples"><!-- {{{ -->
|
|
&reftitle.examples;
|
|
<para>
|
|
<example xml:id="appenditerator.key.examples.basic"><!-- {{{ -->
|
|
<title><methodname>AppendIterator::key</methodname> basic example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$array_a = new ArrayIterator(array('a' => 'aardwolf', 'b' => 'bear', 'c' => 'capybara'));
|
|
$array_b = new ArrayIterator(array('apple', 'orange', 'lemon'));
|
|
|
|
$iterator = new AppendIterator;
|
|
$iterator->append($array_a);
|
|
$iterator->append($array_b);
|
|
|
|
// Manual iteration
|
|
$iterator->rewind();
|
|
while ($iterator->valid()) {
|
|
echo $iterator->key() . ' ' . $iterator->current() . PHP_EOL;
|
|
$iterator->next();
|
|
}
|
|
|
|
echo PHP_EOL;
|
|
|
|
// With foreach
|
|
foreach ($iterator as $key => $current) {
|
|
echo $key . ' ' . $current . PHP_EOL;
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
a aardwolf
|
|
b bear
|
|
c capybara
|
|
0 apple
|
|
1 orange
|
|
2 lemon
|
|
|
|
a aardwolf
|
|
b bear
|
|
c capybara
|
|
0 apple
|
|
1 orange
|
|
2 lemon
|
|
]]>
|
|
</screen>
|
|
</example><!-- }}} -->
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>Iterator::key</methodname></member>
|
|
<member><methodname>AppendIterator::current</methodname></member>
|
|
<member><methodname>AppendIterator::valid</methodname></member>
|
|
<member><methodname>AppendIterator::next</methodname></member>
|
|
<member><methodname>AppendIterator::rewind</methodname></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|