<!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>The APCIterator class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apc-store.html">apc_store</a></div>
<div class="next" style="text-align: right; float: right;"><a href="apciterator.construct.html">APCIterator::__construct</a></div>
<div class="up"><a href="book.apc.html">APC</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.apciterator" class="reference">
<h1 class="title">The APCIterator class</h1>
<div class="partintro"><p class="verinfo">(PECL apc >= 3.1.1)</p>
<div class="section" id="apciterator.intro">
<h2 class="title">Introduction</h2>
<p class="para">
The <strong class="classname">APCIterator</strong> class makes it easier to iterate
over large APC caches. This is helpful as it allows iterating over large
caches in steps, while grabbing a defined number of entries per lock instance,
so it frees the cache locks for other activities rather than hold up the
entire cache to grab 100 (the default) entries. Also, using regular expression
matching is more efficient as it's been moved to the C level.
</p>
</div>
<div class="section" id="apciterator.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">APCIterator</strong>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.iterator.html" class="interfacename">Iterator</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="apciterator.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$cache</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$search</code><span class="initializer"> = null</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$format</code><span class="initializer"> = APC_ITER_ALL</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$chunk_size</code><span class="initializer"> = 100</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$list</code><span class="initializer"> = APC_LIST_ACTIVE</span></span>
]]]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="apciterator.current.html" class="methodname">current</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="apciterator.gettotalcount.html" class="methodname">getTotalCount</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="apciterator.gettotalhits.html" class="methodname">getTotalHits</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="apciterator.gettotalsize.html" class="methodname">getTotalSize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="apciterator.key.html" class="methodname">key</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="apciterator.next.html" class="methodname">next</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="apciterator.rewind.html" class="methodname">rewind</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="apciterator.valid.html" class="methodname">valid</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="apciterator.construct.html">APCIterator::__construct</a> — Constructs an APCIterator iterator object</li><li><a href="apciterator.current.html">APCIterator::current</a> — Get current item</li><li><a href="apciterator.gettotalcount.html">APCIterator::getTotalCount</a> — Get total count</li><li><a href="apciterator.gettotalhits.html">APCIterator::getTotalHits</a> — Get total cache hits</li><li><a href="apciterator.gettotalsize.html">APCIterator::getTotalSize</a> — Get total cache size</li><li><a href="apciterator.key.html">APCIterator::key</a> — Get iterator key</li><li><a href="apciterator.next.html">APCIterator::next</a> — Move pointer to next item</li><li><a href="apciterator.rewind.html">APCIterator::rewind</a> — Rewinds iterator</li><li><a href="apciterator.valid.html">APCIterator::valid</a> — Checks if current position is valid</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apc-store.html">apc_store</a></div>
<div class="next" style="text-align: right; float: right;"><a href="apciterator.construct.html">APCIterator::__construct</a></div>
<div class="up"><a href="book.apc.html">APC</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
