<!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 the item under an existing key</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcached.quit.html">Memcached::quit</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.replacebykey.html">Memcached::replaceByKey</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.replace" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcached::replace</h1>
<p class="verinfo">(PECL memcached >= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::replace</span> — <span class="dc-title">Replace the item under an existing key</span></p>
</div>
<div class="refsect1 description" id="refsect1-memcached.replace-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::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">$value</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$expiration</code></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>Memcached::replace()</strong></span> is similar to
<span class="methodname"><a href="memcached.set.html" class="methodname">Memcached::set()</a></span>, but the operation fails if the
<em><code class="parameter">key</code></em> does not exist on the server.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-memcached.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 under which to store the value.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
The value to store.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">expiration</code></em></span>
<dd>
<p class="para">
The expiration time, defaults to 0. See <a href="memcached.expiration.html" class="link">Expiration Times</a> for more info.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-memcached.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.
The <span class="methodname"><a href="memcached.getresultcode.html" class="methodname">Memcached::getResultCode()</a></span> will return
<strong><code>Memcached::RES_NOTSTORED</code></strong> if the key does not exist.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-memcached.replace-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="memcached.replacebykey.html" class="methodname" rel="rdfs-seeAlso">Memcached::replaceByKey()</a> - Replace the item under an existing key on a specific server</span></li>
<li class="member"> <span class="methodname"><a href="memcached.set.html" class="methodname" rel="rdfs-seeAlso">Memcached::set()</a> - Store an item</span></li>
<li class="member"> <span class="methodname"><a href="memcached.add.html" class="methodname" rel="rdfs-seeAlso">Memcached::add()</a> - Add an item under a new key</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="memcached.quit.html">Memcached::quit</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.replacebykey.html">Memcached::replaceByKey</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>
