- fix for bug #39848

corrected wording of apc_cache_info function
  added documentation for additional "limited" parameter


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@225085 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Brian Shire 2006-12-16 02:58:21 +00:00
parent caed39cf20
commit 47f7e294f7

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.apc-cache-info">
<refnamediv>
<refname>apc_cache_info</refname>
@ -12,6 +12,7 @@
<methodsynopsis>
<type>array</type><methodname>apc_cache_info</methodname>
<methodparam choice="opt"><type>string</type><parameter>cache_type</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>limited</parameter></methodparam>
</methodsynopsis>
</refsect1>
@ -36,9 +37,19 @@
<term><parameter>cache_type</parameter></term>
<listitem>
<para>
If <parameter>cache_type</parameter> is "<literal>user</literal>", the
user cache will be cleared; otherwise, the system cache (cached files)
will be cleared.
If <parameter>cache_type</parameter> is "<literal>user</literal>",
information about the user cache will be returned; otherwise,
information about the system cache (cached files) will be returned.
</para>
</listitem>
</varlistentry>
<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 usefull when trying to optimize calls for statistics gathering.
</para>
</listitem>
</varlistentry>
@ -46,6 +57,30 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>3.0.11</entry>
<entry>
The <parameter>limited</parameter> parameter was introduced.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>