Source of: /manual/en/function.apc-add.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.apc.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.apc-add.php',
1 => 'apc_add',
),
'up' =>
array (
0 => 'ref.apc.php',
1 => 'APC Functions',
),
'prev' =>
array (
0 => 'ref.apc.php',
1 => 'APC Functions',
),
'next' =>
array (
0 => 'function.apc-cache-info.php',
1 => 'apc_cache_info',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.apc-add" class="refentry">
<div class="refnamediv">
<h1 class="refname">apc_add</h1>
<p class="verinfo">(PECL apc >= 3.0.13)</p><p class="refpurpose"><span class="refname">apc_add</span> — <span class="dc-title">
Cache a variable in the data store
</span></p>
</div>
<a name="function.apc-add.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>apc_add</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$key</tt></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$var</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$ttl</tt><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Caches a variable in the data store, only if it's not already stored.
</p>
<blockquote><p><b class="note">Note</b>:
<span class="simpara">
Unlike many other mechanisms in PHP, variables stored using
<b>apc_add()</b> will persist between requests (until the
value is removed from the cache).
</span>
</p></blockquote>
</div>
<a name="function.apc-add.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">
Store the variable using this name. <i><tt class="parameter">key</tt></i>
s are
cache-unique, so attempting to use <b>apc_add()</b> to
store data with a key that already exists will not overwrite the
existing data, and will instead return <b><tt class="constant">FALSE</tt></b>. (This is the only
difference between <b>apc_add()</b> and
<a href="function.apc-store.php" class="function">apc_store()</a>.)
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">var</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The variable to store
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">ttl</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Time To Live; store <i><tt class="parameter">var</tt></i>
in the cache for
<i><tt class="parameter">ttl</tt></i>
seconds. After the
<i><tt class="parameter">ttl</tt></i>
has passed, the stored variable will be
expunged from the cache (on the next request). If no <i><tt class="parameter">ttl</tt></i>
is supplied (or if the <i><tt class="parameter">ttl</tt></i>
is
<i>0</i>), 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>
</dl>
<p>
</p>
</div>
<a name="function.apc-add.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.apc-add.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 A <b>apc_add()</b> example</b></p>
<div class="example-contents programlisting">
<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_add</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 />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$bar </span><span style="color: #007700">= </span><span style="color: #DD0000">'NEVER GETS SET'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">apc_add</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 />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
string(3) "BAR"
string(3) "BAR"
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.apc-add.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.apc-store.php" class="function" rel="rdfs-seeAlso">apc_store()</a> - Cache a variable in the data store</li>
<li class="member"><a href="function.apc-fetch.php" class="function" rel="rdfs-seeAlso">apc_fetch()</a> - Fetch a stored variable from the cache</li>
<li class="member"><a href="function.apc-delete.php" class="function" rel="rdfs-seeAlso">apc_delete()</a> - Removes a stored variable from the cache</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
