<!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>The Memcache class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.examples-overview.html">Basic usage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.add.html">Memcache::add</a></div>
<div class="up"><a href="book.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.memcache" class="reference">
<h1 class="title">The Memcache class</h1>
<div class="partintro"><p class="verinfo">(PECL memcache >= 0.2.0)</p>
<div class="section" id="memcache.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Represents a connection to a set of memcache servers.
</p>
</div>
<div class="section" id="memcache.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Memcache</strong>
</span>
{</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="memcache.add.html" class="methodname">add</a></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.mixed" class="type mixed">mixed</a></span> <code class="parameter">$var</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flag</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$expire</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="memcache.addserver.html" class="methodname">addServer</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code><span class="initializer"> = 11211</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$persistent</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$weight</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$retry_interval</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$status</code></span>
[, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$failure_callback</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeoutms</code></span>
]]]]]]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="memcache.close.html" class="methodname">close</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="memcache.connect.html" class="methodname">connect</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="memcache.decrement.html" class="methodname">decrement</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$value</code><span class="initializer"> = 1</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="memcache.delete.html" class="methodname">delete</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code><span class="initializer"> = 0</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="memcache.flush.html" class="methodname">flush</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="memcache.get.html" class="methodname">get</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$flags</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><a href="memcache.getextendedstats.html" class="methodname">getExtendedStats</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$type</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$slabid</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$limit</code><span class="initializer"> = 100</span></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="memcache.getserverstatus.html" class="methodname">getServerStatus</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code><span class="initializer"> = 11211</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><a href="memcache.getstats.html" class="methodname">getStats</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$type</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$slabid</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$limit</code><span class="initializer"> = 100</span></span>
]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="memcache.getversion.html" class="methodname">getVersion</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="memcache.increment.html" class="methodname">increment</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$value</code><span class="initializer"> = 1</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">mixed</span> <span class="methodname"><a href="memcache.pconnect.html" class="methodname">pconnect</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="memcache.replace.html" class="methodname">replace</a></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.mixed" class="type mixed">mixed</a></span> <code class="parameter">$var</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flag</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$expire</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="memcache.set.html" class="methodname">set</a></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.mixed" class="type mixed">mixed</a></span> <code class="parameter">$var</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flag</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$expire</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="memcache.setcompressthreshold.html" class="methodname">setCompressThreshold</a></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>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="memcache.setserverparams.html" class="methodname">setServerParams</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code><span class="initializer"> = 11211</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$retry_interval</code><span class="initializer"> = false</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$status</code></span>
[, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$failure_callback</code></span>
]]]]] )</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="memcache.add.html">Memcache::add</a> — Add an item to the server</li><li><a href="memcache.addserver.html">Memcache::addServer</a> — Add a memcached server to connection pool</li><li><a href="memcache.close.html">Memcache::close</a> — Close memcached server connection</li><li><a href="memcache.connect.html">Memcache::connect</a> — Open memcached server connection</li><li><a href="memcache.decrement.html">Memcache::decrement</a> — Decrement item's value</li><li><a href="memcache.delete.html">Memcache::delete</a> — Delete item from the server</li><li><a href="memcache.flush.html">Memcache::flush</a> — Flush all existing items at the server</li><li><a href="memcache.get.html">Memcache::get</a> — Retrieve item from the server</li><li><a href="memcache.getextendedstats.html">Memcache::getExtendedStats</a> — Get statistics from all servers in pool</li><li><a href="memcache.getserverstatus.html">Memcache::getServerStatus</a> — Returns server status</li><li><a href="memcache.getstats.html">Memcache::getStats</a> — Get statistics of the server</li><li><a href="memcache.getversion.html">Memcache::getVersion</a> — Return version of the server</li><li><a href="memcache.increment.html">Memcache::increment</a> — Increment item's value</li><li><a href="memcache.pconnect.html">Memcache::pconnect</a> — Open memcached server persistent connection</li><li><a href="memcache.replace.html">Memcache::replace</a> — Replace value of the existing item</li><li><a href="memcache.set.html">Memcache::set</a> — Store data at the server</li><li><a href="memcache.setcompressthreshold.html">Memcache::setCompressThreshold</a> — Enable automatic compression of large values</li><li><a href="memcache.setserverparams.html">Memcache::setServerParams</a> — Changes server parameters and status at runtime</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.examples-overview.html">Basic usage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.add.html">Memcache::add</a></div>
<div class="up"><a href="book.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
