1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 299503 $ -->
<refentry xml:id="function.wincache-fcache-fileinfo" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>wincache_fcache_fileinfo</refname>
<refpurpose>
Retrieves information about files cached in the file cache
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>wincache_fcache_fileinfo</methodname>
<methodparam choice="opt"><type>bool</type><parameter>summaryonly</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Retrieves information about file cache content and its usage.
</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 file cache summary.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Array of meta data about file 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 file cache has been active
</simpara>
</listitem>
<listitem>
<simpara>
<literal>total_file_count</literal> - total number of files that are currently in the file cache
</simpara>
</listitem>
<listitem>
<simpara>
<literal>total_hit_count</literal> - number of times the files have been served from the file cache
</simpara>
</listitem>
<listitem>
<simpara>
<literal>total_miss_count</literal> - number of times the files have not been found in the file cache
</simpara>
</listitem>
<listitem>
<para>
<literal>file_entries</literal> - an array that contains the information about all the cached files:
<itemizedlist spacing="compact">
<listitem>
<simpara>
<literal>file_name</literal> - absolute file name of the cached file
</simpara>
</listitem>
<listitem>
<simpara>
<literal>add_time</literal> - time in seconds since the file has been added to the file cache
</simpara>
</listitem>
<listitem>
<simpara>
<literal>use_time</literal> - time in seconds since the file has been accessed in the file 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>hit_count</literal> - number of times the file has been served from the cache
</simpara>
</listitem>
<listitem>
<simpara>
<literal>file_size</literal> - size of the cached file in bytes
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>wincache_fcache_fileinfo</function> example</title>
<programlisting role="php">
<![CDATA[
<pre>
<?php
print_r(wincache_fcache_fileinfo());
?>
</pre>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
( [total_cache_uptime] => 3234
[total_file_count] => 5
[total_hit_count] => 0
[total_miss_count] => 1
[file_entries] => Array
(
[1] => Array
(
[file_name] => c:\inetpub\wwwroot\checkcache.php
[add_time] => 1
[use_time] => 0
[last_check] => 1
[hit_count] => 1
[file_size] => 2435
)
[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_ocache_fileinfo</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_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
-->
|
