<!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>Gets a variable stored in the user cache</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.wincache-ucache-exists.html">wincache_ucache_exists</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.wincache-ucache-inc.html">wincache_ucache_inc</a></div>
<div class="up"><a href="ref.wincache.html">WinCache Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.wincache-ucache-get" class="refentry">
<div class="refnamediv">
<h1 class="refname">wincache_ucache_get</h1>
<p class="verinfo">(PECL wincache >= 1.1.0)</p><p class="refpurpose"><span class="refname">wincache_ucache_get</span> — <span class="dc-title">
Gets a variable stored in the user cache
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.wincache-ucache-get-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>wincache_ucache_get</strong></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">$key</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter reference">&$success</code></span>
] )</div>
<p class="para rdfs-comment">
Gets a variable stored in the user cache.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.wincache-ucache-get-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">key</code></em></span>
<dd>
<p class="para">
The <em><code class="parameter">key</code></em> that was used to store the variable in the cache.
<em><code class="parameter">key</code></em> is case sensitive. <em><code class="parameter">key</code></em> can be an
array of keys. In this case the return value will be an array of values of each element
in the <em><code class="parameter">key</code></em> array. If an object, or an array containing objects,
is returned, then the objects will be unserialized. See
<a href="language.oop5.magic.html#object.wakeup" class="link">__wakeup()</a> for details on unserializing objects.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">success</code></em></span>
<dd>
<p class="para">
Will be set to <strong><code>TRUE</code></strong> on success and <strong><code>FALSE</code></strong> on failure.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.wincache-ucache-get-returnvalues">
<h3 class="title">Return Values</h3>
<p class="simpara">
If <em><code class="parameter">key</code></em> is a string, the function returns the value of the variable stored with that key.
The <em><code class="parameter">success</code></em> is set to <strong><code>TRUE</code></strong> on success and
to <strong><code>FALSE</code></strong> on failure.
</p>
<p class="simpara">
The <em><code class="parameter">key</code></em> is an array, the parameter <em><code class="parameter">success</code></em>
is always set to <strong><code>TRUE</code></strong>. The returned array (name => value pairs) will
contain only those name => value pairs for which the get operation in user cache was
successful. If none of the keys in the key array finds a match in the user cache
an empty array will be returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.wincache-ucache-get-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-578">
<p><strong>Example #1 <span class="function"><strong>wincache_ucache_get()</strong></span> with <em><code class="parameter">key</code></em> as a string</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />wincache_ucache_add</span><span style="color: #007700">(</span><span style="color: #DD0000">'color'</span><span style="color: #007700">, </span><span style="color: #DD0000">'blue'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">wincache_ucache_get</span><span style="color: #007700">(</span><span style="color: #DD0000">'color'</span><span style="color: #007700">, </span><span style="color: #0000BB">$success</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$success</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
string(4) "blue"
bool(true)
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-579">
<p><strong>Example #2 <span class="function"><strong>wincache_ucache_get()</strong></span> with <em><code class="parameter">key</code></em> as an array</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$array1 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'green' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'5'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Blue' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'6'</span><span style="color: #007700">, </span><span style="color: #DD0000">'yellow' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'7'</span><span style="color: #007700">, </span><span style="color: #DD0000">'cyan' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'8'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">wincache_ucache_set</span><span style="color: #007700">(</span><span style="color: #0000BB">$array1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$array2 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'green'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Blue'</span><span style="color: #007700">, </span><span style="color: #DD0000">'yellow'</span><span style="color: #007700">, </span><span style="color: #DD0000">'cyan'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">wincache_ucache_get</span><span style="color: #007700">(</span><span style="color: #0000BB">$array2</span><span style="color: #007700">, </span><span style="color: #0000BB">$success</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$success</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(4) { ["green"]=> string(1) "5"
["Blue"]=> string(1) "6"
["yellow"]=> string(1) "7"
["cyan"]=> string(1) "8" }
bool(true)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.wincache-ucache-get-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.wincache-ucache-add.html" class="function" rel="rdfs-seeAlso">wincache_ucache_add()</a> - Adds a variable in user cache only if variable does not already exist in the cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ucache-set.html" class="function" rel="rdfs-seeAlso">wincache_ucache_set()</a> - Adds a variable in user cache and overwrites a variable if it already exists in the cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ucache-delete.html" class="function" rel="rdfs-seeAlso">wincache_ucache_delete()</a> - Deletes variables from the user cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ucache-clear.html" class="function" rel="rdfs-seeAlso">wincache_ucache_clear()</a> - Deletes entire content of the user cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ucache-exists.html" class="function" rel="rdfs-seeAlso">wincache_ucache_exists()</a> - Checks if a variable exists in the user cache</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ucache-meminfo.html" class="function" rel="rdfs-seeAlso">wincache_ucache_meminfo()</a> - Retrieves information about user cache memory usage</span></li>
<li class="member"> <span class="function"><a href="function.wincache-ucache-info.html" class="function" rel="rdfs-seeAlso">wincache_ucache_info()</a> - Retrieves information about data stored in the user cache</span></li>
<li class="member"><a href="language.oop5.magic.html#object.wakeup" class="link">__wakeup()</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.wincache-ucache-exists.html">wincache_ucache_exists</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.wincache-ucache-inc.html">wincache_ucache_inc</a></div>
<div class="up"><a href="ref.wincache.html">WinCache Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
