Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 296 → Rev 297

/trunk/doc/HTMLSmartyConverter/Framework/CacheSqlite.html
New file
0,0 → 1,888
<html>
<head>
<title>Docs For Class CacheSqlite</title>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
 
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">Framework</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_Framework.html" class="menu">class tree: Framework</a> ]
[ <a href="../elementindex_Framework.html" class="menu">index: Framework</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
 
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="todolist">
<p><a href="../todolist.html">Todo List</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_Framework.html">Framework</a><br />
<a href="../li_Utilitaire.html">Utilitaire</a><br />
<a href="../li_Zend_OpenId.html">Zend_OpenId</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="../Framework/_Bdd.php.html"> Bdd.php
</a><br>
<a href="../Framework/_Cache.php.html"> Cache.php
</a><br>
<a href="../Framework/_CacheFichier.php.html"> CacheFichier.php
</a><br>
<a href="../Framework/_CacheSimple.php.html"> CacheSimple.php
</a><br>
<a href="../Framework/_CacheSqlite.php.html"> CacheSqlite.php
</a><br>
<a href="../Framework/_Chronometre.php.html"> Chronometre.php
</a><br>
<a href="../Framework/_Cli.php.html"> Cli.php
</a><br>
<a href="../Framework/_Config.php.html"> Config.php
</a><br>
<a href="../Framework/_Controleur.php.html"> Controleur.php
</a><br>
<a href="../Framework/_Debug.php.html"> Debug.php
</a><br>
<a href="../Framework/_utilitaires---DiffieHellmanUtil.php.html"> DiffieHellmanUtil.php
</a><br>
<a href="../Framework/_Framework.php.html"> Framework.php
</a><br>
<a href="../Framework/_GestionnaireException.php.html"> GestionnaireException.php
</a><br>
<a href="../Framework/_I18n.php.html"> I18n.php
</a><br>
<a href="../Framework/_Log.php.html"> Log.php
</a><br>
<a href="../Framework/_OpenIdClient.php.html"> OpenIdClient.php
</a><br>
<a href="../Framework/_Registre.php.html"> Registre.php
</a><br>
<a href="../Framework/_RestClient.php.html"> RestClient.php
</a><br>
<a href="../Framework/_RestServeur.php.html"> RestServeur.php
</a><br>
<a href="../Framework/_RestService.php.html"> RestService.php
</a><br>
<a href="../Framework/_Script.php.html"> Script.php
</a><br>
<a href="../Framework/_SquelettePhp.php.html"> SquelettePhp.php
</a><br>
<a href="../Framework/_Url.php.html"> Url.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../Framework/Bdd.html">Bdd</a><br />
<a href="../Framework/Cache.html">Cache</a><br />
<a href="../Framework/CacheFichier.html">CacheFichier</a><br />
<a href="../Framework/CacheSimple.html">CacheSimple</a><br />
<a href="../Framework/CacheSqlite.html">CacheSqlite</a><br />
<a href="../Framework/Chronometre.html">Chronometre</a><br />
<a href="../Framework/Cli.html">Cli</a><br />
<a href="../Framework/Config.html">Config</a><br />
<a href="../Framework/Controleur.html">Controleur</a><br />
<a href="../Framework/Debug.html">Debug</a><br />
<a href="../Framework/DiffieHellmanUtil.html">DiffieHellmanUtil</a><br />
<a href="../Framework/Framework.html">Framework</a><br />
<a href="../Framework/GestionnaireException.html">GestionnaireException</a><br />
<a href="../Framework/I18n.html">I18n</a><br />
<a href="../Framework/Log.html">Log</a><br />
<a href="../Framework/OpenIdClient.html">OpenIdClient</a><br />
<a href="../Framework/Registre.html">Registre</a><br />
<a href="../Framework/RestClient.html">RestClient</a><br />
<a href="../Framework/RestServeur.html">RestServeur</a><br />
<a href="../Framework/RestService.html">RestService</a><br />
<a href="../Framework/Script.html">Script</a><br />
<a href="../Framework/SquelettePhp.html">SquelettePhp</a><br />
<a href="../Framework/Url.html">Url</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
 
<h1>Class: CacheSqlite</h1>
Source Location: /CacheSqlite.php<br /><br />
 
 
<table width="100%" border="0">
<tr><td valign="top">
 
<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description"></div><br /><br />
 
 
 
 
 
 
</td>
 
<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
<li><a href="../Framework/CacheSqlite.html#var$options">$options</a></li>
</ul>
</td>
 
 
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../Framework/CacheSqlite.html#method__construct">__construct</a></li>
<li><a href="../Framework/CacheSqlite.html#method__destruct">__destruct</a></li>
<li><a href="../Framework/CacheSqlite.html#methodajouterSupplementDureeDeVie">ajouterSupplementDureeDeVie</a></li>
<li><a href="../Framework/CacheSqlite.html#methodcharger">charger</a></li>
<li><a href="../Framework/CacheSqlite.html#methodgetIds">getIds</a></li>
<li><a href="../Framework/CacheSqlite.html#methodgetIdsAvecLesTags">getIdsAvecLesTags</a></li>
<li><a href="../Framework/CacheSqlite.html#methodgetIdsAvecUnTag">getIdsAvecUnTag</a></li>
<li><a href="../Framework/CacheSqlite.html#methodgetIdsSansLesTags">getIdsSansLesTags</a></li>
<li><a href="../Framework/CacheSqlite.html#methodgetMetadonnees">getMetadonnees</a></li>
<li><a href="../Framework/CacheSqlite.html#methodgetPourcentageRemplissage">getPourcentageRemplissage</a></li>
<li><a href="../Framework/CacheSqlite.html#methodgetTags">getTags</a></li>
<li><a href="../Framework/CacheSqlite.html#methodnettoyer">nettoyer</a></li>
<li><a href="../Framework/CacheSqlite.html#methodsauver">sauver</a></li>
<li><a href="../Framework/CacheSqlite.html#methodsetEmplacement">setEmplacement</a></li>
<li><a href="../Framework/CacheSqlite.html#methodsupprimer">supprimer</a></li>
<li><a href="../Framework/CacheSqlite.html#methodtester">tester</a></li>
</ul>
</td>
 
</tr></table>
<hr />
 
<table width="100%" border="0"><tr>
 
 
 
 
 
 
</tr></table>
<hr />
 
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a2">2</a>]<br />
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
 
<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
<a name="var$options"></a>
<p></p>
<h4>$options = <span class="value">array(<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'stockage_chemin'&nbsp;=&gt;&nbsp;null,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'defragmentation_auto'&nbsp;=&gt;&nbsp;10<br>
&nbsp;&nbsp;&nbsp;)</span></h4>
<p>[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a20">20</a>]</p>
Options disponibles :<br /><br /><p>====&gt; (string) stockage_chemin : Chemin vers le fichier contenant la base SQLite.</p><p>====&gt; (int) defragmentation_auto : <ul><li>Désactive / Régler le processus de défragmentation automatique</li><li>Le processus de défragmentation automatiques réduit la taille du fichier contenant la base de données
quand un ajout ou une suppression de cache est réalisée :</li></ul> 0 =&gt; pas de défragmentation automatique 1 =&gt; défragmentation automatique systématique x (integer) &gt; 1 =&gt; défragmentation automatique toutes les 1 fois (au hasard) sur x ajout ou suppression de cache</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>var:</b>&nbsp;&nbsp;</td><td>options disponibles</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
</div>
 
<br />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b>&nbsp;&nbsp;</td>
<td>array</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />
 
<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
 
<hr />
<a name="method__construct"></a>
<h3>constructor __construct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a48">48</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void __construct(
[
$options = array()], <a href="../Framework/Cache.html">Cache</a>
$cache)</code>
</td></tr></table>
</td></tr></table><br />
Constructor<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>throws:</b>&nbsp;&nbsp;</td><td>Zend_cache_Exception</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$options</b>&nbsp;&nbsp;</td>
<td>Associative array of options</td>
</tr>
<tr>
<td class="type"><a href="../Framework/Cache.html">Cache</a>&nbsp;&nbsp;</td>
<td><b>$cache</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method__destruct"></a>
<h3>destructor __destruct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a72">72</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void __destruct(
)</code>
</td></tr></table>
</td></tr></table><br />
Destructor<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodajouterSupplementDureeDeVie"></a>
<h3>method ajouterSupplementDureeDeVie <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a403">403</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean ajouterSupplementDureeDeVie(
string
$id,
$supplement_duree_de_vie, int
$extraLifetime)</code>
</td></tr></table>
</td></tr></table><br />
Give (if possible) an extra lifetime to the given cache id<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>true if ok</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$id</b>&nbsp;&nbsp;</td>
<td>cache id</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$extraLifetime</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$supplement_duree_de_vie</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodcharger"></a>
<h3>method charger <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a104">104</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string|false charger(
string
$id, [
$ne_pas_tester_validiter_du_cache = false], boolean
$doNotTestCacheValidity)</code>
</td></tr></table>
</td></tr></table><br />
Test if a cache is available for the given id and (if yes) return it (false else)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>Cached datas</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$id</b>&nbsp;&nbsp;</td>
<td>Cache id</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$doNotTestCacheValidity</b>&nbsp;&nbsp;</td>
<td>If set to true, the cache validity won't be tested</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$ne_pas_tester_validiter_du_cache</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetIds"></a>
<h3>method getIds <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a209">209</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getIds(
)</code>
</td></tr></table>
</td></tr></table><br />
Return an array of stored cache ids<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>array of stored cache ids (string)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetIdsAvecLesTags"></a>
<h3>method getIdsAvecLesTags <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a242">242</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getIdsAvecLesTags(
[array
$tags = array()])</code>
</td></tr></table>
</td></tr></table><br />
Return an array of stored cache ids which match given tags<br /><br /><p>In case of multiple tags, a logical AND is made between tags</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>array of matching cache ids (string)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$tags</b>&nbsp;&nbsp;</td>
<td>array of tags</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetIdsAvecUnTag"></a>
<h3>method getIdsAvecUnTag <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a312">312</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getIdsAvecUnTag(
[array
$tags = array()])</code>
</td></tr></table>
</td></tr></table><br />
Return an array of stored cache ids which match any given tags<br /><br /><p>In case of multiple tags, a logical AND is made between tags</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>array of any matching cache ids (string)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$tags</b>&nbsp;&nbsp;</td>
<td>array of tags</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetIdsSansLesTags"></a>
<h3>method getIdsSansLesTags <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a280">280</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getIdsSansLesTags(
[array
$tags = array()])</code>
</td></tr></table>
</td></tr></table><br />
Return an array of stored cache ids which don't match given tags<br /><br /><p>In case of multiple tags, a logical OR is made between tags</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>array of not matching cache ids (string)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$tags</b>&nbsp;&nbsp;</td>
<td>array of tags</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetMetadonnees"></a>
<h3>method getMetadonnees <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a373">373</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getMetadonnees(
string
$id)</code>
</td></tr></table>
</td></tr></table><br />
Return an array of metadatas for the given cache id<br /><br /><p>The array must include these keys : <ul><li>expire : the expire timestamp</li><li>tags : a string array of tags</li><li>mtime : timestamp of last modification time</li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>array of metadatas (false if the cache id is not found)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$id</b>&nbsp;&nbsp;</td>
<td>cache id</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetPourcentageRemplissage"></a>
<h3>method getPourcentageRemplissage <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a348">348</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int getPourcentageRemplissage(
)</code>
</td></tr></table>
</td></tr></table><br />
Return the filling percentage of the backend storage<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>integer between 0 and 100</td>
</tr>
<tr>
<td><b>throws:</b>&nbsp;&nbsp;</td><td>Zend_Cache_Exception</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodgetTags"></a>
<h3>method getTags <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a224">224</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array getTags(
)</code>
</td></tr></table>
</td></tr></table><br />
Return an array of stored tags<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>array of stored tags (string)</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodnettoyer"></a>
<h3>method nettoyer <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a197">197</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean nettoyer(
[string
$mode = Cache::NETTOYAGE_MODE_TOUS], [array
$tags = array()])</code>
</td></tr></table>
</td></tr></table><br />
Clean some cache records<br /><br /><p>Available modes are : Zend_Cache::CLEANING_MODE_ALL (default) =&gt; remove all cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_OLD =&gt; remove too old cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_MATCHING_TAG =&gt; remove cache entries matching all given tags ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG =&gt; remove cache entries not {matching one of the given tags} ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG =&gt; remove cache entries matching any given tags ($tags can be an array of strings or a single string)</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>True if no problem</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$mode</b>&nbsp;&nbsp;</td>
<td>Clean mode</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$tags</b>&nbsp;&nbsp;</td>
<td>Array of tags</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsauver"></a>
<h3>method sauver <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a140">140</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean sauver(
 
