<!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>Decrement numeric item's value</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="memcached.construct.html">Memcached::__construct</a></div> <div class="next" style="text-align: right; float: right;"><a href="memcached.decrementbykey.html">Memcached::decrementByKey</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.decrement" class="refentry"> <div class="refnamediv"> <h1 class="refname">Memcached::decrement</h1> <p class="verinfo">(PECL memcached >= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::decrement</span> — <span class="dc-title">Decrement numeric item's value</span></p> </div> <div class="refsect1 description" id="refsect1-memcached.decrement-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><strong>Memcached::decrement</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$offset</code><span class="initializer"> = 1</span></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$initial_value</code><span class="initializer"> = 0</span></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$expiry</code><span class="initializer"> = 0</span></span> ]]] )</div> <p class="para rdfs-comment"> <span class="function"><strong>Memcached::decrement()</strong></span> decrements a numeric item's value by the specified <em><code class="parameter">offset</code></em>. If the item's value is not numeric, an error will result. If the operation would decrease the value below 0, the new value will be 0. <span class="function"><strong>Memcached::decrement()</strong></span> will set the item to the <em><code class="parameter">initial_value</code></em> parameter if the key doesn't exist. </p> </div> <div class="refsect1 parameters" id="refsect1-memcached.decrement-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 item to decrement. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">offset</code></em></span> <dd> <p class="para"> The amount by which to decrement the item's value. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">initial_value</code></em></span> <dd> <p class="para"> The value to set the item to if it doesn't currently exist. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">expiry</code></em></span> <dd> <p class="para"> The expiry time to set on the item. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-memcached.decrement-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns item's new value on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-memcached.decrement-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4433"> <p><strong>Example #1 <span class="function"><strong>Memcached::decrement()</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: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">'counter'</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$n </span><span style="color: #007700">= </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">decrement</span><span style="color: #007700">(</span><span style="color: #DD0000">'counter'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$n</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$n </span><span style="color: #007700">= </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">decrement</span><span style="color: #007700">(</span><span style="color: #DD0000">'counter'</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$n</span><span style="color: #007700">);<br /><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">'counter'</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">'counter'</span><span style="color: #007700">, </span><span style="color: #DD0000">'abc'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$n </span><span style="color: #007700">= </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">increment</span><span style="color: #007700">(</span><span style="color: #DD0000">'counter'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// ^ will fail due to item value not being numeric<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$n</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> int(4) int(0) int(0) bool(false) </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-memcached.decrement-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="memcached.increment.html" class="methodname" rel="rdfs-seeAlso">Memcached::increment()</a> - Increment numeric item's value</span></li> <li class="member"> <span class="methodname"><a href="memcached.incrementbykey.html" class="methodname" rel="rdfs-seeAlso">Memcached::incrementByKey()</a> - Increment numeric item's value, stored on a specific server</span></li> <li class="member"> <span class="methodname"><a href="memcached.decrementbykey.html" class="methodname" rel="rdfs-seeAlso">Memcached::decrementByKey()</a> - Decrement numeric item's value, stored on a specific 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="memcached.construct.html">Memcached::__construct</a></div> <div class="next" style="text-align: right; float: right;"><a href="memcached.decrementbykey.html">Memcached::decrementByKey</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>