<!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>Retrieves cached information from APC's 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-bin-loadfile.html">apc_bin_loadfile</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apc-cas.html">apc_cas</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-cache-info" class="refentry">
<div class="refnamediv">
<h1 class="refname">apc_cache_info</h1>
<p class="verinfo">(PECL apc >= 2.0.0)</p><p class="refpurpose"><span class="refname">apc_cache_info</span> — <span class="dc-title">
Retrieves cached information from APC's data store
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.apc-cache-info-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>apc_cache_info</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$cache_type</code><span class="initializer"> = ""</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$limited</code><span class="initializer"> = false</span></span>
]] )</div>
<p class="para rdfs-comment">
Retrieves cached information and meta-data from APC's data store.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.apc-cache-info-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">cache_type</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">cache_type</code></em> is "<em>user</em>",
information about the user cache will be returned.
</p>
<p class="para">
If <em><code class="parameter">cache_type</code></em> is "<em>filehits</em>",
information about which files have been served from the bytecode cache
for the current request will be returned. This feature must be enabled at
compile time using <strong class="option configure">--enable-filehits</strong>
.
</p>
<p class="para">
If an invalid or no <em><code class="parameter">cache_type</code></em> is specified, information about
the system cache (cached files) will be returned.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">limited</code></em></span>
<dd>
<p class="para">
If <em><code class="parameter">limited</code></em> is <strong><code>TRUE</code></strong>, the
return value will exclude the individual list of cache entries. This
is useful when trying to optimize calls for statistics gathering.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.apc-cache-info-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Array of cached data (and meta-data) or <strong><code>FALSE</code></strong> on failure
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
<span class="function"><strong>apc_cache_info()</strong></span> will raise a warning if it is unable to
retrieve APC cache data. This typically occurs when APC is not enabled.
</span>
</p></blockquote>
</div>
<div class="refsect1 changelog" id="refsect1-function.apc-cache-info-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>3.0.11</td>
<td>
The <em><code class="parameter">limited</code></em> parameter was introduced.
</td>
</tr>
<tr>
<td>3.0.16</td>
<td>
The "<em>filehits</em>" option for the
<em><code class="parameter">cache_type</code></em> parameter was introduced.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.apc-cache-info-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-406">
<p><strong>Example #1 A <span class="function"><strong>apc_cache_info()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">apc_cache_info</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>
Array
(
[num_slots] => 2000
[ttl] => 0
[num_hits] => 9
[num_misses] => 3
[start_time] => 1123958803
[cache_list] => Array
(
[0] => Array
(
[filename] => /path/to/apc_test.php
[device] => 29954
[inode] => 1130511
[type] => file
[num_hits] => 1
[mtime] => 1123960686
[creation_time] => 1123960696
[deletion_time] => 0
[access_time] => 1123962864
[ref_count] => 1
[mem_size] => 677
)
[1] => Array (...iterates for each cached file)
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.apc-cache-info-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="apc.configuration.html" class="link">APC configuration directives</a></li>
<li class="member"> <span class="methodname"><a href="apciterator.gettotalsize.html" class="methodname" rel="rdfs-seeAlso">APCIterator::getTotalSize()</a> - Get total cache size</span></li>
<li class="member"> <span class="methodname"><a href="apciterator.gettotalhits.html" class="methodname" rel="rdfs-seeAlso">APCIterator::getTotalHits()</a> - Get total cache hits</span></li>
<li class="member"> <span class="methodname"><a href="apciterator.gettotalcount.html" class="methodname" rel="rdfs-seeAlso">APCIterator::getTotalCount()</a> - Get total count</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-bin-loadfile.html">apc_bin_loadfile</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apc-cas.html">apc_cas</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>
