<!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 SplObjectStorage class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="splfixedarray.wakeup.html">SplFixedArray::__wakeup</a></div>
<div class="next" style="text-align: right; float: right;"><a href="splobjectstorage.addall.html">SplObjectStorage::addAll</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.splobjectstorage" class="reference">
<h1 class="title">The SplObjectStorage class</h1>
<div class="partintro"><p class="verinfo">(PHP 5 >= 5.3.0)</p>
<div class="section" id="splobjectstorage.intro">
<h2 class="title">Introduction</h2>
<p class="para">
The SplObjectStorage class provides a map from objects to data or, by
ignoring data, an object set. This dual purpose can be useful in many
cases involving the need to uniquely identify objects.
</p>
</div>
<div class="section" id="splobjectstorage.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">SplObjectStorage</strong>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.countable.html" class="interfacename">Countable</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.iterator.html" class="interfacename">Iterator</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.arrayaccess.html" class="interfacename">ArrayAccess</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splobjectstorage.addall.html" class="methodname">addAll</a></span>
( <span class="methodparam"><span class="type"><a href="class.splobjectstorage.html" class="type SplObjectStorage">SplObjectStorage</a></span> <code class="parameter">$storage</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splobjectstorage.attach.html" class="methodname">attach</a></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$object</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">$data</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="splobjectstorage.contains.html" class="methodname">contains</a></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$object</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splobjectstorage.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">object</span> <span class="methodname"><a href="splobjectstorage.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">void</span> <span class="methodname"><a href="splobjectstorage.detach.html" class="methodname">detach</a></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$object</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="splobjectstorage.gethash.html" class="methodname">getHash</a></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$object</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="splobjectstorage.getinfo.html" class="methodname">getInfo</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="splobjectstorage.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="splobjectstorage.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="splobjectstorage.offsetexists.html" class="methodname">offsetExists</a></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$object</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="splobjectstorage.offsetget.html" class="methodname">offsetGet</a></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$object</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splobjectstorage.offsetset.html" class="methodname">offsetSet</a></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$object</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">$data</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splobjectstorage.offsetunset.html" class="methodname">offsetUnset</a></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$object</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splobjectstorage.removeall.html" class="methodname">removeAll</a></span>
( <span class="methodparam"><span class="type"><a href="class.splobjectstorage.html" class="type SplObjectStorage">SplObjectStorage</a></span> <code class="parameter">$storage</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splobjectstorage.removeallexcept.html" class="methodname">removeAllExcept</a></span>
( <span class="methodparam"><span class="type"><a href="class.splobjectstorage.html" class="type SplObjectStorage">SplObjectStorage</a></span> <code class="parameter">$storage</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splobjectstorage.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="splobjectstorage.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="splobjectstorage.setinfo.html" class="methodname">setInfo</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">$data</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splobjectstorage.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">bool</span> <span class="methodname"><a href="splobjectstorage.valid.html" class="methodname">valid</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
<div class="section" id="splobjectstorage.examples">
<h2 class="title">Examples</h2>
<p class="para">
<div class="example" id="example-3807">
<p><strong>Example #1 <strong class="classname">SplObjectStorage</strong> as a set</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// As an object set<br /></span><span style="color: #0000BB">$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">SplObjectStorage</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$o1 </span><span style="color: #007700">= new </span><span style="color: #0000BB">StdClass</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$o2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">StdClass</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$o3 </span><span style="color: #007700">= new </span><span style="color: #0000BB">StdClass</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">attach</span><span style="color: #007700">(</span><span style="color: #0000BB">$o1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">attach</span><span style="color: #007700">(</span><span style="color: #0000BB">$o2</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">contains</span><span style="color: #007700">(</span><span style="color: #0000BB">$o1</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">contains</span><span style="color: #007700">(</span><span style="color: #0000BB">$o2</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">contains</span><span style="color: #007700">(</span><span style="color: #0000BB">$o3</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">detach</span><span style="color: #007700">(</span><span style="color: #0000BB">$o2</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">contains</span><span style="color: #007700">(</span><span style="color: #0000BB">$o1</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">contains</span><span style="color: #007700">(</span><span style="color: #0000BB">$o2</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$s</span><span style="color: #007700">-></span><span style="color: #0000BB">contains</span><span style="color: #007700">(</span><span style="color: #0000BB">$o3</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(true)
bool(true)
bool(false)
bool(true)
bool(false)
bool(false)
</pre></div>
</div>
</div>
<div class="example" id="example-3808">
<p><strong>Example #2 <strong class="classname">SplObjectStorage</strong> as a map</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// As a map from objects to data<br /></span><span style="color: #0000BB">$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">SplObjectStorage</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$o1 </span><span style="color: #007700">= new </span><span style="color: #0000BB">StdClass</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$o2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">StdClass</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$o3 </span><span style="color: #007700">= new </span><span style="color: #0000BB">StdClass</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$s</span><span style="color: #007700">[</span><span style="color: #0000BB">$o1</span><span style="color: #007700">] = </span><span style="color: #DD0000">"data for object 1"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$s</span><span style="color: #007700">[</span><span style="color: #0000BB">$o2</span><span style="color: #007700">] = array(</span><span style="color: #0000BB">1</span><span style="color: #007700">,</span><span style="color: #0000BB">2</span><span style="color: #007700">,</span><span style="color: #0000BB">3</span><span style="color: #007700">);<br /><br />if (isset(</span><span style="color: #0000BB">$s</span><span style="color: #007700">[</span><span style="color: #0000BB">$o2</span><span style="color: #007700">])) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$s</span><span style="color: #007700">[</span><span style="color: #0000BB">$o2</span><span style="color: #007700">]);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(3) {
[0]=>
int(1)
[1]=>
int(2)
[2]=>
int(3)
}
</pre></div>
</div>
</div>
</p>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="splobjectstorage.addall.html">SplObjectStorage::addAll</a> — Adds all objects from another storage</li><li><a href="splobjectstorage.attach.html">SplObjectStorage::attach</a> — Adds an object in the storage</li><li><a href="splobjectstorage.contains.html">SplObjectStorage::contains</a> — Checks if the storage contains a specific object</li><li><a href="splobjectstorage.count.html">SplObjectStorage::count</a> — Returns the number of objects in the storage</li><li><a href="splobjectstorage.current.html">SplObjectStorage::current</a> — Returns the current storage entry</li><li><a href="splobjectstorage.detach.html">SplObjectStorage::detach</a> — Removes an object from the storage</li><li><a href="splobjectstorage.gethash.html">SplObjectStorage::getHash</a> — Calculate a unique identifier for the contained objects</li><li><a href="splobjectstorage.getinfo.html">SplObjectStorage::getInfo</a> — Returns the data associated with the current iterator entry</li><li><a href="splobjectstorage.key.html">SplObjectStorage::key</a> — Returns the index at which the iterator currently is</li><li><a href="splobjectstorage.next.html">SplObjectStorage::next</a> — Move to the next entry</li><li><a href="splobjectstorage.offsetexists.html">SplObjectStorage::offsetExists</a> — Checks whether an object exists in the storage</li><li><a href="splobjectstorage.offsetget.html">SplObjectStorage::offsetGet</a> — Returns the data associated with an object</li><li><a href="splobjectstorage.offsetset.html">SplObjectStorage::offsetSet</a> — Associates data to an object in the storage</li><li><a href="splobjectstorage.offsetunset.html">SplObjectStorage::offsetUnset</a> — Removes an object from the storage</li><li><a href="splobjectstorage.removeall.html">SplObjectStorage::removeAll</a> — Removes objects contained in another storage from the current storage</li><li><a href="splobjectstorage.removeallexcept.html">SplObjectStorage::removeAllExcept</a> — Removes all objects except for those contained in another storage from the current storage</li><li><a href="splobjectstorage.rewind.html">SplObjectStorage::rewind</a> — Rewind the iterator to the first storage element</li><li><a href="splobjectstorage.serialize.html">SplObjectStorage::serialize</a> — Serializes the storage</li><li><a href="splobjectstorage.setinfo.html">SplObjectStorage::setInfo</a> — Sets the data associated with the current iterator entry</li><li><a href="splobjectstorage.unserialize.html">SplObjectStorage::unserialize</a> — Unserializes a storage from its string representation</li><li><a href="splobjectstorage.valid.html">SplObjectStorage::valid</a> — Returns if the current iterator entry is valid</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="splfixedarray.wakeup.html">SplFixedArray::__wakeup</a></div>
<div class="next" style="text-align: right; float: right;"><a href="splobjectstorage.addall.html">SplObjectStorage::addAll</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>
