Source of: /manual/en/function.memcache-set.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-set.php',
1 => 'Memcache::set',
),
'up' =>
array (
0 => 'ref.memcache.php',
1 => 'Memcache Functions',
),
'prev' =>
array (
0 => 'function.memcache-replace.php',
1 => 'Memcache::replace',
),
'next' =>
array (
0 => 'function.memcache-setcompressthreshold.php',
1 => 'Memcache::setCompressThreshold',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.memcache-set" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcache::set</h1>
<p class="verinfo">(PECL memcache >= 0.2.0)</p><p class="refpurpose"><span class="refname">Memcache::set</span> — <span class="dc-title">Store data at the server</span></p>
</div>
<a name="function.memcache-set.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::set</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::set()</b> stores an item
<i><tt class="parameter">var</tt></i>
with <i><tt class="parameter">key</tt></i>
on the
memcached server. Parameter <i><tt class="parameter">expire</tt></i>
is expiration
time in seconds. If it's 0, the item never expires (but memcached server
doesn't guarantee this item to be stored all the time, it could be deleted
from the cache to make place for other items).
You can use <b><tt class="constant">MEMCACHE_COMPRESSED</tt></b> constant as
<i><tt class="parameter">flag</tt></i>
value if you want to use on-the-fly
compression (uses zlib).
</p><blockquote><p><b class="note">Note</b>:
Remember that resource variables (i.e. file and connection descriptors)
cannot be stored in the cache, because they cannot be adequately
represented in serialized state.
<br />
</p></blockquote><p>
Also you can use <b>memcache_set()</b> function.
</p>
</div>
<a name="function.memcache-set.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-set.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.
</p>
</div>
<a name="function.memcache-set.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>Memcache::set()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* procedural API */<br /><br />/* connect to memcached server */<br /></span><span style="color: #0000BB">$memcache_obj </span><span style="color: #007700">= </span><span style="color: #0000BB">memcache_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'memcache_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/*<br />set value of item with key 'var_key'<br />using 0 as flag value, compression is not used<br />expire time is 30 seconds<br />*/<br /></span><span style="color: #0000BB">memcache_set</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">'some variable'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">30</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">memcache_get</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">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p><div class="example">
<p><b>Example #2 <b>Memcache::set()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* OO API */<br /><br /></span><span style="color: #0000BB">$memcache_obj </span><span style="color: #007700">= new </span><span style="color: #0000BB">Memcache</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* connect to memcached server */<br /></span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'memcache_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/*<br />set value of item with key 'var_key', using on-the-fly compression<br />expire time is 50 seconds<br />*/<br /></span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">'var_key'</span><span style="color: #007700">, </span><span style="color: #DD0000">'some really big variable'</span><span style="color: #007700">, </span><span style="color: #0000BB">MEMCACHE_COMPRESSED</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">get</span><span style="color: #007700">(</span><span style="color: #DD0000">'var_key'</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-set.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-add.php" class="function" rel="rdfs-seeAlso">Memcache::add()</a> - Add an item to 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(); ?>
