Source of: /manual/en/function.apc-cache-info.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-cache-info.php',
1 => 'apc_cache_info',
),
'up' =>
array (
0 => 'ref.apc.php',
1 => 'APC Functions',
),
'prev' =>
array (
0 => 'function.apc-add.php',
1 => 'apc_add',
),
'next' =>
array (
0 => 'function.apc-clear-cache.php',
1 => 'apc_clear_cache',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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>
<a name="function.apc-cache-info.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><b>apc_cache_info</b></span>
([ <span class="methodparam"><span class="type">string</span> <tt class="parameter">$cache_type</tt></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$limited</tt><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>
<a name="function.apc-cache-info.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Array of cached data (and meta-data) or <b><tt class="constant">FALSE</tt></b> on failure
</p>
<blockquote><p><b class="note">Note</b>:
<span class="simpara">
<b>apc_cache_info()</b> 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>
<a name="function.apc-cache-info.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">cache_type</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
If <i><tt class="parameter">cache_type</tt></i>
is "<i>user</i>",
information about the user cache will be returned.
</p>
<p class="para">
If <i><tt class="parameter">cache_type</tt></i>
is "<i>filehits</i>",
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 <span class="option">--enable-filehits</span>.
</p>
<p class="para">
If an invalid or no <i><tt class="parameter">cache_type</tt></i>
is specified, information about
the system cache (cached files) will be returned.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">limited</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
If <i><tt class="parameter">limited</tt></i>
is <b><tt class="constant">TRUE</tt></b>, the
return value will exclude the individual list of cache entries. This
is useful when trying to optimize calls for statistics gathering.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.apc-cache-info.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">3.0.11</td>
<td align="left">
The <i><tt class="parameter">limited</tt></i>
parameter was introduced.
</td>
</tr>
<tr valign="middle">
<td align="left">3.0.16</td>
<td align="left">
The "<i>filehits</i>" option for the
<i><tt class="parameter">cache_type</tt></i>
parameter was introduced.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.apc-cache-info.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_cache_info()</b> example</b></p>
<div class="example-contents programlisting">
<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 para"><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>
</p>
</div>
<a name="function.apc-cache-info.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="apc.configuration.php" class="link">APC configuration directives</a></li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
