<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.wincache.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.wincache-scache-info.php',
    1 => 'wincache_scache_info',
    2 => 'Retrieves information about files cached in the session cache',
  ),
  'up' => 
  array (
    0 => 'ref.wincache.php',
    1 => 'WinCache Functions',
  ),
  'prev' => 
  array (
    0 => 'function.wincache-rplist-meminfo.php',
    1 => 'wincache_rplist_meminfo',
  ),
  'next' => 
  array (
    0 => 'function.wincache-scache-meminfo.php',
    1 => 'wincache_scache_meminfo',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/wincache/functions/wincache-scache-info.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.wincache-scache-info" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">wincache_scache_info</h1>
  <p class="verinfo">(PECL wincache &gt;= 1.1.0)</p><p class="refpurpose"><span class="refname">wincache_scache_info</span> &mdash; <span class="dc-title">
   Retrieves information about files cached in the session cache
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.wincache-scache-info-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>wincache_scache_info</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$summaryonly</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Retrieves information about session cache content and its usage.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.wincache-scache-info-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">summaryonly</code></dt>
     <dd>
      <p class="para">
       Controls whether the returned array will contain information about individual cache entries 
       along with the session cache summary.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

  <div class="refsect1 returnvalues" id="refsect1-function.wincache-scache-info-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Array of meta data about session cache  or <strong><code><a href="reserved.constants.php#constant.false">false</a></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">
      <code class="literal">total_cache_uptime</code> - total time in seconds that the session cache has been active
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">total_item_count</code> - total number of elements that are currently in the session cache
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">is_local_cache</code> - true is the cache metadata is for a local cache instance, 
       false if the metadata is for the global cache
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">total_hit_count</code> - number of times the data has been served from the cache
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">total_miss_count</code> - number of times the data has not been found in the cache
     </span>
    </li>
    <li class="listitem">
     <p class="para">
      <code class="literal">scache_entries</code> - an array that contains the information about all the cached items:
      <ul class="itemizedlist">
       <li class="listitem">
        <span class="simpara">
         <code class="literal">key_name</code> - name of the key which is used to store the data
        </span>
       </li>
       <li class="listitem">
        <span class="simpara">
         <code class="literal">value_type</code> - type of value stored by the key
        </span>
       </li>
       <li class="listitem">
        <span class="simpara">
         <code class="literal">use_time</code> - time in seconds since the file has been accessed in the opcode cache
        </span>
       </li>
       <li class="listitem">
        <span class="simpara">
         <code class="literal">last_check</code> - time in seconds since the file has been checked for modifications
        </span>
       </li>
       <li class="listitem">
        <span class="simpara">
         <code class="literal">ttl_seconds</code> - time remaining for the data to live in the cache, 0 meaning infinite
        </span>
       </li>
       <li class="listitem">
        <span class="simpara">
         <code class="literal">age_seconds</code> - time elapsed from the time data has been added in the cache
        </span>
       </li>
       <li class="listitem">
        <span class="simpara">
         <code class="literal">hitcount</code> - number of times data has been served from the cache
        </span>
       </li>
      </ul>
     </p>
    </li>
   </ul>
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-function.wincache-scache-info-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Example #1 A <span class="function"><strong>wincache_scache_info()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">&lt;pre&gt;<br /><span style="color: #0000BB">&lt;?php<br />print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">wincache_scache_info</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?&gt;<br /></span>&lt;/pre&gt;</span></code></div>
    </div>

    <div class="example-contents"><p>The above example will output:</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [total_cache_uptime] =&gt; 17357
    [total_file_count] =&gt; 121
    [total_hit_count] =&gt; 36562
    [total_miss_count] =&gt; 201
    [scache_entries] =&gt; Array
        (
            [1] =&gt; Array
                (
                    [file_name] =&gt; c:\inetpub\wwwroot\checkcache.php
                    [add_time] =&gt; 17356
                    [use_time] =&gt; 7
                    [last_check] =&gt; 10
                    [hit_count] =&gt; 454
                    [function_count] =&gt; 0
                    [class_count] =&gt; 1
                )
            [2] =&gt; Array (...iterates for each cached file)
        )
)</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.wincache-scache-info-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.wincache-fcache-fileinfo.php" class="function" rel="rdfs-seeAlso">wincache_fcache_fileinfo()</a> - Retrieves information about files cached in the file cache</span></li>
    <li><span class="function"><a href="function.wincache-fcache-meminfo.php" class="function" rel="rdfs-seeAlso">wincache_fcache_meminfo()</a> - Retrieves information about file cache memory usage</span></li>
    <li><span class="function"><a href="function.wincache-ocache-meminfo.php" class="function" rel="rdfs-seeAlso">wincache_ocache_meminfo()</a> - Retrieves information about opcode cache memory usage</span></li>
    <li><span class="function"><a href="function.wincache-rplist-fileinfo.php" class="function" rel="rdfs-seeAlso">wincache_rplist_fileinfo()</a> - Retrieves information about resolve file path cache</span></li>
    <li><span class="function"><a href="function.wincache-rplist-meminfo.php" class="function" rel="rdfs-seeAlso">wincache_rplist_meminfo()</a> - Retrieves information about memory usage by the resolve file path cache</span></li>
    <li><span class="function"><a href="function.wincache-refresh-if-changed.php" class="function" rel="rdfs-seeAlso">wincache_refresh_if_changed()</a> - Refreshes the cache entries for the cached files</span></li>
    <li><span class="function"><a href="function.wincache-ucache-meminfo.php" class="function" rel="rdfs-seeAlso">wincache_ucache_meminfo()</a> - Retrieves information about user cache memory usage</span></li>
    <li><span class="function"><a href="function.wincache-ucache-info.php" class="function" rel="rdfs-seeAlso">wincache_ucache_info()</a> - Retrieves information about data stored in the user cache</span></li>
    <li><span class="function"><a href="function.wincache-scache-meminfo.php" class="function" rel="rdfs-seeAlso">wincache_scache_meminfo()</a> - Retrieves information about session cache memory usage</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>