<!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>Fetch a stored variable from the cache</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apc-exists.html">apc_exists</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apc-inc.html">apc_inc</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-fetch" class="refentry">
<div class="refnamediv">
<h1 class="refname">apc_fetch</h1>
<p class="verinfo">(PECL apc >= 3.0.0)</p><p class="refpurpose"><span class="refname">apc_fetch</span> — <span class="dc-title">
Fetch a stored variable from the cache
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.apc-fetch-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>apc_fetch</strong></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">$key</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter reference">&$success</code></span>
] )</div>
<p class="para rdfs-comment">
Fetchs a stored variable from the cache.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.apc-fetch-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 <em><code class="parameter">key</code></em> used to store the value (with
<span class="function"><a href="function.apc-store.html" class="function">apc_store()</a></span>). If an array is passed then each
element is fetched and returned.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">success</code></em></span>
<dd>
<p class="para">
Set to <strong><code>TRUE</code></strong> in success and <strong><code>FALSE</code></strong> in failure.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.apc-fetch-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The stored variable or array of variables on success; <strong><code>FALSE</code></strong> on failure
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.apc-fetch-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-413">
<p><strong>Example #1 A <span class="function"><strong>apc_fetch()</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 changelog" id="refsect1-function.apc-fetch-changelog">
<h3 class="title">Changelog</h3>
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>3.0.17</td>
<td>
The <em><code class="parameter">success</code></em> parameter was added.
</td>
</tr>
</tbody>
</table>
</div>
<div class="refsect1 seealso" id="refsect1-function.apc-fetch-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.apc-store.html" class="function" rel="rdfs-seeAlso">apc_store()</a> - Cache a variable in the data store</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>
<li class="member"><a href="class.apciterator.html" class="classname">APCIterator</a></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-exists.html">apc_exists</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apc-inc.html">apc_inc</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>
