<!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 TokyoTyrantQuery class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyranttable.setindex.html">TokyoTyrantTable::setIndex</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrantquery.addcond.html">TokyoTyrantQuery::addCond</a></div>
<div class="up"><a href="book.tokyo-tyrant.html">tokyo_tyrant</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.tokyotyrantquery" class="reference">
<h1 class="title">The TokyoTyrantQuery class</h1>
<div class="partintro"><p class="verinfo">(PECL tokyo_tyrant >= 0.1.0)</p>
<div class="section" id="tokyotyrantquery.intro">
<h2 class="title">Introduction</h2>
<p class="para">
This class is used to query the table databases
</p>
</div>
<div class="section" id="tokyotyrantquery.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">TokyoTyrantQuery</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="type">mixed</span> <span class="methodname"><a href="tokyotyrantquery.addcond.html" class="methodname">addCond</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$op</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$expr</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="tokyotyrantquery.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type"><a href="class.tokyotyranttable.html" class="type TokyoTyrantTable">TokyoTyrantTable</a></span> <code class="parameter">$table</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="tokyotyrantquery.count.html" class="methodname">count</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="tokyotyrantquery.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">string</span> <span class="methodname"><a href="tokyotyrantquery.hint.html" class="methodname">hint</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="tokyotyrantquery.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">array</span> <span class="methodname"><a href="tokyotyrantquery.metasearch.html" class="methodname">metaSearch</a></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$queries</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="tokyotyrantquery.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">TokyoTyrantQuery</span> <span class="methodname"><a href="tokyotyrantquery.out.html" class="methodname">out</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="tokyotyrantquery.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">array</span> <span class="methodname"><a href="tokyotyrantquery.search.html" class="methodname">search</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrantquery.setlimit.html" class="methodname">setLimit</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$max</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$skip</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="tokyotyrantquery.setorder.html" class="methodname">setOrder</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="tokyotyrantquery.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="tokyotyrantquery.addcond.html">TokyoTyrantQuery::addCond</a> — Adds a condition to the query</li><li><a href="tokyotyrantquery.construct.html">TokyoTyrantQuery::__construct</a> — Construct a new query</li><li><a href="tokyotyrantquery.count.html">TokyoTyrantQuery::count</a> — Counts records</li><li><a href="tokyotyrantquery.current.html">TokyoTyrantQuery::current</a> — Returns the current element</li><li><a href="tokyotyrantquery.hint.html">TokyoTyrantQuery::hint</a> — Get the hint string of the query</li><li><a href="tokyotyrantquery.key.html">TokyoTyrantQuery::key</a> — Returns the current key</li><li><a href="tokyotyrantquery.metasearch.html">TokyoTyrantQuery::metaSearch</a> — Retrieve records with multiple queries</li><li><a href="tokyotyrantquery.next.html">TokyoTyrantQuery::next</a> — Moves the iterator to next entry</li><li><a href="tokyotyrantquery.out.html">TokyoTyrantQuery::out</a> — Removes records based on query</li><li><a href="tokyotyrantquery.rewind.html">TokyoTyrantQuery::rewind</a> — Rewinds the iterator</li><li><a href="tokyotyrantquery.search.html">TokyoTyrantQuery::search</a> — Searches records</li><li><a href="tokyotyrantquery.setlimit.html">TokyoTyrantQuery::setLimit</a> — Limit results</li><li><a href="tokyotyrantquery.setorder.html">TokyoTyrantQuery::setOrder</a> — Orders results</li><li><a href="tokyotyrantquery.valid.html">TokyoTyrantQuery::valid</a> — Checks the validity of current item</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyranttable.setindex.html">TokyoTyrantTable::setIndex</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrantquery.addcond.html">TokyoTyrantQuery::addCond</a></div>
<div class="up"><a href="book.tokyo-tyrant.html">tokyo_tyrant</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
