php-doc-en/reference/wincache/functions/wincache-rplist-fileinfo.xml
2009-11-12 06:56:58 +00:00

128 lines
3.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1 $ -->
<refentry xml:id="function.wincache-rplist-fileinfo" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>wincache_rplist_fileinfo</refname>
<refpurpose>
Retrieves information about relative file path cache
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>wincache_rplist_fileinfo</methodname>
<void/>
</methodsynopsis>
<para>
Retrieves information about cached mappings between relative file paths
and corresponding absolute file paths.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Array of meta data about the relative file path cache &return.falseforfailure;
</para>
<para>
The array returned by this function contains the following elements:
<itemizedlist spacing="compact">
<listitem>
<simpara>
<literal>total_file_count</literal> - total number of relative file path
mappings stored in the cache
</simpara>
</listitem>
<listitem>
<para>
<literal>rplist_entries</literal> - an array that contains the information about all
the cached relative file paths:
<itemizedlist spacing="compact">
<listitem>
<simpara>
<literal>relative_path</literal> - relative path to a file
</simpara>
</listitem>
<listitem>
<simpara>
<literal>subkey_data</literal> - corresponding absolute path to a file
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>wincache_rplist_fileinfo</function> example</title>
<programlisting role="php">
<![CDATA[
<pre>
<?php
print_r(wincache_rplist_fileinfo());
?>
</pre>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[total_file_count] => 5
[rplist_entries] => Array
(
[1] => Array
(
[relative_path] => checkcache.php
[subkey_data] => c:\inetpub\wwwroot|c:\inetpub\wwwroot\checkcache.php
)
[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_fcache_fileinfo</function></member>
<member><function>wincache_ocache_fileinfo</function></member>
<member><function>wincache_ocache_meminfo</function></member>
<member><function>wincache_rplist_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
-->