<!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>Adds to a numeric key</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.tokyotyrant.html">TokyoTyrant</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.connect.html">TokyoTyrant::connect</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.add" class="refentry">
<div class="refnamediv">
<h1 class="refname">TokyoTyrant::add</h1>
<p class="verinfo">(PECL tokyo_tyrant >= 0.1.0)</p><p class="refpurpose"><span class="refname">TokyoTyrant::add</span> — <span class="dc-title">Adds to a numeric key</span></p>
</div>
<div class="refsect1 description" id="refsect1-tokyotyrant.add-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.number" class="type number">number</a></span> <span class="methodname"><strong>TokyoTyrant::add</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.number" class="type number">number</a></span> <code class="parameter">$increment</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Adds to an int or double value. This increments the value by the given amount
and returns the new value. If the key does not exist a new key is created with
initial value of the increment parameter.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-tokyotyrant.add-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">key</code></em></span>
<dd>
<p class="para">
The string key
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">increment</code></em></span>
<dd>
<p class="para">
The amount to increment
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">
<strong><code>TokyoTyrant::RDBREC_INT</code></strong> or <strong><code>TokyoTyrant::RDBREC_DBL</code></strong> constant.
If this parameter is omitted the type is guessed from the <em><code class="parameter">increment</code></em>
parameters type.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-tokyotyrant.add-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the new value on success
</p>
</div>
<div class="refsect1 examples" id="refsect1-tokyotyrant.add-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2203">
<p><strong>Example #1 <span class="methodname"><strong>TokyoTyrant::add()</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">TokyoTyrant</span><span style="color: #007700">::</span><span style="color: #0000BB">RDBDEF_PORT</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/* Adds integer 3 to key and creates a new key */<br /></span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">"test"</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* String value is converted to double */<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">"test"</span><span style="color: #007700">, </span><span style="color: #DD0000">"3.5"</span><span style="color: #007700">, </span><span style="color: #0000BB">TokyoTyrant</span><span style="color: #007700">::</span><span style="color: #0000BB">RDBREC_DBL</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>
6.5
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-tokyotyrant.add-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>
<li class="member"> <span class="methodname"><a href="tokyotyrant.putkeep.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrant::putkeep()</a> - Puts 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="class.tokyotyrant.html">TokyoTyrant</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.connect.html">TokyoTyrant::connect</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>
