<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Retrieves information about files cached in the file cache</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.wincache.html">WinCache Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.wincache-fcache-meminfo.html">wincache_fcache_meminfo</a></div>
<div class="up"><a href="ref.wincache.html">WinCache Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.wincache-fcache-fileinfo" class="refentry">
<div class="refnamediv">
<h1 class="refname">wincache_fcache_fileinfo</h1>
<p class="verinfo">(PECL wincache >= 1.0.0)</p><p class="refpurpose"><span class="refname">wincache_fcache_fileinfo</span> — <span class="dc-title">
Retrieves information about files cached in the file cache
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.wincache-fcache-fileinfo-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>wincache_fcache_fileinfo</strong></span>
([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$summaryonly</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Retrieves information about file cache content and its usage.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.wincache-fcache-fileinfo-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">summaryonly</code></em></span>
<dd>
<p class="para">
Controls whether the returned array will contain information about individual cache entries
along with the file cache summary.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.wincache-fcache-fileinfo-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Array of meta data about file cache or <strong><code>FALSE</code></strong> on failure
</p>
<p class="para">
The array returned by this function contains the following elements:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<em>total_cache_uptime</em> - total time in seconds that the file cache has been active
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>total_file_count</em> - total number of files that are currently in the file cache
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>total_hit_count</em> - number of times the files have been served from the file cache
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>total_miss_count</em> - number of times the files have not been found in the file cache
</span>
</li>
<li class="listitem">
<p class="para">
<em>file_entries</em> - an array that contains the information about all the cached files:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<em>file_name</em> - absolute file name of the cached file
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>add_time</em> - time in seconds since the file has been added to the file cache
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>use_time</em> - time in seconds since the file has been accessed in the file cache
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>last_check</em> - time in seconds since the file has been checked for modifications
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>hit_count</em> - number of times the file has been served from the cache
</span>
</li>
<li class="listitem">
<span class="simpara">
<em>file_size</em> - size of the cached file in bytes
</span>
</li>
</ul>
</p>
</li>
</ul>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.wincache-fcache-fileinfo-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-559">
<p><strong>Example #1 A <span class="function"><strong>wincache_fcache_fileinfo()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<pre><br /><span style="color: #0000BB"><?php<br />print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">wincache_fcache_fileinfo</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?><br /></span></pre></span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
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)
)
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.wincache-fcache-fileinfo-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.wincache-fcache-meminfo.html" class="function" rel="rdfs-seeAlso">wincache_fcache_meminfo()</a> - Retrieves information about file cache memory usage</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ocache-fileinfo.html" class="function" rel="rdfs-seeAlso">wincache_ocache_fileinfo()</a> - Retrieves information about files cached in the opcode cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ocache-meminfo.html" class="function" rel="rdfs-seeAlso">wincache_ocache_meminfo()</a> - Retrieves information about opcode cache memory usage</span></li>
<li class="member"> <span class="function"><a href="function.wincache-rplist-fileinfo.html" class="function" rel="rdfs-seeAlso">wincache_rplist_fileinfo()</a> - Retrieves information about resolve file path cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-rplist-meminfo.html" class="function" rel="rdfs-seeAlso">wincache_rplist_meminfo()</a> - Retrieves information about memory usage by the resolve file path cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-refresh-if-changed.html" class="function" rel="rdfs-seeAlso">wincache_refresh_if_changed()</a> - Refreshes the cache entries for the cached files</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ucache-meminfo.html" class="function" rel="rdfs-seeAlso">wincache_ucache_meminfo()</a> - Retrieves information about user cache memory usage</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ucache-info.html" class="function" rel="rdfs-seeAlso">wincache_ucache_info()</a> - Retrieves information about data stored in the user cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-scache-info.html" class="function" rel="rdfs-seeAlso">wincache_scache_info()</a> - Retrieves information about files cached in the session cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-scache-meminfo.html" class="function" rel="rdfs-seeAlso">wincache_scache_meminfo()</a> - Retrieves information about session cache memory usage</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.wincache.html">WinCache Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.wincache-fcache-meminfo.html">wincache_fcache_meminfo</a></div>
<div class="up"><a href="ref.wincache.html">WinCache Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
