<!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>Returns the forward matching keys</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyrant.ext.html">TokyoTyrant::ext</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.get.html">TokyoTyrant::get</a></div>
<div class="up"><a href="class.tokyotyrant.html">TokyoTyrant</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="tokyotyrant.fwmkeys" class="refentry">
<div class="refnamediv">
<h1 class="refname">TokyoTyrant::fwmKeys</h1>
<p class="verinfo">(PECL tokyo_tyrant >= 0.1.0)</p><p class="refpurpose"><span class="refname">TokyoTyrant::fwmKeys</span> — <span class="dc-title">Returns the forward matching keys</span></p>
</div>
<div class="refsect1 description" id="refsect1-tokyotyrant.fwmkeys-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>TokyoTyrant::fwmKeys</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$prefix</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$max_recs</code></span>
)</div>
<p class="para rdfs-comment">
Returns the forward matching keys from the database
</p>
</div>
<div class="refsect1 parameters" id="refsect1-tokyotyrant.fwmkeys-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">prefix</code></em></span>
<dd>
<p class="para">
Prefix of the keys
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">max_recs</code></em></span>
<dd>
<p class="para">
Maximum records to return
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-tokyotyrant.fwmkeys-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of matching keys. The values are not returned
</p>
</div>
<div class="refsect1 examples" id="refsect1-tokyotyrant.fwmkeys-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2208">
<p><strong>Example #1 <span class="methodname"><strong>TokyoTyrant::fwmKeys()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$tt </span><span style="color: #007700">= new </span><span style="color: #0000BB">TokyoTyrant</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Create 20 macthing keys */<br /></span><span style="color: #007700">for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">20</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> </span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">put</span><span style="color: #007700">(</span><span style="color: #DD0000">"key_" </span><span style="color: #007700">. </span><span style="color: #0000BB">$i</span><span style="color: #007700">, </span><span style="color: #DD0000">"value_" </span><span style="color: #007700">. </span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/* Create 20 non-macthing keys */<br /></span><span style="color: #007700">for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">20</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> </span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">put</span><span style="color: #007700">(</span><span style="color: #DD0000">"something_" </span><span style="color: #007700">. </span><span style="color: #0000BB">$i</span><span style="color: #007700">, </span><span style="color: #DD0000">"data_" </span><span style="color: #007700">. </span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/* Get five matching keys */<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">fwmKeys</span><span style="color: #007700">(</span><span style="color: #DD0000">"key_"</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(5) {
[0]=>
string(5) "key_5"
[1]=>
string(6) "key_14"
[2]=>
string(5) "key_6"
[3]=>
string(6) "key_15"
[4]=>
string(5) "key_7"
}
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyrant.ext.html">TokyoTyrant::ext</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.get.html">TokyoTyrant::get</a></div>
<div class="up"><a href="class.tokyotyrant.html">TokyoTyrant</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
