wincache-scache-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: evvc Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.wincache-scache-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>wincache_scache_info</refname>
  <refpurpose>Получает информацию о файлах, закешированных в кеше сессии</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>wincache_scache_info</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>summaryonly</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Получает информацию о содержимом кеша сессии и его использовании.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>summaryonly</parameter></term>
     <listitem>
      <para>
       Определяет, будет ли возвращаемый массив содержать информацию
       об отдельных записях кеша вместе со сводкой кеша сессии.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

  <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Массив метаданных о кеше сессии &return.falseforfailure;.
  </para>
    <para>
     Массив, возвращаемый этой функцией, содержит следующие элементы:
   <itemizedlist spacing="compact">
    <listitem>
     <simpara>
      <literal>total_cache_uptime</literal> - общее время в секундах, в течение которого кеш сессии был активен.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>total_item_count</literal> - общее количество элементов, которые в настоящее время находятся в кеше сессии.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>is_local_cache</literal> - true, если метаданные кеша предназначены для экземпляра локального кеша,
      false, если метаданные предназначены для глобального кеша.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>total_hit_count</literal> - количество раз, когда данные были обработаны из кеша.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <literal>total_miss_count</literal> - количество раз, когда данные не были найдены в кеше.
     </simpara>
    </listitem>
    <listitem>
     <para>
      <literal>scache_entries</literal> - массив, содержащий информацию обо всех закешированных элементах:
      <itemizedlist spacing="compact">
       <listitem>
        <simpara>
         <literal>key_name</literal> - имя ключа, который используется для хранения данных.
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>value_type</literal> - тип значения, хранимого ключом.
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>use_time</literal> - время в секундах с момента обращения к файлу в кеше опкодов.
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>last_check</literal> - время в секундах с момента проверки файла на наличие модификаций.
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>ttl_seconds</literal> - время, оставшееся для данных, чтобы оставаться в кеше, 0 означает бесконечность.
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>age_seconds</literal> - время, прошедшее с момента добавления данных в кеш.
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         <literal>hitcount</literal> - количество раз, когда данные были получены из кеша.
        </simpara>
       </listitem>
      </itemizedlist>
     </para>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>wincache_scache_info</function></title>
    <programlisting role="php">
<![CDATA[
<pre>
<?php
print_r(wincache_scache_info());
?>
</pre>

]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [total_cache_uptime] => 17357
    [total_file_count] => 121
    [total_hit_count] => 36562
    [total_miss_count] => 201
    [scache_entries] => Array
        (
            [1] => Array
                (
                    [file_name] => c:\inetpub\wwwroot\checkcache.php
                    [add_time] => 17356
                    [use_time] => 7
                    [last_check] => 10
                    [hit_count] => 454
                    [function_count] => 0
                    [class_count] => 1
                )
            [2] => Array (...iterates for each cached file)
        )
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>wincache_fcache_fileinfo</function></member>
    <member><function>wincache_fcache_meminfo</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_meminfo</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
-->