Source of: /manual/en/function.memcache-setcompressthreshold.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-setcompressthreshold.php',
1 => 'Memcache::setCompressThreshold',
),
'up' =>
array (
0 => 'ref.memcache.php',
1 => 'Memcache Functions',
),
'prev' =>
array (
0 => 'function.memcache-set.php',
1 => 'Memcache::set',
),
'next' =>
array (
0 => 'function.memcache-setserverparams.php',
1 => 'Memcache::setServerParams',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.memcache-setcompressthreshold" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcache::setCompressThreshold</h1>
<p class="verinfo">(PECL memcache >= 2.0.0)</p><p class="refpurpose"><span class="refname">Memcache::setCompressThreshold</span> — <span class="dc-title">Enable automatic compression of large values</span></p>
</div>
<a name="function.memcache-setcompressthreshold.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::setCompressThreshold</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$threshold</tt></span>
[, <span class="methodparam"><span class="type">float</span> <tt class="parameter">$min_savings</tt></span>
] )</div>
<p class="para rdfs-comment">
<b>Memcache::setCompressThreshold()</b> enables automatic
compression of large values.
You can also use the <b>memcache_set_compress_threshold()</b> function.
</p>
<blockquote><p><b class="note">Note</b>:
This function has been added to Memcache version 2.0.0.
<br />
</p></blockquote>
</div>
<a name="function.memcache-setcompressthreshold.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">threshold</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Controls the minimum value length before attempting to compress automatically.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">min_saving</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Specifies the minimum amount of savings to actually store the value
compressed. The supplied value must be between 0 and 1. Default value
is 0.2 giving a minimum 20% compression savings.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.memcache-setcompressthreshold.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-setcompressthreshold.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>Memcache::setCompressThreshold()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><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 /></span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</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 /></span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">setCompressThreshold</span><span style="color: #007700">(</span><span style="color: #0000BB">20000</span><span style="color: #007700">, </span><span style="color: #0000BB">0.2</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* procedural API */<br /><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 /></span><span style="color: #0000BB">memcache_set_compress_threshold</span><span style="color: #007700">(</span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">, </span><span style="color: #0000BB">20000</span><span style="color: #007700">, </span><span style="color: #0000BB">0.2</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
</div><?php manual_footer(); ?>
