mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
143 lines
3.8 KiB
XML
143 lines
3.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<phpdoc:classref xml:id="class.splqueue" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<title>The SplQueue class</title>
|
|
<titleabbrev>SplQueue</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<!-- {{{ splqueue intro -->
|
|
<section xml:id="splqueue.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
The SplQueue class provides the main functionalities of a queue implemented using a doubly linked list by
|
|
setting the iterator mode to <constant>SplDoublyLinkedList::IT_MODE_FIFO</constant>.
|
|
</para>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
<section xml:id="splqueue.synopsis">
|
|
&reftitle.classsynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis>
|
|
<ooclass>
|
|
<classname>SplQueue</classname>
|
|
</ooclass>
|
|
|
|
<classsynopsisinfo>
|
|
<ooclass>
|
|
<classname>SplQueue</classname>
|
|
</ooclass>
|
|
|
|
<ooclass>
|
|
<modifier>extends</modifier>
|
|
<classname>SplDoublyLinkedList</classname>
|
|
</ooclass>
|
|
</classsynopsisinfo>
|
|
|
|
<classsynopsisinfo role="comment">&InheritedConstants;</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spldoublylinkedlist')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Constants;']]))">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
|
|
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splqueue')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SplQueue'])">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
|
|
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.spldoublylinkedlist')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SplDoublyLinkedList'])">
|
|
<xi:fallback/>
|
|
</xi:include>
|
|
</classsynopsis>
|
|
</section>
|
|
|
|
<!-- {{{ splqueue properties
|
|
<section xml:id="splqueue.props">
|
|
&reftitle.properties;
|
|
<variablelist>
|
|
<varlistentry xml:id="splqueue.props.name">
|
|
<term><varname>name</varname></term>
|
|
<listitem>
|
|
<para>Prop description</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
}}} -->
|
|
|
|
<section role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><classname>SplQueue</classname> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$q = new SplQueue();
|
|
$q[] = 1;
|
|
$q[] = 2;
|
|
$q[] = 3;
|
|
foreach ($q as $elem) {
|
|
echo $elem."\n";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
1
|
|
2
|
|
3
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title>Efficiently handling tasks with <classname>SplQueue</classname></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$q = new SplQueue();
|
|
$q->setIteratorMode(SplQueue::IT_MODE_DELETE);
|
|
// ... enqueue some tasks on the queue ...
|
|
// process them
|
|
foreach ($q as $task) {
|
|
// ... process $task ...
|
|
// add new tasks on the queue
|
|
$q[] = $newTask;
|
|
// ...
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</section>
|
|
</partintro>
|
|
|
|
&reference.spl.entities.splqueue;
|
|
|
|
</phpdoc:classref>
|
|
<!-- 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
|
|
-->
|