Source of: /manual/en/function.memcache-add.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.memcache.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.memcache-add.php',
1 => 'Memcache::add',
),
'up' =>
array (
0 => 'ref.memcache.php',
1 => 'Memcache Functions',
),
'prev' =>
array (
0 => 'ref.memcache.php',
1 => 'Memcache Functions',
),
'next' =>
array (
0 => 'function.memcache-addserver.php',
1 => 'Memcache::addServer',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.memcache-add" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcache::add</h1>
<p class="verinfo">(PECL memcache >= 0.2.0)</p><p class="refpurpose"><span class="refname">Memcache::add</span> — <span class="dc-title">Add an item to the server</span></p>
</div>
<a name="function.memcache-add.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>Memcache::add</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$key</tt></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$var</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$flag</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$expire</tt></span>
]] )</div>
<p class="para rdfs-comment">
<b>Memcache::add()</b> stores variable
<i><tt class="parameter">var</tt></i>
with <i><tt class="parameter">key</tt></i>
only if such
key doesn't exist at the server yet.
Also you can use <b>memcache_add()</b> function.
</p>
</div>
<a name="function.memcache-add.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">key</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The key that will be associated with the item.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">var</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The variable to store. Strings and integers are stored as is, other
types are stored serialized.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">flag</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Use <b><tt class="constant">MEMCACHE_COMPRESSED</tt></b> to store the item
compressed (uses zlib).
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">expire</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Expiration time of the item. If it's equal to zero, the item will never
expire. You can also use Unix timestamp or a number of seconds starting
from current time, but in the latter case the number of seconds may not
exceed 2592000 (30 days).
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.memcache-add.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
Returns <b><tt class="constant">FALSE</tt></b> if such key already exist. For the rest
<b>Memcache::add()</b> behaves similarly to
<a href="function.memcache-set.php" class="function">Memcache::set()</a>.
</p>
</div>
<a name="function.memcache-add.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>Memcache::add()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$memcache_obj </span><span style="color: #007700">= </span><span style="color: #0000BB">memcache_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* procedural API */<br /></span><span style="color: #0000BB">memcache_add</span><span style="color: #007700">(</span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">, </span><span style="color: #DD0000">'var_key'</span><span style="color: #007700">, </span><span style="color: #DD0000">'test variable'</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">30</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* OO API */<br /></span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'var_key'</span><span style="color: #007700">, </span><span style="color: #DD0000">'test variable'</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">30</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.memcache-add.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.memcache-set.php" class="function" rel="rdfs-seeAlso">Memcache::set()</a> - Store data at the server</li>
<li class="member"><a href="function.memcache-replace.php" class="function" rel="rdfs-seeAlso">Memcache::replace()</a> - Replace value of the existing item</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
