<!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>Adds an object in the storage</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="splobjectstorage.addall.html">SplObjectStorage::addAll</a></div>
<div class="next" style="text-align: right; float: right;"><a href="splobjectstorage.contains.html">SplObjectStorage::contains</a></div>
<div class="up"><a href="class.splobjectstorage.html">SplObjectStorage</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="splobjectstorage.attach" class="refentry">
<div class="refnamediv">
<h1 class="refname">SplObjectStorage::attach</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">SplObjectStorage::attach</span> — <span class="dc-title">Adds an object in the storage</span></p>
</div>
<div class="refsect1 description" id="refsect1-splobjectstorage.attach-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>SplObjectStorage::attach</strong></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>
<p class="para rdfs-comment">
Adds an <span class="type"><a href="language.types.object.html" class="type object">object</a></span> inside the storage, and optionally associate it to some data.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-splobjectstorage.attach-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">object</code></em></span>
<dd>
<p class="para">
The <span class="type"><a href="language.types.object.html" class="type object">object</a></span> to add.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">data</code></em></span>
<dd>
<p class="para">
The data to associate with the <span class="type"><a href="language.types.object.html" class="type object">object</a></span>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-splobjectstorage.attach-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-splobjectstorage.attach-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3810">
<p><strong>Example #1 <span class="function"><strong>SplObjectStorage::attach()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$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">$s </span><span style="color: #007700">= new </span><span style="color: #0000BB">SplObjectStorage</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">$o1</span><span style="color: #007700">); </span><span style="color: #FF8000">// similar to $s[$o1] = NULL;<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">, </span><span style="color: #DD0000">"hello"</span><span style="color: #007700">); </span><span style="color: #FF8000">// similar to $s[$o2] = "hello";<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">$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">$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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
NULL
string(5) "hello"
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 changelog" id="refsect1-splobjectstorage.attach-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.3.0</td>
<td>
Added the <em><code class="parameter">data</code></em> parameter.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-splobjectstorage.attach-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="splobjectstorage.detach.html" class="methodname" rel="rdfs-seeAlso">SplObjectStorage::detach()</a> - Removes an object from the storage</span></li>
<li class="member"> <span class="methodname"><a href="splobjectstorage.offsetset.html" class="methodname" rel="rdfs-seeAlso">SplObjectStorage::offsetSet()</a> - Associates data to an object in the storage</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="splobjectstorage.addall.html">SplObjectStorage::addAll</a></div>
<div class="next" style="text-align: right; float: right;"><a href="splobjectstorage.contains.html">SplObjectStorage::contains</a></div>
<div class="up"><a href="class.splobjectstorage.html">SplObjectStorage</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
