<!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>Invalidate all items in the cache</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcached.fetchall.html">Memcached::fetchAll</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.get.html">Memcached::get</a></div>
<div class="up"><a href="class.memcached.html">Memcached</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="memcached.flush" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcached::flush</h1>
<p class="verinfo">(PECL memcached >= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::flush</span> — <span class="dc-title">Invalidate all items in the cache</span></p>
</div>
<div class="refsect1 description" id="refsect1-memcached.flush-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>Memcached::flush</strong></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$delay</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>Memcached::flush()</strong></span> invalidates all existing cache items
immediately (by default) or after the <em><code class="parameter">delay</code></em>
specified. After invalidation none of the items will be returned in
response to a retrieval command (unless it's stored again under the same
key after <span class="function"><strong>Memcached::flush()</strong></span> has invalidated the items).
The flush does not actually free all the memory taken up by the existing
items; that will happen gradually as new items are stored.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-memcached.flush-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">delay</code></em></span>
<dd>
<p class="para">
Numer of seconds to wait before invalidating the items.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-memcached.flush-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
Use <span class="methodname"><a href="memcached.getresultcode.html" class="methodname">Memcached::getResultCode()</a></span> if necessary.
</p>
</div>
<div class="refsect1 examples" id="refsect1-memcached.flush-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4437">
<p><strong>Example #1 <span class="function"><strong>Memcached::flush()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$m </span><span style="color: #007700">= new </span><span style="color: #0000BB">Memcached</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* flush all items in 10 seconds */<br /></span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">flush</span><span style="color: #007700">(</span><span style="color: #0000BB">10</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></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="memcached.fetchall.html">Memcached::fetchAll</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.get.html">Memcached::get</a></div>
<div class="up"><a href="class.memcached.html">Memcached</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
