mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
f105e870fd
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297997 c90b9560-bf6c-de11-be94-00142212c4b1
212 lines
6.6 KiB
XML
212 lines
6.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.wincache-ucache-info" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>wincache_ucache_info</refname>
|
|
<refpurpose>
|
|
Retrieves information about data stored in the user cache
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</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></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Retrieves information about data stored in the user cache.
|
|
</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 user cache summary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The key of an entry in the user cache. If specified then the returned array will contain information
|
|
only about that cache entry. If not specified and <parameter>summaryonly</parameter> is set to
|
|
<literal>false</literal> then the returned array will contain information about all entries in the cache.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Array of meta data about user 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 user cache has been active
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>total_item_count</literal> - total number of elements that are currently in the user cache
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>is_local_cache</literal> - true is the cache metadata is for a local cache instance,
|
|
false if the metadata is for the global cache
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>total_hit_count</literal> - number of times the data has been served from the cache
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>total_miss_count</literal> - number of times the data has not been found in the cache
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<literal>ucache_entries</literal> - an array that contains the information about all the cached items:
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<simpara>
|
|
<literal>key_name</literal> - name of the key which is used to store the data
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>value_type</literal> - type of value stored by the key
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>use_time</literal> - time in seconds since the file has been accessed in the opcode 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>is_session</literal> - indicates if the data is a session variable
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>ttl_seconds</literal> - time remaining for the data to live in the cache, 0 meaning infinite
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>age_seconds</literal> - time elapsed from the time data has been added in the cache
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>hitcount</literal> - number of times data has been served from the cache
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Using <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>
|
|
</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
|
|
-->
|