mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
81ee02feed
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322381 c90b9560-bf6c-de11-be94-00142212c4b1
105 lines
2.5 KiB
XML
105 lines
2.5 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="arrayobject.setiteratorclass" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ArrayObject::setIteratorClass</refname>
|
|
<refpurpose>Sets the iterator classname for the ArrayObject.</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::setIteratorClass</methodname>
|
|
<methodparam><type>string</type><parameter>iterator_class</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets the classname of the array iterator that is used by
|
|
<link linkend="arrayobject.getiterator">ArrayObject::getIterator()</link>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>iterator_class</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The classname of the array iterator to use when iterating over this object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>ArrayObject::setIteratorClass</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Custom ArrayIterator (inherits from ArrayIterator)
|
|
class MyArrayIterator extends ArrayIterator {
|
|
// custom implementation
|
|
}
|
|
|
|
// Array of available fruits
|
|
$fruits = array("lemons" => 1, "oranges" => 4, "bananas" => 5, "apples" => 10);
|
|
|
|
$fruitsArrayObject = new ArrayObject($fruits);
|
|
|
|
// Set the iterator classname to the newly
|
|
$fruitsArrayObject->setIteratorClass('MyArrayIterator');
|
|
print_r($fruitsArrayObject->getIterator());
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
MyArrayIterator Object
|
|
(
|
|
[lemons] => 1
|
|
[oranges] => 4
|
|
[bananas] => 5
|
|
[apples] => 10
|
|
)
|
|
]]>
|
|
</screen>
|
|
</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
|
|
-->
|