<!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>Append data to an existing item</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="memcached.addservers.html">Memcached::addServers</a></div> <div class="next" style="text-align: right; float: right;"><a href="memcached.appendbykey.html">Memcached::appendByKey</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.append" class="refentry"> <div class="refnamediv"> <h1 class="refname">Memcached::append</h1> <p class="verinfo">(PECL memcached >= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::append</span> — <span class="dc-title">Append data to an existing item</span></p> </div> <div class="refsect1 description" id="refsect1-memcached.append-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::append</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span> )</div> <p class="para rdfs-comment"> <span class="function"><strong>Memcached::append()</strong></span> appends the given <em><code class="parameter">value</code></em> string to the value of an existing item. The reason that <em><code class="parameter">value</code></em> is forced to be a string is that appending mixed types is not well-defined. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> If the <strong><code>Memcached::OPT_COMPRESSION</code></strong> is enabled, the operation will fail and a warning will be issued, because appending compressed data to a value that is potentially already compressed is not possible. </p> </p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-memcached.append-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 string to append. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-memcached.append-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 examples" id="refsect1-memcached.append-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4430"> <p><strong>Example #1 <span class="function"><strong>Memcached::append()</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 /></span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">setOption</span><span style="color: #007700">(</span><span style="color: #0000BB">Memcached</span><span style="color: #007700">::</span><span style="color: #0000BB">OPT_COMPRESSION</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">, </span><span style="color: #DD0000">'abc'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">append</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">, </span><span style="color: #DD0000">'def'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">get</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</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:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> string(6) "abcdef" </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-memcached.append-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="memcached.appendbykey.html" class="methodname" rel="rdfs-seeAlso">Memcached::appendByKey()</a> - Append data to an existing item on a specific server</span></li> <li class="member"> <span class="methodname"><a href="memcached.prepend.html" class="methodname" rel="rdfs-seeAlso">Memcached::prepend()</a> - Prepend data to an existing item</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.addservers.html">Memcached::addServers</a></div> <div class="next" style="text-align: right; float: right;"><a href="memcached.appendbykey.html">Memcached::appendByKey</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>