<!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>Decrease a stored number</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apcu-clear-cache.html">apcu_clear_cache</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apcu-delete.html">apcu_delete</a></div>
<div class="up"><a href="ref.apcu.html">APCu Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.apcu-dec" class="refentry">
<div class="refnamediv">
<h1 class="refname">apcu_dec</h1>
<p class="verinfo">(PECL apcu >= 4.0.0)</p><p class="refpurpose"><span class="refname">apcu_dec</span> — <span class="dc-title">Decrease a stored number</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.apcu-dec-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>apcu_dec</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">$step</code><span class="initializer"> = 1</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter reference">&$success</code></span>
]] )</div>
<p class="para rdfs-comment">
Decreases a stored integer value.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.apcu-dec-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">key</code></dt>
<dd>
<p class="para">
The key of the value being decreased.
</p>
</dd>
<dt>
<code class="parameter">step</code></dt>
<dd>
<p class="para">
The step, or value to decrease.
</p>
</dd>
<dt>
<code class="parameter">success</code></dt>
<dd>
<p class="para">
Optionally pass the success or fail boolean value to
this referenced variable.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.apcu-dec-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the current value of <code class="parameter">key</code>'s value on success,
or <strong><code>FALSE</code></strong> on failure
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.apcu-dec-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-450">
<p><strong>Example #1 <span class="function"><strong>apcu_dec()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"Let's do something with success"</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">apcu_store</span><span style="color: #007700">(</span><span style="color: #DD0000">'anumber'</span><span style="color: #007700">, </span><span style="color: #0000BB">42</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">apcu_fetch</span><span style="color: #007700">(</span><span style="color: #DD0000">'anumber'</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /><br />echo </span><span style="color: #0000BB">apcu_dec</span><span style="color: #007700">(</span><span style="color: #DD0000">'anumber'</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">apcu_dec</span><span style="color: #007700">(</span><span style="color: #DD0000">'anumber'</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">apcu_dec</span><span style="color: #007700">(</span><span style="color: #DD0000">'anumber'</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">$success</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$success</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Now, let's fail"</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">apcu_store</span><span style="color: #007700">(</span><span style="color: #DD0000">'astring'</span><span style="color: #007700">, </span><span style="color: #DD0000">'foo'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">apcu_dec</span><span style="color: #007700">(</span><span style="color: #DD0000">'astring'</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">$fail</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$ret</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$fail</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Let's do something with success
42
41
31
21
bool(true)
Now, let's fail
bool(false)
bool(false)
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-function.apcu-dec-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.apcu-inc.html" class="function" rel="rdfs-seeAlso">apcu_inc()</a> - Increase a stored number</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apcu-clear-cache.html">apcu_clear_cache</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apcu-delete.html">apcu_delete</a></div>
<div class="up"><a href="ref.apcu.html">APCu Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
