<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The SplDoublyLinkedList class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="spl.datastructures.html">Datastructures</a></div>
<div class="next" style="text-align: right; float: right;"><a href="spldoublylinkedlist.bottom.html">SplDoublyLinkedList::bottom</a></div>
<div class="up"><a href="spl.datastructures.html">Datastructures</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.spldoublylinkedlist" class="reference">
<h1 class="title">The SplDoublyLinkedList class</h1>
<div class="partintro"><p class="verinfo">(PHP 5 >= 5.3.0)</p>
<div class="section" id="spldoublylinkedlist.intro">
<h2 class="title">Introduction</h2>
<p class="para">
The SplDoublyLinkedList class provides the main functionalities of a doubly linked list.
</p>
</div>
<div class="section" id="spldoublylinkedlist.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">SplDoublyLinkedList</strong>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.iterator.html" class="interfacename">Iterator</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.arrayaccess.html" class="interfacename">ArrayAccess</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.countable.html" class="interfacename">Countable</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="constructorsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="spldoublylinkedlist.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="spldoublylinkedlist.bottom.html" class="methodname">bottom</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="spldoublylinkedlist.count.html" class="methodname">count</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="spldoublylinkedlist.current.html" class="methodname">current</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="spldoublylinkedlist.getiteratormode.html" class="methodname">getIteratorMode</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="spldoublylinkedlist.isempty.html" class="methodname">isEmpty</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="spldoublylinkedlist.key.html" class="methodname">key</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spldoublylinkedlist.next.html" class="methodname">next</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="spldoublylinkedlist.offsetexists.html" class="methodname">offsetExists</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$index</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="spldoublylinkedlist.offsetget.html" class="methodname">offsetGet</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$index</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spldoublylinkedlist.offsetset.html" class="methodname">offsetSet</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$index</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$newval</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spldoublylinkedlist.offsetunset.html" class="methodname">offsetUnset</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$index</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="spldoublylinkedlist.pop.html" class="methodname">pop</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spldoublylinkedlist.prev.html" class="methodname">prev</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spldoublylinkedlist.push.html" class="methodname">push</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spldoublylinkedlist.rewind.html" class="methodname">rewind</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="spldoublylinkedlist.serialize.html" class="methodname">serialize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spldoublylinkedlist.setiteratormode.html" class="methodname">setIteratorMode</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="spldoublylinkedlist.shift.html" class="methodname">shift</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="spldoublylinkedlist.top.html" class="methodname">top</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spldoublylinkedlist.unserialize.html" class="methodname">unserialize</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$serialized</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="spldoublylinkedlist.unshift.html" class="methodname">unshift</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="spldoublylinkedlist.valid.html" class="methodname">valid</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="spldoublylinkedlist.bottom.html">SplDoublyLinkedList::bottom</a> — Peeks at the node from the beginning of the doubly linked list</li><li><a href="spldoublylinkedlist.construct.html">SplDoublyLinkedList::__construct</a> — Constructs a new doubly linked list</li><li><a href="spldoublylinkedlist.count.html">SplDoublyLinkedList::count</a> — Counts the number of elements in the doubly linked list.</li><li><a href="spldoublylinkedlist.current.html">SplDoublyLinkedList::current</a> — Return current array entry</li><li><a href="spldoublylinkedlist.getiteratormode.html">SplDoublyLinkedList::getIteratorMode</a> — Returns the mode of iteration</li><li><a href="spldoublylinkedlist.isempty.html">SplDoublyLinkedList::isEmpty</a> — Checks whether the doubly linked list is empty.</li><li><a href="spldoublylinkedlist.key.html">SplDoublyLinkedList::key</a> — Return current node index</li><li><a href="spldoublylinkedlist.next.html">SplDoublyLinkedList::next</a> — Move to next entry</li><li><a href="spldoublylinkedlist.offsetexists.html">SplDoublyLinkedList::offsetExists</a> — Returns whether the requested $index exists</li><li><a href="spldoublylinkedlist.offsetget.html">SplDoublyLinkedList::offsetGet</a> — Returns the value at the specified $index</li><li><a href="spldoublylinkedlist.offsetset.html">SplDoublyLinkedList::offsetSet</a> — Sets the value at the specified $index to $newval</li><li><a href="spldoublylinkedlist.offsetunset.html">SplDoublyLinkedList::offsetUnset</a> — Unsets the value at the specified $index</li><li><a href="spldoublylinkedlist.pop.html">SplDoublyLinkedList::pop</a> — Pops a node from the end of the doubly linked list</li><li><a href="spldoublylinkedlist.prev.html">SplDoublyLinkedList::prev</a> — Move to previous entry</li><li><a href="spldoublylinkedlist.push.html">SplDoublyLinkedList::push</a> — Pushes an element at the end of the doubly linked list</li><li><a href="spldoublylinkedlist.rewind.html">SplDoublyLinkedList::rewind</a> — Rewind iterator back to the start</li><li><a href="spldoublylinkedlist.serialize.html">SplDoublyLinkedList::serialize</a> — Serializes the storage</li><li><a href="spldoublylinkedlist.setiteratormode.html">SplDoublyLinkedList::setIteratorMode</a> — Sets the mode of iteration</li><li><a href="spldoublylinkedlist.shift.html">SplDoublyLinkedList::shift</a> — Shifts a node from the beginning of the doubly linked list</li><li><a href="spldoublylinkedlist.top.html">SplDoublyLinkedList::top</a> — Peeks at the node from the end of the doubly linked list</li><li><a href="spldoublylinkedlist.unserialize.html">SplDoublyLinkedList::unserialize</a> — Unserializes the storage</li><li><a href="spldoublylinkedlist.unshift.html">SplDoublyLinkedList::unshift</a> — Prepends the doubly linked list with an element</li><li><a href="spldoublylinkedlist.valid.html">SplDoublyLinkedList::valid</a> — Check whether the doubly linked list contains more nodes</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="spl.datastructures.html">Datastructures</a></div>
<div class="next" style="text-align: right; float: right;"><a href="spldoublylinkedlist.bottom.html">SplDoublyLinkedList::bottom</a></div>
<div class="up"><a href="spl.datastructures.html">Datastructures</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
