[prev in list] [next in list] [prev in thread] [next in thread]
List: pear-doc
Subject: [PEAR-DOC] cvs: peardoc /en/package/caching/cache-lite/cache-lite clean.xml get.xml getmemorycaching
From: "Laurent Laville" <farell () php ! net>
Date: 2008-12-27 9:59:28
Message-ID: cvsfarell1230371968 () cvsserver
[Download RAW message or body]
farell Sat Dec 27 09:59:28 2008 UTC
Modified files:
/peardoc/en/package/caching/cache-lite/cache-lite-output start.xml
/peardoc/en/package/caching/cache-lite/cache-lite clean.xml get.xml
getmemorycachingstate.xml
Log:
parameter initializer fixed (removed equal sign)
["farell-20081227095928.txt" (text/plain)]
http://cvs.php.net/viewvc.cgi/peardoc/en/package/caching/cache-lite/cache-lite-output/start.xml?r1=1.5&r2=1.6&diff_format=u
Index: peardoc/en/package/caching/cache-lite/cache-lite-output/start.xml
diff -u peardoc/en/package/caching/cache-lite/cache-lite-output/start.xml:1.5 \
peardoc/en/package/caching/cache-lite/cache-lite-output/start.xml:1.6
--- peardoc/en/package/caching/cache-lite/cache-lite-output/start.xml:1.5 Thu Oct 9 \
15:16:20 2008
+++ peardoc/en/package/caching/cache-lite/cache-lite-output/start.xml Sat Dec 27 \
09:59:27 2008 @@ -15,7 +15,8 @@
<paramdef choice="req">string <parameter>$id</parameter></paramdef>
<paramdef choice="opt">string <parameter> $group = \
'default'</parameter></paramdef>
<paramdef choice="opt">boolean <parameter> $doNotTestCacheValidity</parameter>
- = <initializer>false</initializer></paramdef>
+ <initializer>false</initializer>
+ </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -33,8 +34,8 @@
<variablelist>
<varlistentry>
<term>
-
-
+
+
&type.string;
<parameter>$id</parameter>
</term>
@@ -43,13 +44,13 @@
cache id
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
-
-
+
+
&type.string;
<parameter>$group</parameter>
</term>
@@ -58,13 +59,13 @@
name of the cache group
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
-
-
+
+
&type.bool;
<parameter>$doNotTestCacheValidity</parameter>
</term>
@@ -73,7 +74,7 @@
if set to &true;, the cache validity won't be tested
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
</para>
</refsection>
@@ -90,7 +91,7 @@
<refsection xml:id="package.caching.cache-lite.cache-lite-output.start.example">
&title.example;
<example><info><title>classical using</title></info>
-
+
<programlisting role="php">
<![CDATA[
<?php
@@ -108,7 +109,7 @@
// Cache not hit !
// All the output is bufferised until the end() method
// (...)
-
+
$cache->end();
}
@@ -118,4 +119,4 @@
</programlisting>
</example>
</refsection>
-</refentry>
+</refentry>
\ No newline at end of file
http://cvs.php.net/viewvc.cgi/peardoc/en/package/caching/cache-lite/cache-lite/clean.xml?r1=1.8&r2=1.9&diff_format=u
Index: peardoc/en/package/caching/cache-lite/cache-lite/clean.xml
diff -u peardoc/en/package/caching/cache-lite/cache-lite/clean.xml:1.8 \
peardoc/en/package/caching/cache-lite/cache-lite/clean.xml:1.9
--- peardoc/en/package/caching/cache-lite/cache-lite/clean.xml:1.8 Thu Oct 9 \
15:16:20 2008
+++ peardoc/en/package/caching/cache-lite/cache-lite/clean.xml Sat Dec 27 09:59:27 \
2008 @@ -12,14 +12,13 @@
<funcprototype>
<funcdef>boolean <function>Cache_Lite::clean</function></funcdef>
<paramdef choice="opt">
- string
- <parameter>
- $group</parameter>
- = <initializer>false</initializer>
+ string
+ <parameter>$group</parameter>
+ <initializer>false</initializer>
</paramdef>
<paramdef choice="opt">
- string
- <parameter>
+ string
+ <parameter>
$mode = 'ingroup';
</parameter>
</paramdef>
@@ -30,8 +29,8 @@
<refsection xml:id="package.caching.cache-lite.cache-lite.clean.desc">
&title.desc;
<para>
- if no group is specified all cache files will be destroyed ;
-
+ if no group is specified all cache files will be destroyed ;
+
else only cache files of the specified group will be destroyed
</para>
@@ -50,7 +49,7 @@
name of the cache group
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
<variablelist>
<varlistentry>
@@ -60,14 +59,14 @@
</term>
<listitem>
<para>
- flush cache mode :
- 'old' (clean too old cache files for the current lifetime),
- 'ingroup' (clean all cache files for the given group),
- 'notingroup' (clean all the cache files except for the given group),
- [since 1.5.0 beta]
- 'callback_myFunc'
- (call the function 'myFunc' with the complete path file
- and the group in parameters, if the callback return 'true',
+ flush cache mode :
+ 'old' (clean too old cache files for the current lifetime),
+ 'ingroup' (clean all cache files for the given group),
+ 'notingroup' (clean all the cache files except for the given group),
+ [since 1.5.0 beta]
+ 'callback_myFunc'
+ (call the function 'myFunc' with the complete path file
+ and the group in parameters, if the callback return 'true',
the cache file is deleted).
</para>
</listitem>
@@ -88,7 +87,7 @@
<refsection xml:id="package.caching.cache-lite.cache-lite.clean.example">
&title.example;
<example><info><title>Usage</title></info>
-
+
<programlisting role="php">
<![CDATA[
<?php
@@ -107,4 +106,4 @@
This example cleans all of the cache files.
</para>
</refsection>
-</refentry>
+</refentry>
\ No newline at end of file
http://cvs.php.net/viewvc.cgi/peardoc/en/package/caching/cache-lite/cache-lite/get.xml?r1=1.6&r2=1.7&diff_format=u
Index: peardoc/en/package/caching/cache-lite/cache-lite/get.xml
diff -u peardoc/en/package/caching/cache-lite/cache-lite/get.xml:1.6 \
peardoc/en/package/caching/cache-lite/cache-lite/get.xml:1.7
--- peardoc/en/package/caching/cache-lite/cache-lite/get.xml:1.6 Thu Oct 9 15:16:20 \
2008
+++ peardoc/en/package/caching/cache-lite/cache-lite/get.xml Sat Dec 27 09:59:27 2008
@@ -14,7 +14,8 @@
<paramdef choice="req">string <parameter>$id</parameter></paramdef>
<paramdef choice="opt">string <parameter> $group = \
'default'</parameter></paramdef>
<paramdef choice="opt">boolean <parameter> $doNotTestCacheValidity</parameter>
- = <initializer>false</initializer></paramdef>
+ <initializer>false</initializer>
+ </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -32,8 +33,8 @@
<variablelist>
<varlistentry>
<term>
-
-
+
+
&type.string;
<parameter>$id</parameter>
</term>
@@ -42,13 +43,13 @@
cache id
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
-
-
+
+
&type.string;
<parameter>$group</parameter>
</term>
@@ -57,13 +58,13 @@
name of the cache group
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
-
-
+
+
&type.bool;
<parameter>$doNotTestCacheValidity</parameter>
</term>
@@ -72,7 +73,7 @@
if set to &true;, the cache validity won't be tested
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
</para>
</refsection>
@@ -81,7 +82,7 @@
<para>
<emphasis>returns</emphasis> data of the cache (or false if no cache \
available) </para>
- </refsection>
+ </refsection>
<refsection xml:id="package.caching.cache-lite.cache-lite.get.note">
&title.note;
¬e.notstatic;
@@ -89,7 +90,7 @@
<refsection xml:id="package.caching.cache-lite.cache-lite.get.example">
&title.example;
<example><info><title>Usage</title></info>
-
+
<programlisting role="php">
<![CDATA[
<?php
@@ -108,11 +109,11 @@
// Content is in $data
// (...)
-} else {
-
+} else {
+
// No valid cache found (you have to make and save the page)
// (...)
-
+
}
?>
@@ -120,4 +121,4 @@
</programlisting>
</example>
</refsection>
-</refentry>
+</refentry>
\ No newline at end of file
http://cvs.php.net/viewvc.cgi/peardoc/en/package/caching/cache-lite/cache-lite/getmemorycachingstate.xml?r1=1.4&r2=1.5&diff_format=u
Index: peardoc/en/package/caching/cache-lite/cache-lite/getmemorycachingstate.xml
diff -u peardoc/en/package/caching/cache-lite/cache-lite/getmemorycachingstate.xml:1.4 \
peardoc/en/package/caching/cache-lite/cache-lite/getmemorycachingstate.xml:1.5
--- peardoc/en/package/caching/cache-lite/cache-lite/getmemorycachingstate.xml:1.4 Thu \
Oct 9 15:16:20 2008
+++ peardoc/en/package/caching/cache-lite/cache-lite/getmemorycachingstate.xml Sat \
Dec 27 09:59:27 2008 @@ -14,7 +14,8 @@
<paramdef choice="req">string <parameter>$id</parameter></paramdef>
<paramdef choice="opt">string <parameter> $group = \
'default'</parameter></paramdef>
<paramdef choice="opt">bool <parameter> $doNotTestCacheValidity</parameter>
- = <initializer>false</initializer></paramdef>
+ <initializer>false</initializer>
+ </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -22,7 +23,7 @@
<refsection xml:id="package.caching.cache-lite.cache-lite.getmemorycachingstate.desc">
&title.desc;
<para>
- load a previously saved state of a memory caching array from a classical cache \
file + load a previously saved state of a memory caching array from a classical \
cache file </para>
</refsection>
<refsection xml:id="package.caching.cache-lite.cache-lite.getmemorycachingstate.param">
@@ -31,8 +32,8 @@
<variablelist>
<varlistentry>
<term>
-
-
+
+
&type.string;
<parameter>$id</parameter>
</term>
@@ -41,13 +42,13 @@
cache id
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
-
-
+
+
&type.string;
<parameter>$group</parameter>
</term>
@@ -56,13 +57,13 @@
name of the cache group
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>
-
-
+
+
&type.bool;
<parameter>$doNotTestCacheValidity</parameter>
</term>
@@ -71,7 +72,7 @@
if set to &true;, the cache validity won't be tested
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
</para>
</refsection>
@@ -79,4 +80,4 @@
&title.note;
¬e.notstatic;
</refsection>
-</refentry>
+</refentry>
\ No newline at end of file
--
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic