apcu-cache-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.apcu-cache-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>apcu_cache_info</refname>
  <refpurpose>
   Retrieves cached information from APCu's data store
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>apcu_cache_info</methodname>
   <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>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>apcu_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>PECL apcu 3.0.11</entry>
       <entry>
        The <parameter>limited</parameter> parameter was introduced.
       </entry>
      </row>
      <row>
       <entry>PECL apcu 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>apcu_cache_info</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
print_r(apcu_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/apcu_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="apcu.configuration">APCu configuration directives</link></member>
    <member><methodname>APCUIterator::getTotalSize</methodname></member>
    <member><methodname>APCUIterator::getTotalHits</methodname></member>
    <member><methodname>APCUIterator::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
-->