Source of: /manual/en/function.memcache-decrement.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.memcache.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.memcache-decrement.php',
1 => 'Memcache::decrement',
),
'up' =>
array (
0 => 'ref.memcache.php',
1 => 'Memcache Functions',
),
'prev' =>
array (
0 => 'function.memcache-debug.php',
1 => 'memcache_debug',
),
'next' =>
array (
0 => 'function.memcache-delete.php',
1 => 'Memcache::delete',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.memcache-decrement" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcache::decrement</h1>
<p class="verinfo">(PECL memcache >= 0.2.0)</p><p class="refpurpose"><span class="refname">Memcache::decrement</span> — <span class="dc-title">Decrement item's value</span></p>
</div>
<a name="function.memcache-decrement.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>Memcache::decrement</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$key</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$value</tt></span>
] )</div>
<p class="para rdfs-comment">
<b>Memcache::decrement()</b> decrements value of the
item by <i><tt class="parameter">value</tt></i>
. Similarly to
<a href="function.memcache-increment.php" class="function">Memcache::increment()</a>, current value of the item is
being converted to numerical and after that <i><tt class="parameter">value</tt></i>
is substracted.
</p><blockquote><p><b class="note">Note</b>:
New item's value will not be less than zero.
<br />
</p></blockquote><p>
</p><blockquote><p><b class="note">Note</b>:
Do not use <b>Memcache::decrement()</b> with item, which was
stored compressed, because consequent call to
<a href="function.memcache-get.php" class="function">Memcache::get()</a> will fail.
<br />
</p></blockquote><p>
<b>Memcache::decrement()</b> <em class="emphasis">does not</em>
create an item if it didn't exist.
Also you can use <b>memcache_decrement()</b> function.
</p>
</div>
<a name="function.memcache-decrement.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">key</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Key of the item do decrement.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">value</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Decrement the item by <i><tt class="parameter">value</tt></i>
. Optional and defaults to 1.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.memcache-decrement.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns item's new value on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.memcache-decrement.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>Memcache::decrement()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* procedural API */<br /></span><span style="color: #0000BB">$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 /></span><span style="color: #FF8000">/* decrement item by 2 */<br /></span><span style="color: #0000BB">$new_value </span><span style="color: #007700">= </span><span style="color: #0000BB">memcache_decrement</span><span style="color: #007700">(</span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">, </span><span style="color: #DD0000">'test_item'</span><span style="color: #007700">, </span><span style="color: #0000BB">2</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">= new </span><span style="color: #0000BB">Memcache</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">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 /></span><span style="color: #FF8000">/* decrement item by 3 */<br /></span><span style="color: #0000BB">$new_value </span><span style="color: #007700">= </span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">decrement</span><span style="color: #007700">(</span><span style="color: #DD0000">'test_item'</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.memcache-decrement.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.memcache-increment.php" class="function" rel="rdfs-seeAlso">Memcache::increment()</a> - Increment item's value</li>
<li class="member"><a href="function.memcache-replace.php" class="function" rel="rdfs-seeAlso">Memcache::replace()</a> - Replace value of the existing item</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
