<!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>Replace value of the existing item</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.pconnect.html">Memcache::pconnect</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.set.html">Memcache::set</a></div>
<div class="up"><a href="class.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="memcache.replace" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcache::replace</h1>
<p class="verinfo">(PECL memcache >= 0.2.0)</p><p class="refpurpose"><span class="refname">Memcache::replace</span> — <span class="dc-title">Replace value of the existing item</span></p>
</div>
<div class="refsect1 description" id="refsect1-memcache.replace-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Memcache::replace</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</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">$var</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flag</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$expire</code></span>
]] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>Memcache::replace()</strong></span> should be used to replace value of
existing item with <em><code class="parameter">key</code></em>. In case if item with such
key doesn't exists, <span class="function"><strong>Memcache::replace()</strong></span> returns
<strong><code>FALSE</code></strong>. For the rest <span class="function"><strong>Memcache::replace()</strong></span> behaves
similarly to <span class="function"><a href="memcache.set.html" class="function">Memcache::set()</a></span>.
Also you can use <span class="function"><strong>memcache_replace()</strong></span> function.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-memcache.replace-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 that will be associated with the item.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">var</code></em></span>
<dd>
<p class="para">
The variable to store. Strings and integers are stored as is, other
types are stored serialized.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flag</code></em></span>
<dd>
<p class="para">
Use <strong><code>MEMCACHE_COMPRESSED</code></strong> to store the item
compressed (uses zlib).
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">expire</code></em></span>
<dd>
<p class="para">
Expiration time of the item. If it's equal to zero, the item will never
expire. You can also use Unix timestamp or a number of seconds starting
from current time, but in the latter case the number of seconds may not
exceed 2592000 (30 days).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-memcache.replace-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.
</p>
</div>
<div class="refsect1 examples" id="refsect1-memcache.replace-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4421">
<p><strong>Example #1 <span class="function"><strong>Memcache::replace()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$memcache_obj </span><span style="color: #007700">= </span><span style="color: #0000BB">memcache_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'memcache_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* procedural API */<br /></span><span style="color: #0000BB">memcache_replace</span><span style="color: #007700">(</span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">, </span><span style="color: #DD0000">"test_key"</span><span style="color: #007700">, </span><span style="color: #DD0000">"some variable"</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">30</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* OO API */<br /></span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">replace</span><span style="color: #007700">(</span><span style="color: #DD0000">"test_key"</span><span style="color: #007700">, </span><span style="color: #DD0000">"some variable"</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">30</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-memcache.replace-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="memcache.set.html" class="function" rel="rdfs-seeAlso">Memcache::set()</a> - Store data at the server</span></li>
<li class="member"> <span class="function"><a href="memcache.add.html" class="function" rel="rdfs-seeAlso">Memcache::add()</a> - Add an item to the server</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="memcache.pconnect.html">Memcache::pconnect</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.set.html">Memcache::set</a></div>
<div class="up"><a href="class.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
