<!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>This method deletes am entry from the hash</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="quickhashintstringhash.construct.html">QuickHashIntStringHash::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="quickhashintstringhash.exists.html">QuickHashIntStringHash::exists</a></div>
<div class="up"><a href="class.quickhashintstringhash.html">QuickHashIntStringHash</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="quickhashintstringhash.delete" class="refentry">
<div class="refnamediv">
<h1 class="refname">QuickHashIntStringHash::delete</h1>
<p class="verinfo">(PECL quickhash >= Unknown)</p><p class="refpurpose"><span class="refname">QuickHashIntStringHash::delete</span> — <span class="dc-title">This method deletes am entry from the hash</span></p>
</div>
<div class="refsect1 description" id="refsect1-quickhashintstringhash.delete-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>QuickHashIntStringHash::delete</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$key</code></span>
)</div>
<p class="para rdfs-comment">
This method deletes an entry from the hash, and returns whether the entry was
deleted or not. Associated memory structures will not be freed immediately,
but rather when the hash itself is freed.
</p>
<p class="para">
Elements can not be deleted when the hash is used in an iterator. The
method will not throw an exception, but simply return <strong><code>FALSE</code></strong> like would
happen with any other deletion failure.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-quickhashintstringhash.delete-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">key</code></em></span>
<dd>
<p class="para">
The key of the entry to delete.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-quickhashintstringhash.delete-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<strong><code>TRUE</code></strong> when the entry was deleted, and <strong><code>FALSE</code></strong> if the entry was not deleted.
</p>
</div>
<div class="refsect1 examples" id="refsect1-quickhashintstringhash.delete-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5167">
<p><strong>Example #1 <span class="function"><strong>QuickHashIntStringHash::delete()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$hash </span><span style="color: #007700">= new </span><span style="color: #0000BB">QuickHashIntStringHash</span><span style="color: #007700">( </span><span style="color: #0000BB">1024 </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$hash</span><span style="color: #007700">-></span><span style="color: #0000BB">exists</span><span style="color: #007700">( </span><span style="color: #0000BB">4 </span><span style="color: #007700">) );<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$hash</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">( </span><span style="color: #0000BB">4</span><span style="color: #007700">, </span><span style="color: #DD0000">"five" </span><span style="color: #007700">) );<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$hash</span><span style="color: #007700">-></span><span style="color: #0000BB">delete</span><span style="color: #007700">( </span><span style="color: #0000BB">4 </span><span style="color: #007700">) );<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$hash</span><span style="color: #007700">-></span><span style="color: #0000BB">exists</span><span style="color: #007700">( </span><span style="color: #0000BB">4 </span><span style="color: #007700">) );<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">( </span><span style="color: #0000BB">$hash</span><span style="color: #007700">-></span><span style="color: #0000BB">delete</span><span style="color: #007700">( </span><span style="color: #0000BB">4 </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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(false)
bool(true)
bool(true)
bool(false)
bool(false)
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="quickhashintstringhash.construct.html">QuickHashIntStringHash::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="quickhashintstringhash.exists.html">QuickHashIntStringHash::exists</a></div>
<div class="up"><a href="class.quickhashintstringhash.html">QuickHashIntStringHash</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
