New file |
0,0 → 1,2148 |
<!DOCTYPE html> |
<html lang="en"> |
<head> |
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/> |
<meta charset="utf-8"/> |
<title>TBFramework - v0.3</title> |
<meta name="author" content=""/> |
<meta name="description" content=""/> |
|
<link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet"> |
<link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.min.css" rel="stylesheet"> |
<link href="../css/prism.css" rel="stylesheet" media="all"/> |
<link href="../css/template.css" rel="stylesheet" media="all"/> |
|
<!--[if lt IE 9]> |
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script> |
<![endif]--> |
<script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script> |
<script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script> |
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script> |
<script src="../js/jquery.smooth-scroll.js"></script> |
<script src="../js/prism.min.js"></script> |
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit--> |
<script type="text/javascript"> |
function loadExternalCodeSnippets() { |
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) { |
var src = pre.getAttribute('data-src'); |
var extension = (src.match(/\.(\w+)$/) || [, ''])[1]; |
var language = 'php'; |
|
var code = document.createElement('code'); |
code.className = 'language-' + language; |
|
pre.textContent = ''; |
|
code.textContent = 'Loading…'; |
|
pre.appendChild(code); |
|
var xhr = new XMLHttpRequest(); |
|
xhr.open('GET', src, true); |
|
xhr.onreadystatechange = function () { |
if (xhr.readyState == 4) { |
|
if (xhr.status < 400 && xhr.responseText) { |
code.textContent = xhr.responseText; |
|
Prism.highlightElement(code); |
} |
else if (xhr.status >= 400) { |
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText; |
} |
else { |
code.textContent = '✖ Error: File does not exist or is empty'; |
} |
} |
}; |
|
xhr.send(null); |
}); |
} |
|
$(document).ready(function(){ |
loadExternalCodeSnippets(); |
}); |
$('#source-view').on('shown', function () { |
loadExternalCodeSnippets(); |
}) |
</script> |
|
<link rel="shortcut icon" href="../images/favicon.ico"/> |
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/> |
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/> |
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/> |
</head> |
<body> |
|
<div class="navbar navbar-fixed-top"> |
<div class="navbar-inner"> |
<div class="container"> |
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> |
<i class="icon-ellipsis-vertical"></i> |
</a> |
<a class="brand" href="../index.html">TBFramework - v0.3</a> |
|
<div class="nav-collapse"> |
<ul class="nav pull-right"> |
<li class="dropdown"> |
<a href="../index.html" class="dropdown-toggle" data-toggle="dropdown"> |
API Documentation <b class="caret"></b> |
</a> |
<ul class="dropdown-menu"> |
</ul> |
</li> |
<li class="dropdown" id="charts-menu"> |
<a href="#" class="dropdown-toggle" data-toggle="dropdown"> |
Charts <b class="caret"></b> |
</a> |
<ul class="dropdown-menu"> |
<li> |
<a href="../graphs/class.html"> |
<i class="icon-list-alt"></i> Class hierarchy diagram |
</a> |
</li> |
</ul> |
</li> |
<li class="dropdown" id="reports-menu"> |
<a href="#" class="dropdown-toggle" data-toggle="dropdown"> |
Reports <b class="caret"></b> |
</a> |
<ul class="dropdown-menu"> |
<li> |
<a href="../reports/errors.html"> |
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">268</span> |
</a> |
</li> |
<li> |
<a href="../reports/markers.html"> |
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">11</span> |
</a> |
</li> |
</ul> |
</li> |
</ul> |
</div> |
</div> |
</div> |
<!--<div class="go_to_top">--> |
<!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>--> |
<!--</div>--> |
</div> |
|
<div id="___" class="container-fluid"> |
<section class="row-fluid"> |
<div class="span2 sidebar"> |
<div class="accordion" style="margin-bottom: 0"> |
<div class="accordion-group"> |
<div class="accordion-heading"> |
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1720629249"></a> |
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
</div> |
<div id="namespace-1720629249" class="accordion-body collapse in"> |
<div class="accordion-inner"> |
|
|
<ul> |
<li class="class"><a href="../classes/Url.html">Url</a></li> |
<li class="class"><a href="../classes/Debug.html">Debug</a></li> |
<li class="class"><a href="../classes/Chronometre.html">Chronometre</a></li> |
<li class="class"><a href="../classes/RestServeur.html">RestServeur</a></li> |
<li class="class"><a href="../classes/SquelettePhp.html">SquelettePhp</a></li> |
<li class="class"><a href="../classes/Controleur.html">Controleur</a></li> |
<li class="class"><a href="../classes/Cache.html">Cache</a></li> |
<li class="class"><a href="../classes/RestClient.html">RestClient</a></li> |
<li class="class"><a href="../classes/GestionnaireException.html">GestionnaireException</a></li> |
<li class="class"><a href="../classes/Script.html">Script</a></li> |
<li class="class"><a href="../classes/Registre.html">Registre</a></li> |
<li class="class"><a href="../classes/RestService.html">RestService</a></li> |
<li class="class"><a href="../classes/Cli.html">Cli</a></li> |
<li class="class"><a href="../classes/Encodage.html">Encodage</a></li> |
<li class="class"><a href="../classes/Tableau.html">Tableau</a></li> |
<li class="class"><a href="../classes/Pattern.html">Pattern</a></li> |
<li class="class"><a href="../classes/Chaine.html">Chaine</a></li> |
<li class="class"><a href="../classes/Fichier.html">Fichier</a></li> |
<li class="class"><a href="../classes/I18n.html">I18n</a></li> |
<li class="class"><a href="../classes/Config.html">Config</a></li> |
<li class="class"><a href="../classes/CacheSqlite.html">CacheSqlite</a></li> |
<li class="class"><a href="../classes/Bdd.html">Bdd</a></li> |
<li class="class"><a href="../classes/Log.html">Log</a></li> |
<li class="class"><a href="../classes/CacheFichier.html">CacheFichier</a></li> |
<li class="class"><a href="../classes/Framework.html">Framework</a></li> |
<li class="class"><a href="../classes/CacheSimple.html">CacheSimple</a></li> |
</ul> |
</div> |
</div> |
</div> |
</div> |
|
</div> |
</section> |
<section class="row-fluid"> |
<div class="span10 offset2"> |
<div class="row-fluid"> |
<div class="span8 content class"> |
<nav> |
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i> |
</nav> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a> |
|
<h1><small>\</small>CacheFichier</h1> |
<p><em></em></p> |
|
|
<section id="summary"> |
<h2>Summary</h2> |
<section class="row-fluid heading"> |
<section class="span4"> |
<a href="#methods">Methods</a> |
</section> |
<section class="span4"> |
<a href="#properties">Properties</a> |
</section> |
<section class="span4"> |
<a href="#constants">Constants</a> |
</section> |
</section> |
<section class="row-fluid public"> |
<section class="span4"> |
<a href="../classes/CacheFichier.html#method___construct" class="">__construct()</a><br /> |
<a href="../classes/CacheFichier.html#method_setEmplacement" class="">setEmplacement()</a><br /> |
<a href="../classes/CacheFichier.html#method_charger" class="">charger()</a><br /> |
<a href="../classes/CacheFichier.html#method_tester" class="">tester()</a><br /> |
<a href="../classes/CacheFichier.html#method_sauver" class="">sauver()</a><br /> |
<a href="../classes/CacheFichier.html#method_supprimer" class="">supprimer()</a><br /> |
<a href="../classes/CacheFichier.html#method_nettoyer" class="">nettoyer()</a><br /> |
<a href="../classes/CacheFichier.html#method_getIds" class="">getIds()</a><br /> |
<a href="../classes/CacheFichier.html#method_getTags" class="">getTags()</a><br /> |
<a href="../classes/CacheFichier.html#method_getIdsAvecLesTags" class="">getIdsAvecLesTags()</a><br /> |
<a href="../classes/CacheFichier.html#method_getIdsSansLesTags" class="">getIdsSansLesTags()</a><br /> |
<a href="../classes/CacheFichier.html#method_getIdsAvecUnTag" class="">getIdsAvecUnTag()</a><br /> |
<a href="../classes/CacheFichier.html#method_getPourcentageRemplissage" class="">getPourcentageRemplissage()</a><br /> |
<a href="../classes/CacheFichier.html#method_getMetadonnees" class="">getMetadonnees()</a><br /> |
<a href="../classes/CacheFichier.html#method_ajouterSupplementDureeDeVie" class="">ajouterSupplementDureeDeVie()</a><br /> |
</section> |
<section class="span4"> |
<em>No public properties found</em> |
</section> |
<section class="span4"> |
<em>No constants found</em> |
</section> |
</section> |
<section class="row-fluid protected"> |
<section class="span4"> |
<a href="../classes/CacheFichier.html#method_getMetadonneesFichier" class="">getMetadonneesFichier()</a><br /> |
<a href="../classes/CacheFichier.html#method_setMetadonnees" class="">setMetadonnees()</a><br /> |
<a href="../classes/CacheFichier.html#method_supprimerMetadonnees" class="">supprimerMetadonnees()</a><br /> |
<a href="../classes/CacheFichier.html#method_nettoyerMetadonnees" class="">nettoyerMetadonnees()</a><br /> |
<a href="../classes/CacheFichier.html#method_chargerMetadonnees" class="">chargerMetadonnees()</a><br /> |
<a href="../classes/CacheFichier.html#method_sauverMetadonnees" class="">sauverMetadonnees()</a><br /> |
<a href="../classes/CacheFichier.html#method_getNomFichierMeta" class="">getNomFichierMeta()</a><br /> |
<a href="../classes/CacheFichier.html#method_etreFichierMeta" class="">etreFichierMeta()</a><br /> |
<a href="../classes/CacheFichier.html#method_supprimerFichier" class="">supprimerFichier()</a><br /> |
<a href="../classes/CacheFichier.html#method_nettoyerFichiers" class="">nettoyerFichiers()</a><br /> |
<a href="../classes/CacheFichier.html#method_analyserCache" class="">analyserCache()</a><br /> |
<a href="../classes/CacheFichier.html#method_genererCleSecu" class="">genererCleSecu()</a><br /> |
<a href="../classes/CacheFichier.html#method_transformaterIdEnNomFichier" class="">transformaterIdEnNomFichier()</a><br /> |
<a href="../classes/CacheFichier.html#method_getFichierNom" class="">getFichierNom()</a><br /> |
<a href="../classes/CacheFichier.html#method_getChemin" class="">getChemin()</a><br /> |
<a href="../classes/CacheFichier.html#method_lancerMkdirEtChmodRecursif" class="">lancerMkdirEtChmodRecursif()</a><br /> |
<a href="../classes/CacheFichier.html#method_testerExistenceCache" class="">testerExistenceCache()</a><br /> |
<a href="../classes/CacheFichier.html#method_getContenuFichier" class="">getContenuFichier()</a><br /> |
<a href="../classes/CacheFichier.html#method_setContenuFichier" class="">setContenuFichier()</a><br /> |
<a href="../classes/CacheFichier.html#method_transformerNomFichierEnId" class="">transformerNomFichierEnId()</a><br /> |
</section> |
<section class="span4"> |
<a href="../classes/CacheFichier.html#property_options" class="">$options</a><br /> |
<a href="../classes/CacheFichier.html#property_metadonnees" class="">$metadonnees</a><br /> |
</section> |
<section class="span4"> |
<em>N/A</em> |
</section> |
</section> |
<section class="row-fluid private"> |
<section class="span4"> |
<a href="../classes/CacheFichier.html#method_initialiserOptionsParConfig" class="">initialiserOptionsParConfig()</a><br /> |
<a href="../classes/CacheFichier.html#method_setOptions" class="">setOptions()</a><br /> |
</section> |
<section class="span4"> |
<a href="../classes/CacheFichier.html#property_Cache" class="">$Cache</a><br /> |
</section> |
<section class="span4"> |
<em>N/A</em> |
</section> |
</section> |
</section> |
</div> |
<aside class="span4 detailsbar"> |
|
|
<dl> |
<dt>File</dt> |
<dd><a href="../files/CacheFichier.php.html"><div class="path-wrapper">CacheFichier.php</div></a></dd> |
<dt>Class hierarchy</dt> |
<dd class="hierarchy"> |
<div class="namespace-wrapper">\CacheFichier</div> |
</dd> |
|
|
|
|
|
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
|
<a id="properties" name="properties"></a> |
<div class="row-fluid"> |
<div class="span8 content class"> |
<h2>Properties</h2> |
</div> |
<aside class="span4 detailsbar"></aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="property_options" name="property_options" class="anchor"></a> |
<article class="property"> |
<h3 class="protected ">$options</h3> |
<pre class="signature">$options : array</pre> |
<p><em>Options disponibles</em></p> |
<p>====> (string) stockage_chemin : |
Chemin vers le dossier devant contenir l'arborescence du cache.</p> |
<p>=====> (boolean) fichier_verrou :</p> |
<ul> |
<li>Active / Désactive le verrouillage des fichiers</li> |
<li>Peut éviter la corruption du cache dans de mauvaises circonstances, mais cela ne fonctionne pas sur des serveur |
multithread et sur les systèmes de fichiers NFS par exemple.</li> |
</ul> |
<p>=====> (boolean) controle_lecture :</p> |
<ul> |
<li>Activer / désactiver le contrôle de lecture</li> |
<li>S'il est activé, une clé de contrôle est ajoutée dans le fichier de cache et cette clé est comparée avec celle calculée |
après la lecture.</li> |
</ul> |
<p>=====> (string) controle_lecture_type : |
Type de contrôle de lecture (seulement si le contrôle de lecture est activé). |
Les valeurs disponibles sont:</p> |
<ul> |
<li>«md5» pour un contrôle md5 (le meilleur mais le plus lent)</li> |
<li>«crc32» pour un contrôle de hachage crc32 (un peu moins sécurisé, mais plus rapide, un meilleur choix)</li> |
<li>«adler32» pour un contrôle de hachage adler32 (excellent choix aussi, plus rapide que crc32)</li> |
<li>«strlen» pour un test de longueur uniquement (le plus rapide)</li> |
</ul> |
<p>=====> (int) dossier_niveau :</p> |
<ul> |
<li>Permet de réglez le nombre de niveau de sous-dossier que contiendra l'arborescence des dossiers du cache. |
0 signifie "pas de sous-dossier pour le cache", |
1 signifie "un niveau de sous-dossier", |
2 signifie "deux niveaux" ... |
Cette option peut accélérer le cache seulement lorsque vous avez plusieurs centaines de fichiers de cache. |
Seuls des tests spécifiques peuvent vous aider à choisir la meilleure valeur possible pour vous. |
1 ou 2 peut être est un bon début.</li> |
</ul> |
<p>=====> (int) dossier_umask :</p> |
<ul> |
<li>Umask pour les sous-dossiers de l'arborescence du cache.</li> |
</ul> |
<p>=====> (string) fichier_prefixe :</p> |
<ul> |
<li>préfixe pour les fichiers du cache</li> |
<li>ATTENTION : faite vraiment attention avec cette option, car une valeur trop générique dans le dossier cache du système |
(comme /tmp) peut provoquer des catastrophes lors du nettoyage du cache.</li> |
</ul> |
<p>=====> (int) fichier_umask :</p> |
<ul> |
<li>Umask pour les fichiers de cache</li> |
</ul> |
<p>=====> (int) metadonnees_max_taille :</p> |
<ul> |
<li>taille maximum pour le tableau de métadonnées du cache (ne changer pas cette valeur sauf si vous savez ce que vous faite)</li> |
</ul> |
|
<h4>Type</h4> |
array |
— options disponibles </article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="property_metadonnees" name="property_metadonnees" class="anchor"></a> |
<article class="property"> |
<h3 class="protected ">$metadonnees</h3> |
<pre class="signature">$metadonnees : array</pre> |
<p><em>Array of metadatas (each item is an associative array)</em></p> |
|
|
<h4>Type</h4> |
array |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="property_Cache" name="property_Cache" class="anchor"></a> |
<article class="property"> |
<h3 class="private ">$Cache</h3> |
<pre class="signature">$Cache</pre> |
<p><em></em></p> |
|
|
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
|
<a id="methods" name="methods"></a> |
<div class="row-fluid"> |
<div class="span8 content class"><h2>Methods</h2></div> |
<aside class="span4 detailsbar"></aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method___construct" name="method___construct" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">__construct()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">__construct(array <span class="argument">$options</span>, \Cache <span class="argument">$cache</span>) : void</pre> |
<p><em>Constructor</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>array</td> |
<td>$options</td> |
<td><p>associative array of options</p></td> |
</tr> |
<tr> |
<td><a href="../classes/Cache.html">\Cache</a></td> |
<td>$cache</td> |
<td></td> |
</tr> |
</table> |
|
<h4>Throws</h4> |
<dl> |
<dt>\Zend_Cache_Exception</dt> |
<dd></dd> |
</dl> |
|
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_setEmplacement" name="method_setEmplacement" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">setEmplacement()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">setEmplacement( <span class="argument">$emplacement</span>)</pre> |
<p><em></em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$emplacement</td> |
<td></td> |
</tr> |
</table> |
|
|
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_charger" name="method_charger" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">charger()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">charger(string <span class="argument">$id</span>, <span class="argument">$ne_pas_tester_validiter_du_cache</span>) : string|false</pre> |
<p><em>Test if a cache is available for the given id and (if yes) return it (false else)</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>cache id</p></td> |
</tr> |
<tr> |
<td></td> |
<td>$ne_pas_tester_validiter_du_cache</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
string|false |
— <p>cached datas</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_tester" name="method_tester" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">tester()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">tester(string <span class="argument">$id</span>) : mixed</pre> |
<p><em>Teste si un enregistrement en cache est disponible ou pas (pour l'id passé en paramètre).</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>identifiant de cache.</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
mixed |
— <p>false (le cache n'est pas disponible) ou timestamp (int) "de dernière modification" de l'enregistrement en cache</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_sauver" name="method_sauver" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">sauver()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">sauver( <span class="argument">$donnees</span>, string <span class="argument">$id</span>, array <span class="argument">$tags</span>, <span class="argument">$duree_vie_specifique</span>) : boolean</pre> |
<p><em>Save some string datas into a cache record</em></p> |
<p>Note : $data is always "string" (serialization is done by the |
core not by the backend)</p> |
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$donnees</td> |
<td></td> |
</tr> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
<tr> |
<td>array</td> |
<td>$tags</td> |
<td><p>Array of strings, the cache record will be tagged by each string entry</p></td> |
</tr> |
<tr> |
<td></td> |
<td>$duree_vie_specifique</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>true if no problem</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_supprimer" name="method_supprimer" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">supprimer()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">supprimer(string <span class="argument">$id</span>) : boolean</pre> |
<p><em>Remove a cache record</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>cache id</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>true if no problem</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_nettoyer" name="method_nettoyer" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">nettoyer()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">nettoyer(string <span class="argument">$mode</span>, <span class="argument">$tags</span>) : boolean</pre> |
<p><em>Clean some cache records</em></p> |
<p>Available modes are : |
'all' (default) => remove all cache entries ($tags is not used) |
'old' => remove too old cache entries ($tags is not used) |
'matchingTag' => remove cache entries matching all given tags</p> |
<pre><code> ($tags can be an array of strings or a single string)</code></pre> |
<p>'notMatchingTag' => remove cache entries not matching one of the given tags</p> |
<pre><code> ($tags can be an array of strings or a single string)</code></pre> |
<p>'matchingAnyTag' => remove cache entries matching any given tags</p> |
<pre><code> ($tags can be an array of strings or a single string)</code></pre> |
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$mode</td> |
<td><p>clean mode</p></td> |
</tr> |
<tr> |
<td></td> |
<td>$tags</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>true if no problem</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getIds" name="method_getIds" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">getIds()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getIds() : array</pre> |
<p><em>Return an array of stored cache ids</em></p> |
|
|
|
|
<h4>Returns</h4> |
array |
— <p>array of stored cache ids (string)</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getTags" name="method_getTags" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">getTags()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getTags() : array</pre> |
<p><em>Return an array of stored tags</em></p> |
|
|
|
|
<h4>Returns</h4> |
array |
— <p>array of stored tags (string)</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getIdsAvecLesTags" name="method_getIdsAvecLesTags" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">getIdsAvecLesTags()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getIdsAvecLesTags(array <span class="argument">$tags</span>) : array</pre> |
<p><em>Return an array of stored cache ids which match given tags</em></p> |
<p>In case of multiple tags, a logical AND is made between tags</p> |
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>array</td> |
<td>$tags</td> |
<td><p>array of tags</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
array |
— <p>array of matching cache ids (string)</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getIdsSansLesTags" name="method_getIdsSansLesTags" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">getIdsSansLesTags()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getIdsSansLesTags(array <span class="argument">$tags</span>) : array</pre> |
<p><em>Return an array of stored cache ids which don't match given tags</em></p> |
<p>In case of multiple tags, a logical OR is made between tags</p> |
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>array</td> |
<td>$tags</td> |
<td><p>array of tags</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
array |
— <p>array of not matching cache ids (string)</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getIdsAvecUnTag" name="method_getIdsAvecUnTag" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">getIdsAvecUnTag()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getIdsAvecUnTag(array <span class="argument">$tags</span>) : array</pre> |
<p><em>Return an array of stored cache ids which match any given tags</em></p> |
<p>In case of multiple tags, a logical AND is made between tags</p> |
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>array</td> |
<td>$tags</td> |
<td><p>array of tags</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
array |
— <p>array of any matching cache ids (string)</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getPourcentageRemplissage" name="method_getPourcentageRemplissage" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">getPourcentageRemplissage()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getPourcentageRemplissage() : int</pre> |
<p><em>Return the filling percentage of the backend storage</em></p> |
|
|
|
<h4>Throws</h4> |
<dl> |
<dt>\Zend_Cache_Exception</dt> |
<dd></dd> |
</dl> |
|
<h4>Returns</h4> |
int |
— <p>integer between 0 and 100</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getMetadonnees" name="method_getMetadonnees" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">getMetadonnees()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getMetadonnees(string <span class="argument">$id</span>) : array</pre> |
<p><em>Return an array of metadatas for the given cache id</em></p> |
<p>The array must include these keys :</p> |
<ul> |
<li>expire : the expire timestamp</li> |
<li>tags : a string array of tags</li> |
<li>mtime : timestamp of last modification time</li> |
</ul> |
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>cache id</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
array |
— <p>array of metadatas (false if the cache id is not found)</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_ajouterSupplementDureeDeVie" name="method_ajouterSupplementDureeDeVie" class="anchor"></a> |
<article class="method"> |
<h3 class="public ">ajouterSupplementDureeDeVie()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">ajouterSupplementDureeDeVie(string <span class="argument">$id</span>, <span class="argument">$supplement_duree_de_vie</span>) : boolean</pre> |
<p><em>Give (if possible) an extra lifetime to the given cache id</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>cache id</p></td> |
</tr> |
<tr> |
<td></td> |
<td>$supplement_duree_de_vie</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>true if ok</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getMetadonneesFichier" name="method_getMetadonneesFichier" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">getMetadonneesFichier()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getMetadonneesFichier(string <span class="argument">$id</span>) : array|false</pre> |
<p><em>Get a metadatas record</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
array|false |
— <p>Associative array of metadatas</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_setMetadonnees" name="method_setMetadonnees" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">setMetadonnees()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">setMetadonnees(string <span class="argument">$id</span>, <span class="argument">$metadonnees</span>, <span class="argument">$sauvegarde</span>) : boolean</pre> |
<p><em>Set a metadatas record</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
<tr> |
<td></td> |
<td>$metadonnees</td> |
<td></td> |
</tr> |
<tr> |
<td></td> |
<td>$sauvegarde</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>True if no problem</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_supprimerMetadonnees" name="method_supprimerMetadonnees" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">supprimerMetadonnees()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">supprimerMetadonnees(string <span class="argument">$id</span>) : boolean</pre> |
<p><em>Drop a metadata record</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>True if no problem</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_nettoyerMetadonnees" name="method_nettoyerMetadonnees" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">nettoyerMetadonnees()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">nettoyerMetadonnees() : void</pre> |
<p><em>Clear the metadatas array</em></p> |
|
|
|
|
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_chargerMetadonnees" name="method_chargerMetadonnees" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">chargerMetadonnees()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">chargerMetadonnees(string <span class="argument">$id</span>) : array|false</pre> |
<p><em>Load metadatas from disk</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
array|false |
— <p>Metadatas associative array</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_sauverMetadonnees" name="method_sauverMetadonnees" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">sauverMetadonnees()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">sauverMetadonnees(string <span class="argument">$id</span>, <span class="argument">$metadonnees</span>) : boolean</pre> |
<p><em>Save metadatas to disk</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
<tr> |
<td></td> |
<td>$metadonnees</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>True if no problem</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getNomFichierMeta" name="method_getNomFichierMeta" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">getNomFichierMeta()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getNomFichierMeta(string <span class="argument">$id</span>) : string</pre> |
<p><em>Make and return a file name (with path) for metadatas</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
string |
— <p>Metadatas file name (with path)</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_etreFichierMeta" name="method_etreFichierMeta" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">etreFichierMeta()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">etreFichierMeta( <span class="argument">$fichier_nom</span>) : boolean</pre> |
<p><em>Check if the given filename is a metadatas one</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$fichier_nom</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>True if it's a metadatas one</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_supprimerFichier" name="method_supprimerFichier" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">supprimerFichier()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">supprimerFichier( <span class="argument">$fichier</span>) : boolean</pre> |
<p><em>Remove a file</em></p> |
<p>If we can't remove the file (because of locks or any problem), we will touch |
the file to invalidate it</p> |
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$fichier</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>True if ok</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_nettoyerFichiers" name="method_nettoyerFichiers" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">nettoyerFichiers()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">nettoyerFichiers( <span class="argument">$dossier</span>, string <span class="argument">$mode</span>, array <span class="argument">$tags</span>) : boolean</pre> |
<p><em>Clean some cache records (protected method used for recursive stuff)</em></p> |
<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</p> |
<pre><code> ($tags can be an array of strings or a single string)</code></pre> |
<p>Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => remove cache entries not {matching one of the given tags}</p> |
<pre><code> ($tags can be an array of strings or a single string)</code></pre> |
<p>Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags</p> |
<pre><code> ($tags can be an array of strings or a single string)</code></pre> |
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$dossier</td> |
<td></td> |
</tr> |
<tr> |
<td>string</td> |
<td>$mode</td> |
<td><p>Clean mode</p></td> |
</tr> |
<tr> |
<td>array</td> |
<td>$tags</td> |
<td><p>Array of tags</p></td> |
</tr> |
</table> |
|
<h4>Throws</h4> |
<dl> |
<dt>\Zend_Cache_Exception</dt> |
<dd></dd> |
</dl> |
|
<h4>Returns</h4> |
boolean |
— <p>True if no problem</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_analyserCache" name="method_analyserCache" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">analyserCache()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">analyserCache( <span class="argument">$dossier</span>, <span class="argument">$mode</span>, <span class="argument">$tags</span>)</pre> |
<p><em></em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$dossier</td> |
<td></td> |
</tr> |
<tr> |
<td></td> |
<td>$mode</td> |
<td></td> |
</tr> |
<tr> |
<td></td> |
<td>$tags</td> |
<td></td> |
</tr> |
</table> |
|
|
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_genererCleSecu" name="method_genererCleSecu" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">genererCleSecu()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">genererCleSecu( <span class="argument">$donnees</span>, <span class="argument">$type_de_controle</span>) : string</pre> |
<p><em>Make a control key with the string containing datas</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$donnees</td> |
<td></td> |
</tr> |
<tr> |
<td></td> |
<td>$type_de_controle</td> |
<td></td> |
</tr> |
</table> |
|
<h4>Throws</h4> |
<dl> |
<dt>\Zend_Cache_Exception</dt> |
<dd></dd> |
</dl> |
|
<h4>Returns</h4> |
string |
— <p>Control key</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_transformaterIdEnNomFichier" name="method_transformaterIdEnNomFichier" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">transformaterIdEnNomFichier()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">transformaterIdEnNomFichier(string <span class="argument">$id</span>) : string</pre> |
<p><em>Transform a cache id into a file name and return it</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
string |
— <p>File name</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getFichierNom" name="method_getFichierNom" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">getFichierNom()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getFichierNom(string <span class="argument">$id</span>) : string</pre> |
<p><em>Make and return a file name (with path)</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
string |
— <p>File name (with path)</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getChemin" name="method_getChemin" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">getChemin()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getChemin(string <span class="argument">$id</span>, boolean <span class="argument">$decoupage</span>) : string</pre> |
<p><em>Return the complete directory path of a filename (including hashedDirectoryStructure)</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
<tr> |
<td>boolean</td> |
<td>$decoupage</td> |
<td><p>if true, returns array of directory parts instead of single string</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
string |
— <p>Complete directory path</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_lancerMkdirEtChmodRecursif" name="method_lancerMkdirEtChmodRecursif" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">lancerMkdirEtChmodRecursif()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">lancerMkdirEtChmodRecursif(string <span class="argument">$id</span>) : boolean</pre> |
<p><em>Make the directory strucuture for the given id</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>cache id</p></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>true</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_testerExistenceCache" name="method_testerExistenceCache" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">testerExistenceCache()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">testerExistenceCache(string <span class="argument">$id</span>, <span class="argument">$ne_pas_tester_validiter_du_cache</span>) : boolean|mixed</pre> |
<p><em>Test if the given cache id is available (and still valid as a cache record)</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td>string</td> |
<td>$id</td> |
<td><p>Cache id</p></td> |
</tr> |
<tr> |
<td></td> |
<td>$ne_pas_tester_validiter_du_cache</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean|mixed |
— <p>false (a cache is not available) or "last modified" timestamp (int) of the available cache record</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_getContenuFichier" name="method_getContenuFichier" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">getContenuFichier()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">getContenuFichier( <span class="argument">$fichier</span>) : string</pre> |
<p><em>Return the file content of the given file</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$fichier</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
string |
— <p>File content (or false if problem)</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_setContenuFichier" name="method_setContenuFichier" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">setContenuFichier()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">setContenuFichier( <span class="argument">$fichier</span>, <span class="argument">$chaine</span>) : boolean</pre> |
<p><em>Put the given string into the given file</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$fichier</td> |
<td></td> |
</tr> |
<tr> |
<td></td> |
<td>$chaine</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
boolean |
— <p>true if no problem</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_transformerNomFichierEnId" name="method_transformerNomFichierEnId" class="anchor"></a> |
<article class="method"> |
<h3 class="protected ">transformerNomFichierEnId()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">transformerNomFichierEnId( <span class="argument">$nom_de_fichier</span>) : string</pre> |
<p><em>Transform a file name into cache id and return it</em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$nom_de_fichier</td> |
<td></td> |
</tr> |
</table> |
|
|
<h4>Returns</h4> |
string |
— <p>Cache id</p> |
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_initialiserOptionsParConfig" name="method_initialiserOptionsParConfig" class="anchor"></a> |
<article class="method"> |
<h3 class="private ">initialiserOptionsParConfig()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">initialiserOptionsParConfig()</pre> |
<p><em></em></p> |
|
|
|
|
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
<div class="row-fluid"> |
<div class="span8 content class"> |
<a id="method_setOptions" name="method_setOptions" class="anchor"></a> |
<article class="method"> |
<h3 class="private ">setOptions()</h3> |
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> |
<pre class="signature" style="margin-right: 54px;">setOptions( <span class="argument">$options</span>)</pre> |
<p><em></em></p> |
|
|
<h4>Parameters</h4> |
<table class="table table-condensed table-hover"> |
<tr> |
<td></td> |
<td>$options</td> |
<td></td> |
</tr> |
</table> |
|
|
</article> |
</div> |
<aside class="span4 detailsbar"> |
<h1><i class="icon-arrow-down"></i></h1> |
<dl> |
</dl> |
<h2>Tags</h2> |
<table class="table table-condensed"> |
<tr> |
<th> |
todo |
</th> |
<td> |
</td> |
</tr> |
</table> |
</aside> |
</div> |
|
</div> |
</section> |
|
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true"> |
<div class="modal-header"> |
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> |
<h3 id="source-view-label">CacheFichier.php</h3> |
</div> |
<div class="modal-body"> |
<pre data-src="../files/CacheFichier.php.txt" class="language-php line-numbers"></pre> |
</div> |
</div> |
|
<footer class="row-fluid"> |
<section class="span10 offset2"> |
<section class="row-fluid"> |
<section class="span10 offset1"> |
<section class="row-fluid footer-sections"> |
<section class="span4"> |
<h1><i class="icon-code"></i></h1> |
<div> |
<ul> |
</ul> |
</div> |
</section> |
<section class="span4"> |
<h1><i class="icon-bar-chart"></i></h1> |
<div> |
<ul> |
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li> |
</ul> |
</div> |
</section> |
<section class="span4"> |
<h1><i class="icon-pushpin"></i></h1> |
<div> |
<ul> |
<li><a href="../reports/errors.html">Errors</a></li> |
<li><a href="../reports/markers.html">Markers</a></li> |
</ul> |
</div> |
</section> |
</section> |
</section> |
</section> |
<section class="row-fluid"> |
<section class="span10 offset1"> |
<hr /> |
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored |
on March 12th, 2014 at 16:53. |
</section> |
</section> |
</section> |
</footer> |
</div> |
|
</body> |
</html> |