<!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>Cache a variable in the data store</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apc-sma-info.html">apc_sma_info</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.apciterator.html">APCIterator</a></div>
<div class="up"><a href="ref.apc.html">APC Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.apc-store" class="refentry">
<div class="refnamediv">
<h1 class="refname">apc_store</h1>
<p class="verinfo">(PECL apc >= 3.0.0)</p><p class="refpurpose"><span class="refname">apc_store</span> — <span class="dc-title">
Cache a variable in the data store
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.apc-store-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>apc_store</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">$var</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$ttl</code><span class="initializer"> = 0</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>apc_store</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$values</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">$unused</code><span class="initializer"> = NULL</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$ttl</code><span class="initializer"> = 0</span></span>
]] )</div>
<p class="para rdfs-comment">
Cache a variable in the data store.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
Unlike many other mechanisms in PHP, variables stored using
<span class="function"><strong>apc_store()</strong></span> will persist between requests (until the
value is removed from the cache).
</span>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.apc-store-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">
Store the variable using this name. <em><code class="parameter">key</code></em>s are
cache-unique, so storing a second value with the same
<em><code class="parameter">key</code></em> will overwrite the original value.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">var</code></em></span>
<dd>
<p class="para">
The variable to store
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">ttl</code></em></span>
<dd>
<p class="para">
Time To Live; store <em><code class="parameter">var</code></em> in the cache for
<em><code class="parameter">ttl</code></em> seconds. After the
<em><code class="parameter">ttl</code></em> has passed, the stored variable will be
expunged from the cache (on the next request). If no <em><code class="parameter">ttl</code></em>
is supplied (or if the <em><code class="parameter">ttl</code></em> is
<em>0</em>), the value will persist until it is removed from
the cache manually, or otherwise fails to exist in the cache (clear,
restart, etc.).
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">values</code></em></span>
<dd>
<p class="para">
Names in key, variables in value.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.apc-store-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.
Second syntax returns array with error keys.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.apc-store-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-417">
<p><strong>Example #1 A <span class="function"><strong>apc_store()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$bar </span><span style="color: #007700">= </span><span style="color: #DD0000">'BAR'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">apc_store</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo'</span><span style="color: #007700">, </span><span style="color: #0000BB">$bar</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">apc_fetch</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(3) "BAR"
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.apc-store-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.apc-add.html" class="function" rel="rdfs-seeAlso">apc_add()</a> - Cache a new variable in the data store</span></li>
<li class="member"> <span class="function"><a href="function.apc-fetch.html" class="function" rel="rdfs-seeAlso">apc_fetch()</a> - Fetch a stored variable from the cache</span></li>
<li class="member"> <span class="function"><a href="function.apc-delete.html" class="function" rel="rdfs-seeAlso">apc_delete()</a> - Removes a stored variable from the cache</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="function.apc-sma-info.html">apc_sma_info</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.apciterator.html">APCIterator</a></div>
<div class="up"><a href="ref.apc.html">APC Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
