wincache-ucache-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: takagi Status: ready -->
<refentry xml:id="function.wincache-ucache-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>wincache_ucache_info</refname>
  <refpurpose>
   ユーザーキャッシュにキャッシュされたファイルについての情報を取得する
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>wincache_ucache_info</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>summaryonly</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>key</parameter><initializer>NULL</initializer></methodparam>
  </methodsynopsis>
  <para>
   ユーザーキャッシュに格納されたデータについての情報を取得します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>summaryonly</parameter></term>
     <listitem>
      <para>
       返される配列に、ユーザーキャッシュの概要に加えて個々のキャッシュエントリの情報を含めるかどうか。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       ユーザーキャッシュ内のエントリのキー。
       これを指定すると、返される配列にはそのキャッシュエントリの情報だけを含むようになります。
       これを指定せず、さらに <parameter>summaryonly</parameter> が
       &false; の場合は、
       返される配列にはキャッシュ内のすべてのエントリについての情報を含むようになります。
      </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>ucache_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>is_session</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_ucache_info</function> の使用</title>
    <programlisting role="php">
<![CDATA[
<?php
wincache_ucache_get('green');
wincache_ucache_set('green', 2922);
wincache_ucache_get('green');
wincache_ucache_get('green');
wincache_ucache_get('green');
print_r(wincache_ucache_info());
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array 
( ["total_cache_uptime"] => int(0)
  ["is_local_cache"] => bool(false)
  ["total_item_count"] => int(1) 
  ["total_hit_count"] => int(3) 
  ["total_miss_count"] => int(1) 
  ["ucache_entries"] => Array(1) 
    ( [1] => Array(6)
      ( 
        ["key_name"] => string(5) "green"
        ["value_type"] => string(4) "long" 
        ["is_session"] => int(0) 
        ["ttl_seconds"] => int(0)
        ["age_seconds"] => int(0)
        ["hitcount"] => int(3) 
       ) 
    ) 
)
]]>
    </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_meminfo</function></member>
    <member><function>wincache_rplist_fileinfo</function></member>
    <member><function>wincache_refresh_if_changed</function></member>
    <member><function>wincache_ucache_meminfo</function></member>
    <member><function>wincache_scache_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
-->