<!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>Puts a record</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyrant.putcat.html">TokyoTyrant::putCat</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.putnr.html">TokyoTyrant::putNr</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.putkeep" class="refentry">
<div class="refnamediv">
<h1 class="refname">TokyoTyrant::putKeep</h1>
<p class="verinfo">(PECL tokyo_tyrant >= 0.1.0)</p><p class="refpurpose"><span class="refname">TokyoTyrant::putKeep</span> — <span class="dc-title">Puts a record</span></p>
</div>
<div class="refsect1 description" id="refsect1-tokyotyrant.putkeep-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.tokyotyrant.html" class="type TokyoTyrant">TokyoTyrant</a></span> <span class="methodname"><strong>TokyoTyrant::putKeep</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>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
] )</div>
<p class="para rdfs-comment">
Puts a key-value pair into the database or multiple key-value pairs. If <em><code class="parameter">keys</code></em> is
string then the second parameter value defines the value.
The second parameter is mandatory if <em><code class="parameter">keys</code></em> is a string. If the key already
exists this method throws an exception indicating that the records exists.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-tokyotyrant.putkeep-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 key-value pairs
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
The <span class="type"><a href="language.types.string.html" class="type string">string</a></span> value
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-tokyotyrant.putkeep-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This method returns a reference to the current object and throws TokyoTyrantException on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-tokyotyrant.putkeep-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2215">
<p><strong>Example #1 <span class="methodname"><strong>tokyotyrant::putKeep()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Connect to a database on default port */<br /></span><span style="color: #0000BB">$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 a new key */<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: #DD0000">"value"</span><span style="color: #007700">);<br /><br />try {<br /> </span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">putKeep</span><span style="color: #007700">(</span><span style="color: #DD0000">"key"</span><span style="color: #007700">, </span><span style="color: #DD0000">"new value"</span><span style="color: #007700">);<br />} catch (</span><span style="color: #0000BB">TokyoTyrantException $e</span><span style="color: #007700">) {<br /> if (</span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">getCode</span><span style="color: #007700">() === </span><span style="color: #0000BB">TokyoTyrant</span><span style="color: #007700">::</span><span style="color: #0000BB">TTE_KEEP</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Existing record! Not modified\n"</span><span style="color: #007700">;<br /> } else {<br /> echo </span><span style="color: #DD0000">"Error: " </span><span style="color: #007700">, </span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">getMessage</span><span style="color: #007700">() , </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">; <br /> }<br />}<br />echo </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">"key"</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>
Existing record! Not modified
value
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-tokyotyrant.putkeep-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>
<li class="member"> <span class="methodname"><a href="tokyotyrant.putcat.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrant::putCat()</a> - Concatenates to a record</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.putcat.html">TokyoTyrant::putCat</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.putnr.html">TokyoTyrant::putNr</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>
