cvs: peardoc /en/package/caching/cache-lite/cache-lite-function drop.xml
| From: | Fabien MARTY | Date: | Thu, 24 Nov 2005 19:47:21 +0000 |
| Subject: | cvs: peardoc /en/package/caching/cache-lite/cache-lite-function drop.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-7203@lists.php.net to get a copy of this message | ||
fab Thu Nov 24 14:47:21 2005 EDT
Added files:
/peardoc/en/package/caching/cache-lite/cache-lite-function drop.xml
Log:
first import
http://cvs.php.net/co.php/peardoc/en/package/caching/cache-lite/cache-lite-function/drop.xml?r=1.1&p=1
Index: peardoc/en/package/caching/cache-lite/cache-lite-function/drop.xml
+++ peardoc/en/package/caching/cache-lite/cache-lite-function/drop.xml
<!-- $Revision: 1.1 $ -->
<refentry id="package.default.cache-lite.cache-lite-function.drop">
<refnamediv>
<refname><function>Cache_Lite_Function::drop</function></refname>
<refpurpose>Drop a cache file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
require_once 'Cache/Lite/Function.php';
</funcsynopsisinfo>
<funcprototype>
<funcdef>boolean
<function>Cache_Lite_Function::drop</function></funcdef>
<paramdef>string<parameter>$functionName</parameter></paramdef>
<paramdef>mixed<parameter>$arg1</parameter></paramdef>
<paramdef>mixed<parameter>$arg2</parameter></paramdef>
<paramdef>mixed<parameter>$arg3</parameter></paramdef>
<paramdef>mixed<parameter>...</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.default.cache-lite.cache-lite-function.drop.desc">
&title.desc;
<para>
[since Cache_Lite 1.6.0beta1] Drop the cache file of the corresponding function call with
given arguments.
</para>
</refsect1>
<refsect1 id="package.default.cache-lite.cache-lite-function.drop.returns">
&title.returns;
<para>
<emphasis>returns</emphasis> true if ok
</para>
</refsect1>
<refsect1 id="package.default.cache-lite.cache-lite-function.drop.note">
&title.note;
¬e.notstatic;
</refsect1>
<refsect1 id="package.caching.cache-lite.cache-lite-function.drop.example1">
&title.example;
<example>
<title>classical using with a function</title>
<programlisting role="php">
<![CDATA[
<?php
require_once('Cache/Lite/Function.php');
$options = array(
'cacheDir' => '/tmp/',
'lifeTime' => 3600
);
$cache = new Cache_Lite_Function($options);
$cache->call('function_to_bench', 12,45);
$cache->call('function_to_bench', 12,45);
// clean the corresponding cache file
$cache->drop('function_to_bench', 12, 45);
function function_to_bench($arg1, $arg2)
{
echo "This is the output of the function function_to_bench($arg1, $arg2) !<br>";
return "This is the result of the function function_to_bench($arg1, $arg2)
!<br>";
}
?>
]]>
</programlisting>
</example>
</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
-->