<!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>Enable automatic compression of large values</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.set.html">Memcache::set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.setserverparams.html">Memcache::setServerParams</a></div>
<div class="up"><a href="class.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="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>
<div class="refsect1 description" id="refsect1-memcache.setcompressthreshold-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Memcache::setCompressThreshold</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$threshold</code></span>
[, <span class="methodparam"><span class="type">float</span> <code class="parameter">$min_savings</code></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>Memcache::setCompressThreshold()</strong></span> enables automatic
compression of large values.
You can also use the <span class="function"><strong>memcache_set_compress_threshold()</strong></span> function.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function has been added to Memcache version 2.0.0.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-memcache.setcompressthreshold-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">threshold</code></em></span>
<dd>
<p class="para">
Controls the minimum value length before attempting to compress automatically.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">min_saving</code></em></span>
<dd>
<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>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-memcache.setcompressthreshold-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-memcache.setcompressthreshold-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4424">
<p><strong>Example #1 <span class="function"><strong>Memcache::setCompressThreshold()</strong></span> example</strong></p>
<div class="example-contents">
<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>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.set.html">Memcache::set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.setserverparams.html">Memcache::setServerParams</a></div>
<div class="up"><a href="class.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
