php-doc-en/reference/wincache/functions/wincache-fcache-fileinfo.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.wincache-fcache-fileinfo" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>wincache_fcache_fileinfo</refname>
  <refpurpose>
   Retrieves information about files cached in the file cache
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>wincache_fcache_fileinfo</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>summaryonly</parameter><initializer>false</initializer></methodparam>
  </methodsynopsis>
  <para>
   Retrieves information about file cache content and its usage.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>summaryonly</parameter></term>
     <listitem>
      <para>
       Controls whether the returned array will contain information about individual cache entries 
       along with the file cache summary.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Array of meta data about file cache &return.falseforfailure;
  </para>
  <para>
   The array returned by this function contains the following elements:
   <itemizedlist spacing="compact">
    <listitem>
     <simpara>
      <literal>total_cache_uptime</literal> - total time in seconds that the file cache has been active
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>total_file_count</literal> - total number of files that are currently in the file cache
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>total_hit_count</literal> - number of times the files have been served from the file cache
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>total_miss_count</literal> - number of times the files have not been found in the file cache
     </simpara>
    </listitem>
    <listitem>
     <para>
      <literal>file_entries</literal> - an array that contains the information about all the cached files:
      <itemizedlist spacing="compact">
       <listitem>
        <simpara>
         <literal>file_name</literal> - absolute file name of the cached file
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>add_time</literal> - time in seconds since the file has been added to the file cache
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>use_time</literal> - time in seconds since the file has been accessed in the file cache
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>last_check</literal> - time in seconds since the file has been checked for modifications
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>hit_count</literal> - number of times the file has been served from the cache
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>file_size</literal> - size of the cached file in bytes
        </simpara>
       </listitem>
      </itemizedlist>
     </para>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>wincache_fcache_fileinfo</function> example</title>
    <programlisting role="php">
<![CDATA[
<pre>
<?php
print_r(wincache_fcache_fileinfo());
?>
</pre>

]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(   [total_cache_uptime] => 3234
    [total_file_count] => 5
    [total_hit_count] => 0
    [total_miss_count] => 1
    [file_entries] => Array
        (
            [1] => Array
                (
                    [file_name] => c:\inetpub\wwwroot\checkcache.php
                    [add_time] => 1
                    [use_time] => 0
                    [last_check] => 1
                    [hit_count] => 1
                    [file_size] => 2435
                )
            [2] => Array (...iterates for each cached file)
        )
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>wincache_fcache_meminfo</function></member>
    <member><function>wincache_ocache_fileinfo</function></member>
    <member><function>wincache_ocache_meminfo</function></member>
    <member><function>wincache_rplist_fileinfo</function></member>
    <member><function>wincache_rplist_meminfo</function></member>
    <member><function>wincache_refresh_if_changed</function></member>
    <member><function>wincache_ucache_meminfo</function></member>
    <member><function>wincache_ucache_info</function></member>
    <member><function>wincache_scache_info</function></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
-->