$donnees, string
$id, [array
$tags = array()], [
$duree_vie_specifique = false], string
$data, int
$specificLifetime)</code>
</td></tr></table>
</td></tr></table><br />
Save some string datas into a cache record<br /><br /><p>Note : $data is always &quot;string&quot; (serialization is done by the core not by the backend)</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>True if no problem</td>
</tr>
<tr>
<td><b>throws:</b>&nbsp;&nbsp;</td><td>Zend_Cache_Exception</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$data</b>&nbsp;&nbsp;</td>
<td>Datas to cache</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$id</b>&nbsp;&nbsp;</td>
<td>Cache id</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$tags</b>&nbsp;&nbsp;</td>
<td>Array of strings, the cache record will be tagged by each string entry</td>
</tr>
<tr>
<td class="type">int&nbsp;&nbsp;</td>
<td><b>$specificLifetime</b>&nbsp;&nbsp;</td>
<td>If != false, set a specific lifetime for this cache record (null =&gt; infinite lifetime)</td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$donnees</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$duree_vie_specifique</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetEmplacement"></a>
<h3>method setEmplacement <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a88">88</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setEmplacement(
 
$emplacement)</code>
</td></tr></table>
</td></tr></table><br />
<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">&nbsp;&nbsp;</td>
<td><b>$emplacement</b>&nbsp;&nbsp;</td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsupprimer"></a>
<h3>method supprimer <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a170">170</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean supprimer(
string
$id)</code>
</td></tr></table>
</td></tr></table><br />
Remove a cache record<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>True if no problem</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$id</b>&nbsp;&nbsp;</td>
<td>Cache id</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodtester"></a>
<h3>method tester <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a119">119</a>]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>mixed|false tester(
string
$id)</code>
</td></tr></table>
</td></tr></table><br />
Test if a cache is available or not (for the given id)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>(a cache is not available) or &quot;last modified&quot; timestamp (int) of the available cache record</td>
</tr>
<tr>
<td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
</div>
<br /><br />
 
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$id</b>&nbsp;&nbsp;</td>
<td>Cache id</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div><br />
 
 
<div class="credit">
<hr />
Documentation generated on Tue, 18 Jan 2011 15:01:56 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
 
</body>
</html>