cvs: peardoc /en/package/caching/cache-lite/cache-lite getmemorycachingstate.xml savememorycachingstate.xml

fab Sat Apr 24 08:31:38 2004 EDT Added files: /peardoc/en/package/caching/cache-lite/cache-lite getmemorycachingstate.xml savememorycachingstate.xml Log: work in progress (comments are welcome) http://cvs.php.net/co.php/peardoc/en/package/caching/cache-lite/cache-lite/getmemorycachingstate.xml?r=1.1&p=1 Index: peardoc/en/package/caching/cache-lite/cache-lite/getmemorycachingstate.xml +++ peardoc/en/package/caching/cache-lite/cache-lite/getmemorycachingstate.xml <!-- $Revision: 1.1 $ --> <refentry id="package.caching.cache-lite.cache-lite.getmemorycachingstate"> <refnamediv> <refname><function>Cache_Lite::getMemoryCachingState</function></refname> <refpurpose></refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once &apos;Lite.php&apos;; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Cache_Lite::getMemoryCachingState</function></funcdef> <paramdef>string <parameter>$id</parameter></paramdef> <paramdef>string <parameter> <optional>$group = 'default'</optional></parameter></paramdef> <paramdef>bool <parameter> <optional>$doNotTestCacheValidity = &false;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.caching.cache-lite.cache-lite.getmemorycachingstate.desc"> &title.desc; <para> [BETA QUALITY] load a previously saved state of a memory caching array from a classical cache file </para> </refsect1> <refsect1 id="package.caching.cache-lite.cache-lite.getmemorycachingstate.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$id</parameter> </term> <listitem> <para> cache id </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$group</parameter> </term> <listitem> <para> name of the cache group </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$doNotTestCacheValidity</parameter> </term> <listitem> <para> if set to &true;, the cache validity won&apos;t be tested </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.caching.cache-lite.cache-lite.getmemorycachingstate.note"> &title.note; &note.notstatic; </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../../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 --> http://cvs.php.net/co.php/peardoc/en/package/caching/cache-lite/cache-lite/savememorycachingstate.xml?r=1.1&p=1 Index: peardoc/en/package/caching/cache-lite/cache-lite/savememorycachingstate.xml +++ peardoc/en/package/caching/cache-lite/cache-lite/savememorycachingstate.xml <!-- $Revision: 1.1 $ --> <refentry id="package.caching.cache-lite.cache-lite.savememorycachingstate"> <refnamediv> <refname><function>Cache_Lite::saveMemoryCachingState</function></refname> <refpurpose></refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once &apos;Lite.php&apos;; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Cache_Lite::saveMemoryCachingState</function></funcdef> <paramdef>string <parameter>$id</parameter></paramdef> <paramdef>string <parameter> <optional>$group = 'default'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.caching.cache-lite.cache-lite.savememorycachingstate.desc"> &title.desc; <para> [BETA QUALITY] save the current state of the memory caching array into a classical cache file </para> </refsect1> <refsect1 id="package.caching.cache-lite.cache-lite.savememorycachingstate.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$id</parameter> </term> <listitem> <para> cache id </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$group</parameter> </term> <listitem> <para> name of the cache group </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.caching.cache-lite.cache-lite.savememorycachingstate.note"> &title.note; &note.notstatic; </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 sgml-parent-document:nil sgml-default-dtd-file:"../../../../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 -->