<!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 get purpose</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyrant.fwmkeys.html">TokyoTyrant::fwmKeys</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.getiterator.html">TokyoTyrant::getIterator</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.get" class="refentry">
<div class="refnamediv">
<h1 class="refname">TokyoTyrant::get</h1>
<p class="verinfo">(PECL tokyo_tyrant >= 0.1.0)</p><p class="refpurpose"><span class="refname">TokyoTyrant::get</span> — <span class="dc-title">The get purpose</span></p>
</div>
<div class="refsect1 description" id="refsect1-tokyotyrant.get-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>TokyoTyrant::get</strong></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">$keys</code></span>
)</div>
<p class="para rdfs-comment">
This method is used to return a value or multiple values. This method accepts a <span class="type"><a href="language.types.string.html" class="type string">string</a></span>
or an <span class="type"><a href="language.types.array.html" class="type array">array</a></span> as a value.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-tokyotyrant.get-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">keys</code></em></span>
<dd>
<p class="para">
A <span class="type"><a href="language.types.string.html" class="type string">string</a></span> key or an <span class="type"><a href="language.types.array.html" class="type array">array</a></span> of <span class="type"><a href="language.types.string.html" class="type string">string</a></span> keys
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-tokyotyrant.get-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a string or an array based on the given parameters. Throws a TokyoTyrantException
on error. If string is passed null is returned if the key is not found. In case an array
is given as an parameter only existing keys will be returned. It is not an error to pass
a key that does not exist.
</p>
</div>
<div class="refsect1 examples" id="refsect1-tokyotyrant.get-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2209">
<p><strong>Example #1 <span class="methodname"><strong>TokyoTyrant::get()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<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">, </span><span style="color: #0000BB">1978</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">"key1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"value1"</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">"key2"</span><span style="color: #007700">, </span><span style="color: #DD0000">"value2"</span><span style="color: #007700">);<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">get</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"key1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"key2"</span><span style="color: #007700">)));<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">get</span><span style="color: #007700">(</span><span style="color: #DD0000">"key1"</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:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
["key1"]=>
string(6) "value1"
["key2"]=>
string(6) "value2"
}
string(6) "value1"
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-tokyotyrant.get-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="tokyotyrant.put.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrant::put()</a> - Puts values</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="tokyotyrant.fwmkeys.html">TokyoTyrant::fwmKeys</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.getiterator.html">TokyoTyrant::getIterator</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>
