<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.wincache-ucache-get" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>wincache_ucache_get</refname>
  <refpurpose>
   Gets a variable stored in the user cache
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>wincache_ucache_get</methodname>
   <methodparam><type>mixed</type><parameter>key</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter role="reference">success</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gets a variable stored in the user cache.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       The <parameter>key</parameter> that was used to store the variable in the cache. 
       <parameter>key</parameter> is case sensitive. <parameter>key</parameter> can be an 
       array of keys. In this case the return value will be an array of values of each element 
       in the <parameter>key</parameter> array. If an object, or an array containing objects,
       is returned, then the objects will be unserialized. See
       <link linkend="object.wakeup">__wakeup()</link> for details on unserializing objects.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>success</parameter></term>
     <listitem>
      <para>
       Will be set to &true; on success and &false; on failure.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   If <parameter>key</parameter> is a string, the function returns the value of the variable stored with that key. 
   The <parameter>success</parameter> is set to &true; on success and 
   to &false; on failure.
  </simpara>
  <simpara>
   The <parameter>key</parameter> is an array, the parameter <parameter>success</parameter> 
   is always set to &true;. 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.
  </simpara>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>wincache_ucache_get</function> with <parameter>key</parameter> as a string</title>
    <programlisting role="php">
<![CDATA[
<?php
wincache_ucache_add('color', 'blue');
var_dump(wincache_ucache_get('color', $success));
var_dump($success);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(4) "blue"
bool(true)
]]>
    </screen>    
   </example>
  </para>
  <para>
   <example>
    <title><function>wincache_ucache_get</function> with <parameter>key</parameter> as an array</title>
    <programlisting role="php">
<![CDATA[
<?php
$array1 = array('green' => '5', 'Blue' => '6', 'yellow' => '7', 'cyan' => '8');
wincache_ucache_set($array1);
$array2 = array('green', 'Blue', 'yellow', 'cyan');
var_dump(wincache_ucache_get($array2, $success));
var_dump($success);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(4) { ["green"]=> string(1) "5" 
           ["Blue"]=> string(1) "6" 
           ["yellow"]=> string(1) "7" 
           ["cyan"]=> string(1) "8" } 
bool(true) 
]]>
    </screen>    
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>wincache_ucache_add</function></member>
    <member><function>wincache_ucache_set</function></member>
    <member><function>wincache_ucache_delete</function></member>
    <member><function>wincache_ucache_clear</function></member>
    <member><function>wincache_ucache_exists</function></member>
    <member><function>wincache_ucache_meminfo</function></member>
    <member><function>wincache_ucache_info</function></member>
    <member><link linkend="object.wakeup">__wakeup()</link></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
