mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
dc270d6f18
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331388 c90b9560-bf6c-de11-be94-00142212c4b1
182 lines
No EOL
5 KiB
XML
182 lines
No EOL
5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.apc-cache-info" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>apc_cache_info</refname>
|
|
<refpurpose>
|
|
Retrieves cached information from APC's data store
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>apc_cache_info</methodname>
|
|
<methodparam choice="opt"><type>string</type><parameter>cache_type</parameter><initializer>""</initializer></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>limited</parameter><initializer>false</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Retrieves cached information and meta-data from APC's data store.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>cache_type</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If <parameter>cache_type</parameter> is "<literal>user</literal>",
|
|
information about the user cache will be returned.
|
|
</para>
|
|
<para>
|
|
If <parameter>cache_type</parameter> is "<literal>filehits</literal>",
|
|
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 <option role="configure">--enable-filehits</option>.
|
|
</para>
|
|
<para>
|
|
If an invalid or no <parameter>cache_type</parameter> is specified, information about
|
|
the system cache (cached files) will be returned.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>limited</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If <parameter>limited</parameter> is &true;, the
|
|
return value will exclude the individual list of cache entries. This
|
|
is useful when trying to optimize calls for statistics gathering.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Array of cached data (and meta-data)&return.falseforfailure;
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
<function>apc_cache_info</function> will raise a warning if it is unable to
|
|
retrieve APC cache data. This typically occurs when APC is not enabled.
|
|
</simpara>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>3.0.11</entry>
|
|
<entry>
|
|
The <parameter>limited</parameter> parameter was introduced.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>3.0.16</entry>
|
|
<entry>
|
|
The "<literal>filehits</literal>" option for the
|
|
<parameter>cache_type</parameter> parameter was introduced.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>apc_cache_info</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
print_r(apc_cache_info());
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
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)
|
|
)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><link linkend="apc.configuration">APC configuration directives</link></member>
|
|
<member><methodname>APCIterator::getTotalSize</methodname></member>
|
|
<member><methodname>APCIterator::getTotalHits</methodname></member>
|
|
<member><methodname>APCIterator::getTotalCount</methodname></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
--> |