New file |
0,0 → 1,807 |
<?xml version="1.0" encoding="UTF-8"?> |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
<html xmlns="http://www.w3.org/1999/xhtml"> |
<head> |
<!-- template designed by Marco Von Ballmoos --> |
<title>Docs For Class CacheSqlite</title> |
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
<script src="../media/lib/classTree.js"></script> |
<script language="javascript" type="text/javascript"> |
var imgPlus = new Image(); |
var imgMinus = new Image(); |
imgPlus.src = "../media/images/plus.png"; |
imgMinus.src = "../media/images/minus.png"; |
|
function showNode(Node){ |
switch(navigator.family){ |
case 'nn4': |
// Nav 4.x code fork... |
var oTable = document.layers["span" + Node]; |
var oImg = document.layers["img" + Node]; |
break; |
case 'ie4': |
// IE 4/5 code fork... |
var oTable = document.all["span" + Node]; |
var oImg = document.all["img" + Node]; |
break; |
case 'gecko': |
// Standards Compliant code fork... |
var oTable = document.getElementById("span" + Node); |
var oImg = document.getElementById("img" + Node); |
break; |
} |
oImg.src = imgMinus.src; |
oTable.style.display = "block"; |
} |
|
function hideNode(Node){ |
switch(navigator.family){ |
case 'nn4': |
// Nav 4.x code fork... |
var oTable = document.layers["span" + Node]; |
var oImg = document.layers["img" + Node]; |
break; |
case 'ie4': |
// IE 4/5 code fork... |
var oTable = document.all["span" + Node]; |
var oImg = document.all["img" + Node]; |
break; |
case 'gecko': |
// Standards Compliant code fork... |
var oTable = document.getElementById("span" + Node); |
var oImg = document.getElementById("img" + Node); |
break; |
} |
oImg.src = imgPlus.src; |
oTable.style.display = "none"; |
} |
|
function nodeIsVisible(Node){ |
switch(navigator.family){ |
case 'nn4': |
// Nav 4.x code fork... |
var oTable = document.layers["span" + Node]; |
break; |
case 'ie4': |
// IE 4/5 code fork... |
var oTable = document.all["span" + Node]; |
break; |
case 'gecko': |
// Standards Compliant code fork... |
var oTable = document.getElementById("span" + Node); |
break; |
} |
return (oTable && oTable.style.display == "block"); |
} |
|
function toggleNodeVisibility(Node){ |
if (nodeIsVisible(Node)){ |
hideNode(Node); |
}else{ |
showNode(Node); |
} |
} |
</script> |
</head> |
<body> |
<div class="page-body"> |
<h2 class="class-name">Class CacheSqlite</h2> |
|
<a name="sec-description"></a> |
<div class="info-box"> |
<div class="info-box-title">Description</div> |
<div class="nav-bar"> |
<span class="disabled">Description</span> | |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
</div> |
<div class="info-box-body"> |
<!-- ========== Info from phpDoc block ========= --> |
<p class="notes"> |
Located in <a class="field" href="_CacheSqlite.php.html">/CacheSqlite.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a2">2</a></span>) |
</p> |
|
|
<pre></pre> |
|
</div> |
</div> |
|
|
|
<a name="sec-var-summary"></a> |
<div class="info-box"> |
<div class="info-box-title">Variable Summary</span></div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
</div> |
<div class="info-box-body"> |
<div class="var-summary"> |
<div class="var-title"> |
<span class="var-type">array</span> |
<a href="#$options" title="details" class="var-name">$options</a> |
</div> |
</div> |
</div> |
</div> |
|
<a name="sec-method-summary"></a> |
<div class="info-box"> |
<div class="info-box-title">Method Summary</span></div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
| |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
</div> |
<div class="info-box-body"> |
<div class="method-summary"> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#__construct" title="details" class="method-name">__construct</a> |
([<span class="var-type"></span> <span class="var-name">$options</span> = <span class="var-default">array()</span>], <span class="var-type"><a href="../Framework/Cache.html">Cache</a></span> <span class="var-name">$cache</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#__destruct" title="details" class="method-name">__destruct</a> |
() |
</div> |
|
<div class="method-definition"> |
<span class="method-result">boolean</span> |
<a href="#ajouterSupplementDureeDeVie" title="details" class="method-name">ajouterSupplementDureeDeVie</a> |
(<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type"></span> <span class="var-name">$supplement_duree_de_vie</span>, <span class="var-type">int</span> <span class="var-name">$extraLifetime</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">string|false</span> |
<a href="#charger" title="details" class="method-name">charger</a> |
(<span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$ne_pas_tester_validiter_du_cache</span> = <span class="var-default">false</span>], <span class="var-type">boolean</span> <span class="var-name">$doNotTestCacheValidity</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">array</span> |
<a href="#getIds" title="details" class="method-name">getIds</a> |
() |
</div> |
|
<div class="method-definition"> |
<span class="method-result">array</span> |
<a href="#getIdsAvecLesTags" title="details" class="method-name">getIdsAvecLesTags</a> |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>]) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">array</span> |
<a href="#getIdsAvecUnTag" title="details" class="method-name">getIdsAvecUnTag</a> |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>]) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">array</span> |
<a href="#getIdsSansLesTags" title="details" class="method-name">getIdsSansLesTags</a> |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>]) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">array</span> |
<a href="#getMetadonnees" title="details" class="method-name">getMetadonnees</a> |
(<span class="var-type">string</span> <span class="var-name">$id</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">int</span> |
<a href="#getPourcentageRemplissage" title="details" class="method-name">getPourcentageRemplissage</a> |
() |
</div> |
|
<div class="method-definition"> |
<span class="method-result">array</span> |
<a href="#getTags" title="details" class="method-name">getTags</a> |
() |
</div> |
|
<div class="method-definition"> |
<span class="method-result">boolean</span> |
<a href="#nettoyer" title="details" class="method-name">nettoyer</a> |
([<span class="var-type">string</span> <span class="var-name">$mode</span> = <span class="var-default">Cache::NETTOYAGE_MODE_TOUS</span>], [<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>]) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">boolean</span> |
<a href="#sauver" title="details" class="method-name">sauver</a> |
(<span class="var-type"></span> <span class="var-name">$donnees</span>, <span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$duree_vie_specifique</span> = <span class="var-default">false</span>], <span class="var-type">string</span> <span class="var-name">$data</span>, <span class="var-type">int</span> <span class="var-name">$specificLifetime</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">void</span> |
<a href="#setEmplacement" title="details" class="method-name">setEmplacement</a> |
(<span class="var-type"></span> <span class="var-name">$emplacement</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">boolean</span> |
<a href="#supprimer" title="details" class="method-name">supprimer</a> |
(<span class="var-type">string</span> <span class="var-name">$id</span>) |
</div> |
|
<div class="method-definition"> |
<span class="method-result">mixed|false</span> |
<a href="#tester" title="details" class="method-name">tester</a> |
(<span class="var-type">string</span> <span class="var-name">$id</span>) |
</div> |
</div> |
</div> |
</div> |
|
<a name="sec-vars"></a> |
<div class="info-box"> |
<div class="info-box-title">Variables</div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
|
|
| |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
</div> |
<div class="info-box-body"> |
|
<a name="var$options" id="$options"><!-- --></A> |
<div class="evenrow"> |
|
<div class="var-header"> |
<span class="var-title"> |
<span class="var-type">array</span> |
<span class="var-name">$options</span> |
= <span class="var-default">array(<br /> 'stockage_chemin' => null,<br /> 'defragmentation_auto' => 10<br /> )</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a20">20</a></span>) |
</span> |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Options disponibles :</p> |
<p class="description"><p>====> (string) stockage_chemin : Chemin vers le fichier contenant la base SQLite.</p><p>====> (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 => pas de défragmentation automatique 1 => défragmentation automatique systématique x (integer) > 1 => défragmentation automatique toutes les 1 fois (au hasard) sur x ajout ou suppression de cache</p></p> |
<ul class="tags"> |
<li><span class="field">var:</span> options disponibles</li> |
<li><span class="field">access:</span> protected</li> |
</ul> |
|
|
|
|
|
</div> |
|
</div> |
</div> |
|
<a name="sec-methods"></a> |
<div class="info-box"> |
<div class="info-box-title">Methods</div> |
<div class="nav-bar"> |
<a href="#sec-description">Description</a> | |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
|
</div> |
<div class="info-box-body"> |
<A NAME='method_detail'></A> |
<a name="method__construct" id="__construct"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a48">48</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Constructor</p> |
<ul class="tags"> |
<li><span class="field">throws:</span> Zend_cache_Exception</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
__construct |
</span> |
([<span class="var-type"></span> <span class="var-name">$options</span> = <span class="var-default">array()</span>], <span class="var-type"><a href="../Framework/Cache.html">Cache</a></span> <span class="var-name">$cache</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$options</span><span class="var-description">: Associative array of options</span> </li> |
<li> |
<span class="var-type"><a href="../Framework/Cache.html">Cache</a></span> |
<span class="var-name">$cache</span> </li> |
</ul> |
|
|
</div> |
<a name="method__destruct" id="__destruct"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">Destructor __destruct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a72">72</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Destructor</p> |
<ul class="tags"> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
__destruct |
</span> |
() |
</div> |
|
|
|
</div> |
<a name="methodajouterSupplementDureeDeVie" id="ajouterSupplementDureeDeVie"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">ajouterSupplementDureeDeVie</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a403">403</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Give (if possible) an extra lifetime to the given cache id</p> |
<ul class="tags"> |
<li><span class="field">return:</span> true if ok</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">boolean</span> |
<span class="method-name"> |
ajouterSupplementDureeDeVie |
</span> |
(<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type"></span> <span class="var-name">$supplement_duree_de_vie</span>, <span class="var-type">int</span> <span class="var-name">$extraLifetime</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$id</span><span class="var-description">: cache id</span> </li> |
<li> |
<span class="var-type">int</span> |
<span class="var-name">$extraLifetime</span> </li> |
<li> |
<span class="var-type"></span> |
<span class="var-name">$supplement_duree_de_vie</span> </li> |
</ul> |
|
|
</div> |
<a name="methodcharger" id="charger"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">charger</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a104">104</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Test if a cache is available for the given id and (if yes) return it (false else)</p> |
<ul class="tags"> |
<li><span class="field">return:</span> Cached datas</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">string|false</span> |
<span class="method-name"> |
charger |
</span> |
(<span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$ne_pas_tester_validiter_du_cache</span> = <span class="var-default">false</span>], <span class="var-type">boolean</span> <span class="var-name">$doNotTestCacheValidity</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$id</span><span class="var-description">: Cache id</span> </li> |
<li> |
<span class="var-type">boolean</span> |
<span class="var-name">$doNotTestCacheValidity</span><span class="var-description">: If set to true, the cache validity won't be tested</span> </li> |
<li> |
<span class="var-type"></span> |
<span class="var-name">$ne_pas_tester_validiter_du_cache</span> </li> |
</ul> |
|
|
</div> |
<a name="methodgetIds" id="getIds"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">getIds</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a209">209</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Return an array of stored cache ids</p> |
<ul class="tags"> |
<li><span class="field">return:</span> array of stored cache ids (string)</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">array</span> |
<span class="method-name"> |
getIds |
</span> |
() |
</div> |
|
|
|
</div> |
<a name="methodgetIdsAvecLesTags" id="getIdsAvecLesTags"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">getIdsAvecLesTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a242">242</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Return an array of stored cache ids which match given tags</p> |
<p class="description"><p>In case of multiple tags, a logical AND is made between tags</p></p> |
<ul class="tags"> |
<li><span class="field">return:</span> array of matching cache ids (string)</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">array</span> |
<span class="method-name"> |
getIdsAvecLesTags |
</span> |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>]) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$tags</span><span class="var-description">: array of tags</span> </li> |
</ul> |
|
|
</div> |
<a name="methodgetIdsAvecUnTag" id="getIdsAvecUnTag"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">getIdsAvecUnTag</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a312">312</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Return an array of stored cache ids which match any given tags</p> |
<p class="description"><p>In case of multiple tags, a logical AND is made between tags</p></p> |
<ul class="tags"> |
<li><span class="field">return:</span> array of any matching cache ids (string)</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">array</span> |
<span class="method-name"> |
getIdsAvecUnTag |
</span> |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>]) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$tags</span><span class="var-description">: array of tags</span> </li> |
</ul> |
|
|
</div> |
<a name="methodgetIdsSansLesTags" id="getIdsSansLesTags"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">getIdsSansLesTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a280">280</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Return an array of stored cache ids which don't match given tags</p> |
<p class="description"><p>In case of multiple tags, a logical OR is made between tags</p></p> |
<ul class="tags"> |
<li><span class="field">return:</span> array of not matching cache ids (string)</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">array</span> |
<span class="method-name"> |
getIdsSansLesTags |
</span> |
([<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>]) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$tags</span><span class="var-description">: array of tags</span> </li> |
</ul> |
|
|
</div> |
<a name="methodgetMetadonnees" id="getMetadonnees"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">getMetadonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a373">373</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Return an array of metadatas for the given cache id</p> |
<p class="description"><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></p> |
<ul class="tags"> |
<li><span class="field">return:</span> array of metadatas (false if the cache id is not found)</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">array</span> |
<span class="method-name"> |
getMetadonnees |
</span> |
(<span class="var-type">string</span> <span class="var-name">$id</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$id</span><span class="var-description">: cache id</span> </li> |
</ul> |
|
|
</div> |
<a name="methodgetPourcentageRemplissage" id="getPourcentageRemplissage"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">getPourcentageRemplissage</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a348">348</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Return the filling percentage of the backend storage</p> |
<ul class="tags"> |
<li><span class="field">return:</span> integer between 0 and 100</li> |
<li><span class="field">throws:</span> Zend_Cache_Exception</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">int</span> |
<span class="method-name"> |
getPourcentageRemplissage |
</span> |
() |
</div> |
|
|
|
</div> |
<a name="methodgetTags" id="getTags"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">getTags</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a224">224</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Return an array of stored tags</p> |
<ul class="tags"> |
<li><span class="field">return:</span> array of stored tags (string)</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">array</span> |
<span class="method-name"> |
getTags |
</span> |
() |
</div> |
|
|
|
</div> |
<a name="methodnettoyer" id="nettoyer"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">nettoyer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a197">197</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Clean some cache records</p> |
<p class="description"><p>Available modes are : Zend_Cache::CLEANING_MODE_ALL (default) => remove all cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_OLD => remove too old cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_MATCHING_TAG => 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 => 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 => remove cache entries matching any given tags ($tags can be an array of strings or a single string)</p></p> |
<ul class="tags"> |
<li><span class="field">return:</span> True if no problem</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">boolean</span> |
<span class="method-name"> |
nettoyer |
</span> |
([<span class="var-type">string</span> <span class="var-name">$mode</span> = <span class="var-default">Cache::NETTOYAGE_MODE_TOUS</span>], [<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>]) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$mode</span><span class="var-description">: Clean mode</span> </li> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$tags</span><span class="var-description">: Array of tags</span> </li> |
</ul> |
|
|
</div> |
<a name="methodsauver" id="sauver"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">sauver</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a140">140</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Save some string datas into a cache record</p> |
<p class="description"><p>Note : $data is always "string" (serialization is done by the core not by the backend)</p></p> |
<ul class="tags"> |
<li><span class="field">return:</span> True if no problem</li> |
<li><span class="field">throws:</span> Zend_Cache_Exception</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">boolean</span> |
<span class="method-name"> |
sauver |
</span> |
(<span class="var-type"></span> <span class="var-name">$donnees</span>, <span class="var-type">string</span> <span class="var-name">$id</span>, [<span class="var-type">array</span> <span class="var-name">$tags</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$duree_vie_specifique</span> = <span class="var-default">false</span>], <span class="var-type">string</span> <span class="var-name">$data</span>, <span class="var-type">int</span> <span class="var-name">$specificLifetime</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$data</span><span class="var-description">: Datas to cache</span> </li> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$id</span><span class="var-description">: Cache id</span> </li> |
<li> |
<span class="var-type">array</span> |
<span class="var-name">$tags</span><span class="var-description">: Array of strings, the cache record will be tagged by each string entry</span> </li> |
<li> |
<span class="var-type">int</span> |
<span class="var-name">$specificLifetime</span><span class="var-description">: If != false, set a specific lifetime for this cache record (null => infinite lifetime)</span> </li> |
<li> |
<span class="var-type"></span> |
<span class="var-name">$donnees</span> </li> |
<li> |
<span class="var-type"></span> |
<span class="var-name">$duree_vie_specifique</span> </li> |
</ul> |
|
|
</div> |
<a name="methodsetEmplacement" id="setEmplacement"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">setEmplacement</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a88">88</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<ul class="tags"> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">void</span> |
<span class="method-name"> |
setEmplacement |
</span> |
(<span class="var-type"></span> <span class="var-name">$emplacement</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type"></span> |
<span class="var-name">$emplacement</span> </li> |
</ul> |
|
|
</div> |
<a name="methodsupprimer" id="supprimer"><!-- --></a> |
<div class="oddrow"> |
|
<div class="method-header"> |
<span class="method-title">supprimer</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a170">170</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Remove a cache record</p> |
<ul class="tags"> |
<li><span class="field">return:</span> True if no problem</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">boolean</span> |
<span class="method-name"> |
supprimer |
</span> |
(<span class="var-type">string</span> <span class="var-name">$id</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$id</span><span class="var-description">: Cache id</span> </li> |
</ul> |
|
|
</div> |
<a name="methodtester" id="tester"><!-- --></a> |
<div class="evenrow"> |
|
<div class="method-header"> |
<span class="method-title">tester</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__CacheSqlite.php.html#a119">119</a></span>) |
</div> |
|
<!-- ========== Info from phpDoc block ========= --> |
<p class="short-description">Test if a cache is available or not (for the given id)</p> |
<ul class="tags"> |
<li><span class="field">return:</span> (a cache is not available) or "last modified" timestamp (int) of the available cache record</li> |
<li><span class="field">access:</span> public</li> |
</ul> |
|
<div class="method-signature"> |
<span class="method-result">mixed|false</span> |
<span class="method-name"> |
tester |
</span> |
(<span class="var-type">string</span> <span class="var-name">$id</span>) |
</div> |
|
<ul class="parameters"> |
<li> |
<span class="var-type">string</span> |
<span class="var-name">$id</span><span class="var-description">: Cache id</span> </li> |
</ul> |
|
|
</div> |
|
</div> |
</div> |
|
|
<p class="notes" id="credit"> |
Documentation generated on Tue, 18 Jan 2011 15:01:27 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
</p> |
</div></body> |
</html> |