| /branches/v0.3-aleaume/doc/PhpDoc/classes/RestServeur.html |
|---|
| New file |
| 0,0 → 1,2490 |
| <!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-453238565"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-453238565" 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>RestServeur</h1> |
| <p><em>Classe principale gérant les services web de type (@link(REST, http://fr.wikipedia.org/wiki/Rest).</em></p> |
| <p>Elle contient :</p> |
| <ul> |
| <li>les constantes indiquant les différentes (@link(méthode HTTP, <a href="http://fr.wikipedia.org/wiki/Http">http://fr.wikipedia.org/wiki/Http</a>) prises en compte.</li> |
| <li>les @link(codes HTTP des réponses, <a href="http://fr.wikipedia.org/wiki/Liste_des_codes_HTTP">http://fr.wikipedia.org/wiki/Liste_des_codes_HTTP</a>)</li> |
| </ul> |
| <p>Ce serveur REST accepte 4 types de méthodes HTTP : GET, PUT, POST, DELETE. |
| GET et POST ne pose généralement pas de problème pour les clients HTTP mais ce n'est pas forcément le cas pour PUT et DELETE. |
| Vous pouvez donc pour réaliser :</p> |
| <ul> |
| <li>DELETE : utiliser la méthode POST avec action=DELETE dans le corps de la requête.</li> |
| <li>PUT : utiliser la méthode POST avec une url ne contenant aucune indication de ressource. |
| Une autre solution consiste à utiliser n'importe quelle méthode et à ajouter l'entête "X_HTTP_METHOD_OVERRIDE" avec pour |
| valeur le nom de la méthode que vous souhaitez utiliser. Exemple d'entête : "X_HTTP_METHOD_OVERRIDE: PUT". |
| Exemple : <code>curl -v -v -H "X_HTTP_METHOD_OVERRIDE: DELETE" "<a href="http://www.mondomaine.org/services/apiVersion/[mon-service]/"</code">http://www.mondomaine.org/services/apiVersion/[mon-service]/"</code</a>> |
| Cela fonctionne avec Apache.</li> |
| </ul> |
| <p>Les classes des services web doivent avoir un nom au format ChatMot "MonService" et être appelée dans l'url par le même nom |
| en minuscule où les mots sont séparés par des tirets "mon-service".</p> |
| <p>Paramètres liés dans config.ini :</p> |
| <ul> |
| <li>serveur.baseURL : morceau de l'url pour appeler le serveur relative au domaine. Exemple : pour <a href="http://www.tela-botanica.org/mon_serveur/">http://www.tela-botanica.org/mon_serveur/</a> |
| mettre : "/mon_serveur/"</li> |
| <li>serveur.baseAlternativeURL : sur le même principe que ci-dessus permet d'affecter une deuxième url (pour gérer des raccourci via htaccess)</li> |
| </ul> |
| <p>Encodage en entrée : utf8 |
| Encodage en sortie : utf8</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/RestServeur.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/RestServeur.html#method_chargerClasse" class="">chargerClasse()</a><br /> |
| <a href="../classes/RestServeur.html#method_executer" class="">executer()</a><br /> |
| <a href="../classes/RestServeur.html#method_envoyerEnteteStatutHttp" class="">envoyerEnteteStatutHttp()</a><br /> |
| <a href="../classes/RestServeur.html#method_gererErreurs" class="">gererErreurs()</a><br /> |
| <a href="../classes/RestServeur.html#method_ajouterMessage" class="">ajouterMessage()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No public properties found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/RestServeur.html#constant_METHODE_GET" class="">METHODE_GET</a><br /> |
| <a href="../classes/RestServeur.html#constant_METHODE_POST" class="">METHODE_POST</a><br /> |
| <a href="../classes/RestServeur.html#constant_METHODE_DELETE" class="">METHODE_DELETE</a><br /> |
| <a href="../classes/RestServeur.html#constant_METHODE_PUT" class="">METHODE_PUT</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_OK" class="">HTTP_CODE_OK</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_CREATION_OK" class="">HTTP_CODE_CREATION_OK</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_ACCEPTE_OK" class="">HTTP_CODE_ACCEPTE_OK</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_SUPPRESSION_OK" class="">HTTP_CODE_SUPPRESSION_OK</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_MAUVAISE_REQUETE" class="">HTTP_CODE_MAUVAISE_REQUETE</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_ACCES_NON_AUTORISE" class="">HTTP_CODE_ACCES_NON_AUTORISE</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_ACCES_INTERDIT" class="">HTTP_CODE_ACCES_INTERDIT</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_RESSOURCE_INTROUVABLE" class="">HTTP_CODE_RESSOURCE_INTROUVABLE</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_METHODE_NON_AUTORISE" class="">HTTP_CODE_METHODE_NON_AUTORISE</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_CONFLIT" class="">HTTP_CODE_CONFLIT</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_CONTENU_REQUIS" class="">HTTP_CODE_CONTENU_REQUIS</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_ECHEC_CONDITION" class="">HTTP_CODE_ECHEC_CONDITION</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_CONTENU_NON_SUPPORTE" class="">HTTP_CODE_CONTENU_NON_SUPPORTE</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_ERREUR" class="">HTTP_CODE_ERREUR</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_CODE_SERVICE_INDISPONIBLE" class="">HTTP_CODE_SERVICE_INDISPONIBLE</a><br /> |
| <a href="../classes/RestServeur.html#constant_HTTP_NON_IMPLEMENTE" class="">HTTP_NON_IMPLEMENTE</a><br /> |
| <a href="../classes/RestServeur.html#constant_MOTIF_API_VERSION" class="">MOTIF_API_VERSION</a><br /> |
| <a href="../classes/RestServeur.html#constant_MOTIF_SERVICE_NOM" class="">MOTIF_SERVICE_NOM</a><br /> |
| </section> |
| </section> |
| <section class="row-fluid protected"> |
| <section class="span4"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/RestServeur.html#method_initialiserMethode" class="">initialiserMethode()</a><br /> |
| <a href="../classes/RestServeur.html#method_initialiserRequeteDonnees" class="">initialiserRequeteDonnees()</a><br /> |
| <a href="../classes/RestServeur.html#method_decouperUrlChemin" class="">decouperUrlChemin()</a><br /> |
| <a href="../classes/RestServeur.html#method_initialiserApiVersion" class="">initialiserApiVersion()</a><br /> |
| <a href="../classes/RestServeur.html#method_verifierApiVersion" class="">verifierApiVersion()</a><br /> |
| <a href="../classes/RestServeur.html#method_initialiserServiceNom" class="">initialiserServiceNom()</a><br /> |
| <a href="../classes/RestServeur.html#method_verifierServiceNom" class="">verifierServiceNom()</a><br /> |
| <a href="../classes/RestServeur.html#method_traiterNomService" class="">traiterNomService()</a><br /> |
| <a href="../classes/RestServeur.html#method_initialiserRessource" class="">initialiserRessource()</a><br /> |
| <a href="../classes/RestServeur.html#method_initialiserParametres" class="">initialiserParametres()</a><br /> |
| <a href="../classes/RestServeur.html#method_recupererParametresGet" class="">recupererParametresGet()</a><br /> |
| <a href="../classes/RestServeur.html#method_nettoyerParametres" class="">nettoyerParametres()</a><br /> |
| <a href="../classes/RestServeur.html#method_recupererParametresBruts" class="">recupererParametresBruts()</a><br /> |
| <a href="../classes/RestServeur.html#method_get" class="">get()</a><br /> |
| <a href="../classes/RestServeur.html#method_post" class="">post()</a><br /> |
| <a href="../classes/RestServeur.html#method_put" class="">put()</a><br /> |
| <a href="../classes/RestServeur.html#method_delete" class="">delete()</a><br /> |
| <a href="../classes/RestServeur.html#method_parserDonneesRequete" class="">parserDonneesRequete()</a><br /> |
| <a href="../classes/RestServeur.html#method_cloreAccesServeur" class="">cloreAccesServeur()</a><br /> |
| <a href="../classes/RestServeur.html#method_envoyerMessages" class="">envoyerMessages()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/RestServeur.html#property_debogageActivation" class="">$debogageActivation</a><br /> |
| <a href="../classes/RestServeur.html#property_debogageMode" class="">$debogageMode</a><br /> |
| <a href="../classes/RestServeur.html#property_methode" class="">$methode</a><br /> |
| <a href="../classes/RestServeur.html#property_requeteDonnees" class="">$requeteDonnees</a><br /> |
| <a href="../classes/RestServeur.html#property_requeteDonneesParsees" class="">$requeteDonneesParsees</a><br /> |
| <a href="../classes/RestServeur.html#property_apiVersion" class="">$apiVersion</a><br /> |
| <a href="../classes/RestServeur.html#property_service" class="">$service</a><br /> |
| <a href="../classes/RestServeur.html#property_ressources" class="">$ressources</a><br /> |
| <a href="../classes/RestServeur.html#property_parametres" class="">$parametres</a><br /> |
| <a href="../classes/RestServeur.html#property_parametresBruts" class="">$parametresBruts</a><br /> |
| <a href="../classes/RestServeur.html#property_config" class="">$config</a><br /> |
| <a href="../classes/RestServeur.html#property_messages" class="">$messages</a><br /> |
| <a href="../classes/RestServeur.html#property_http10" class="">$http10</a><br /> |
| <a href="../classes/RestServeur.html#property_parametres_obligatoires" class="">$parametres_obligatoires</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/RestServeur.php.html"><div class="path-wrapper">RestServeur.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\RestServeur</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>Php 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p>GPL v3 <a href="http://www.gnu.org/licenses/gpl.txt">http://www.gnu.org/licenses/gpl.txt</a></p> |
| <p>CECILL v2 <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: RestServeur.php 457 2014-02-06 17:54:21Z jpm $</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <a id="constants" name="constants"></a> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <h2>Constants</h2> |
| </div> |
| <aside class="span4 detailsbar"></aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="constant_METHODE_GET" name="constant_METHODE_GET" class="anchor"></a> |
| <article id="constant_METHODE_GET" class="constant"> |
| <h3 class="">METHODE_GET</h3> |
| <pre class="signature">METHODE_GET</pre> |
| <p><em>Nom de la méthode appelée dans un service pour éxécuter une requête de type GET.</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="constant_METHODE_POST" name="constant_METHODE_POST" class="anchor"></a> |
| <article id="constant_METHODE_POST" class="constant"> |
| <h3 class="">METHODE_POST</h3> |
| <pre class="signature">METHODE_POST</pre> |
| <p><em>Nom de la méthode appelée dans un service pour éxécuter une requête de type POST.</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="constant_METHODE_DELETE" name="constant_METHODE_DELETE" class="anchor"></a> |
| <article id="constant_METHODE_DELETE" class="constant"> |
| <h3 class="">METHODE_DELETE</h3> |
| <pre class="signature">METHODE_DELETE</pre> |
| <p><em>Nom de la méthode appelée dans un service pour éxécuter une requête de type DELETE.</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="constant_METHODE_PUT" name="constant_METHODE_PUT" class="anchor"></a> |
| <article id="constant_METHODE_PUT" class="constant"> |
| <h3 class="">METHODE_PUT</h3> |
| <pre class="signature">METHODE_PUT</pre> |
| <p><em>Nom de la méthode appelée dans un service pour éxécuter une requête de type PUT.</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="constant_HTTP_CODE_OK" name="constant_HTTP_CODE_OK" class="anchor"></a> |
| <article id="constant_HTTP_CODE_OK" class="constant"> |
| <h3 class="">HTTP_CODE_OK</h3> |
| <pre class="signature">HTTP_CODE_OK</pre> |
| <p><em>Code HTTP 200 : OK |
| Indiquant le succès de l'accès à un service web par la méthode GET.</em></p> |
| <p>L'utiliser lors d'une requète de type GET (consulter) pour indiquer le succès de l'opération. |
| Sera renvoyée par défaut par PHP.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_CREATION_OK" name="constant_HTTP_CODE_CREATION_OK" class="anchor"></a> |
| <article id="constant_HTTP_CODE_CREATION_OK" class="constant"> |
| <h3 class="">HTTP_CODE_CREATION_OK</h3> |
| <pre class="signature">HTTP_CODE_CREATION_OK</pre> |
| <p><em>Code HTTP 201 : Created |
| Indiquant que l'accès à un service web est un succès et que la ressource a été créée ou modifié.</em></p> |
| <p>L'utiliser lors d'une requète de type PUT (ajouter) ou POST (modifier) pour indiquer le succès de l'opération.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_ACCEPTE_OK" name="constant_HTTP_CODE_ACCEPTE_OK" class="anchor"></a> |
| <article id="constant_HTTP_CODE_ACCEPTE_OK" class="constant"> |
| <h3 class="">HTTP_CODE_ACCEPTE_OK</h3> |
| <pre class="signature">HTTP_CODE_ACCEPTE_OK</pre> |
| <p><em>Code HTTP 202 : Accepted |
| Indiquant que la requête a été acceptée mais que son traitement n'est pas encore terminé.</em></p> |
| <p>L'utiliser lors d'une requète de type PUT (ajouter) ou POST (modifier) pour indiquer que les données |
| seront traitées ultérieurement.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_SUPPRESSION_OK" name="constant_HTTP_CODE_SUPPRESSION_OK" class="anchor"></a> |
| <article id="constant_HTTP_CODE_SUPPRESSION_OK" class="constant"> |
| <h3 class="">HTTP_CODE_SUPPRESSION_OK</h3> |
| <pre class="signature">HTTP_CODE_SUPPRESSION_OK</pre> |
| <p><em>Code HTTP 204 : No Content |
| Indique que l'accès à un service web est un succès et qu'il n'y a pas de contenu à renvoyer.</em></p> |
| <p>L'utiliser lors d'une requète de type DELETE (supprimer) pour indiquer le succès de l'opération si aucun |
| contenu (status) ne doit être renvoyé, sinon utiliser 200 OK.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_MAUVAISE_REQUETE" name="constant_HTTP_CODE_MAUVAISE_REQUETE" class="anchor"></a> |
| <article id="constant_HTTP_CODE_MAUVAISE_REQUETE" class="constant"> |
| <h3 class="">HTTP_CODE_MAUVAISE_REQUETE</h3> |
| <pre class="signature">HTTP_CODE_MAUVAISE_REQUETE</pre> |
| <p><em>Code HTTP 400 : Bad Request |
| Indique que les paramètres envoyés au service contiennent des erreurs.</em></p> |
| <p>L'utiliser pour indiquer l'échec de l'accès au service. La réponse pourra contenir un message expliquant la source |
| de l'erreur.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_ACCES_NON_AUTORISE" name="constant_HTTP_CODE_ACCES_NON_AUTORISE" class="anchor"></a> |
| <article id="constant_HTTP_CODE_ACCES_NON_AUTORISE" class="constant"> |
| <h3 class="">HTTP_CODE_ACCES_NON_AUTORISE</h3> |
| <pre class="signature">HTTP_CODE_ACCES_NON_AUTORISE</pre> |
| <p><em>Code HTTP 401 : Unauthorized |
| Indiquant que l'accès à un service web est refusé car l'authentification (obligatoire) a échoué pour |
| accéder à la ressource.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_ACCES_INTERDIT" name="constant_HTTP_CODE_ACCES_INTERDIT" class="anchor"></a> |
| <article id="constant_HTTP_CODE_ACCES_INTERDIT" class="constant"> |
| <h3 class="">HTTP_CODE_ACCES_INTERDIT</h3> |
| <pre class="signature">HTTP_CODE_ACCES_INTERDIT</pre> |
| <p><em>Code HTTP 403 : Forbidden |
| Indiquant que le service a compris la requête mais refuse de la réaliser.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_RESSOURCE_INTROUVABLE" name="constant_HTTP_CODE_RESSOURCE_INTROUVABLE" class="anchor"></a> |
| <article id="constant_HTTP_CODE_RESSOURCE_INTROUVABLE" class="constant"> |
| <h3 class="">HTTP_CODE_RESSOURCE_INTROUVABLE</h3> |
| <pre class="signature">HTTP_CODE_RESSOURCE_INTROUVABLE</pre> |
| <p><em>Code HTTP 404 : Not Found |
| Indiquant que la ressource indiquée par l'url est introuvable.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_METHODE_NON_AUTORISE" name="constant_HTTP_CODE_METHODE_NON_AUTORISE" class="anchor"></a> |
| <article id="constant_HTTP_CODE_METHODE_NON_AUTORISE" class="constant"> |
| <h3 class="">HTTP_CODE_METHODE_NON_AUTORISE</h3> |
| <pre class="signature">HTTP_CODE_METHODE_NON_AUTORISE</pre> |
| <p><em>Code HTTP 405 : Method Not Allowed |
| Indique soit : |
| - que le service web ne possède pas d'accès la ressource correspondant à la méthode HTTP employée.</em></p> |
| <ul> |
| <li>que la méthode HTTP enployée n'est pas en accord avec la ressource indiquée par l'url.</li> |
| </ul> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_CONFLIT" name="constant_HTTP_CODE_CONFLIT" class="anchor"></a> |
| <article id="constant_HTTP_CODE_CONFLIT" class="constant"> |
| <h3 class="">HTTP_CODE_CONFLIT</h3> |
| <pre class="signature">HTTP_CODE_CONFLIT</pre> |
| <p><em>Code HTTP 409 : Conflict |
| Indique qu'un conflit est survenu vis à vis de la ressource.</em></p> |
| <p>Par exemple, essayer de créer deux fois la même ressource ou bien tenter de modifier une ressource qui a été modifiée par |
| ailleurs.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_CONTENU_REQUIS" name="constant_HTTP_CODE_CONTENU_REQUIS" class="anchor"></a> |
| <article id="constant_HTTP_CODE_CONTENU_REQUIS" class="constant"> |
| <h3 class="">HTTP_CODE_CONTENU_REQUIS</h3> |
| <pre class="signature">HTTP_CODE_CONTENU_REQUIS</pre> |
| <p><em>Code HTTP 411 : Length Required |
| Indique que des paramètres passés dans le contenu de la requête sont nécessaires au service.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_ECHEC_CONDITION" name="constant_HTTP_CODE_ECHEC_CONDITION" class="anchor"></a> |
| <article id="constant_HTTP_CODE_ECHEC_CONDITION" class="constant"> |
| <h3 class="">HTTP_CODE_ECHEC_CONDITION</h3> |
| <pre class="signature">HTTP_CODE_ECHEC_CONDITION</pre> |
| <p><em>Code HTTP 412 : Precondition Failed |
| Indique que des entêtes envoyés au serveur sont erronnés.</em></p> |
| <p>À utiliser quand un service web reçoit de mauvais entêtes, paramètres et/ou ressources.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_CONTENU_NON_SUPPORTE" name="constant_HTTP_CODE_CONTENU_NON_SUPPORTE" class="anchor"></a> |
| <article id="constant_HTTP_CODE_CONTENU_NON_SUPPORTE" class="constant"> |
| <h3 class="">HTTP_CODE_CONTENU_NON_SUPPORTE</h3> |
| <pre class="signature">HTTP_CODE_CONTENU_NON_SUPPORTE</pre> |
| <p><em>Code HTTP 415 : Unsupported Media Type |
| Indique que le type de média envoyé au serveur n'est pas accepté par la ressource.</em></p> |
| <p>À utiliser quand un service web reçoit un mauvais type de contenu.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_ERREUR" name="constant_HTTP_CODE_ERREUR" class="anchor"></a> |
| <article id="constant_HTTP_CODE_ERREUR" class="constant"> |
| <h3 class="">HTTP_CODE_ERREUR</h3> |
| <pre class="signature">HTTP_CODE_ERREUR</pre> |
| <p><em>Code HTTP 500 : Internal Server Error.</em></p> |
| <p>L'utiliser quand le serveur ou un service soulève une erreur ou une exception.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_CODE_SERVICE_INDISPONIBLE" name="constant_HTTP_CODE_SERVICE_INDISPONIBLE" class="anchor"></a> |
| <article id="constant_HTTP_CODE_SERVICE_INDISPONIBLE" class="constant"> |
| <h3 class="">HTTP_CODE_SERVICE_INDISPONIBLE</h3> |
| <pre class="signature">HTTP_CODE_SERVICE_INDISPONIBLE</pre> |
| <p><em>Code HTTP 503 : Service Unavailable |
| L'utiliser quand le web service est momentanément indisponible.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_HTTP_NON_IMPLEMENTE" name="constant_HTTP_NON_IMPLEMENTE" class="anchor"></a> |
| <article id="constant_HTTP_NON_IMPLEMENTE" class="constant"> |
| <h3 class="">HTTP_NON_IMPLEMENTE</h3> |
| <pre class="signature">HTTP_NON_IMPLEMENTE</pre> |
| <p><em>Code HTTP 501 : Not Implemented |
| Indique que le web service ne supporte pas la fonctionnalité demandée.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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="constant_MOTIF_API_VERSION" name="constant_MOTIF_API_VERSION" class="anchor"></a> |
| <article id="constant_MOTIF_API_VERSION" class="constant"> |
| <h3 class="">MOTIF_API_VERSION</h3> |
| <pre class="signature">MOTIF_API_VERSION</pre> |
| <p><em>Motif de l'epression régulière vérfiant la version de l'API.</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="constant_MOTIF_SERVICE_NOM" name="constant_MOTIF_SERVICE_NOM" class="anchor"></a> |
| <article id="constant_MOTIF_SERVICE_NOM" class="constant"> |
| <h3 class="">MOTIF_SERVICE_NOM</h3> |
| <pre class="signature">MOTIF_SERVICE_NOM</pre> |
| <p><em>Motif de l'epression régulière vérfiant le nom du service.</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="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_debogageActivation" name="property_debogageActivation" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$debogageActivation</h3> |
| <pre class="signature">$debogageActivation : boolean</pre> |
| <p><em>Mettre à true pour activer l'affichage des messages d'erreurs et de débogage.</em></p> |
| <h4>Type</h4> |
| boolean |
| </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_debogageMode" name="property_debogageMode" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$debogageMode</h3> |
| <pre class="signature">$debogageMode : string</pre> |
| <p><em>Indiquer le mode de débogage à utiliser (@see Debug).</em></p> |
| <h4>Type</h4> |
| string |
| </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_methode" name="property_methode" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$methode</h3> |
| <pre class="signature">$methode : string</pre> |
| <p><em>La méthode de la requête HTTP utilisée.</em></p> |
| <h4>Type</h4> |
| string |
| </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_requeteDonnees" name="property_requeteDonnees" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$requeteDonnees</h3> |
| <pre class="signature">$requeteDonnees : array</pre> |
| <p><em>Le contenu brut du corps de la requête HTTP (s'il y en a).</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_requeteDonneesParsees" name="property_requeteDonneesParsees" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$requeteDonneesParsees</h3> |
| <pre class="signature">$requeteDonneesParsees : array</pre> |
| <p><em>Le contenu sous forme de tableau de paires clés-valeurs du corps de la requête HTTP (s'il y en a).</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_apiVersion" name="property_apiVersion" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$apiVersion</h3> |
| <pre class="signature">$apiVersion : mixed</pre> |
| <p><em>Version de l'API demandée.</em></p> |
| <p>Ex. <a href="http://www.mondomaine.org/services/[apiVersion]/mon-service/">http://www.mondomaine.org/services/[apiVersion]/mon-service/</a></p> |
| <h4>Type</h4> |
| mixed |
| — Généralement deux nombres séparés par un point. Ex. : 1.0 </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_service" name="property_service" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$service</h3> |
| <pre class="signature">$service : string</pre> |
| <p><em>Nom du service demandé.</em></p> |
| <p>Ex. <a href="http://www.mondomaine.org/services/apiVersion/[mon-service">http://www.mondomaine.org/services/apiVersion/[mon-service</a>]/</p> |
| <h4>Type</h4> |
| string |
| — par défaut vaut null. </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_ressources" name="property_ressources" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$ressources</h3> |
| <pre class="signature">$ressources : array</pre> |
| <p><em>Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.</em></p> |
| <p>Ex. <a href="http://www.mondomaine.org/services/apiVersion/mon-service/[maRessource/maSousResource">http://www.mondomaine.org/services/apiVersion/mon-service/[maRessource/maSousResource</a>...]</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_parametres" name="property_parametres" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres</h3> |
| <pre class="signature">$parametres : array</pre> |
| <p><em>Partie de l'url situé après le '?' servant à paramétrer le service demandé.</em></p> |
| <p>Les données proviennent de $<em>GET où les caractères suivant ont été transformé en '</em>' undescrore dans les clés :</p> |
| <ul> |
| <li>chr(32) ( ) (space)</li> |
| <li>chr(46) (.) (dot)</li> |
| <li>chr(91) ([) (open square bracket)</li> |
| <li>chr(128) - chr(159) (various) |
| En outre nous appliquons la méthode nettoyerGet() qui effectue d'autres remplacement dans les valeurs. |
| Ex. <a href="http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2">http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2</a></li> |
| </ul> |
| <h4>Type</h4> |
| array |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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_parametresBruts" name="property_parametresBruts" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametresBruts</h3> |
| <pre class="signature">$parametresBruts : array</pre> |
| <p><em>Partie de l'url situé après le '?' servant à paramétrer le service demandé.</em></p> |
| <p>Les données proviennent de $_SERVER['QUERY_STRING'] et n'ont subies aucune transformation au niveau des clés. |
| Cependant nous appliquons la méthode nettoyerGet() qui effectue d'autres remplacement dans les valeurs. |
| Ex. <a href="http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2">http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2</a></p> |
| <h4>Type</h4> |
| array |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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_config" name="property_config" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$config</h3> |
| <pre class="signature">$config : array</pre> |
| <p><em>Tableau contenant les paramètres de configuration du serveur.</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_messages" name="property_messages" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$messages</h3> |
| <pre class="signature">$messages : array</pre> |
| <p><em>Tableau contenant les messages d'erreur et/ou d'avertissement du Serveur.</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_http10" name="property_http10" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$http10</h3> |
| <pre class="signature">$http10</pre> |
| <p><em>Codes HTTP.</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="property_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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()</pre> |
| <p><em>Analyse les données envoyées au serveur, enregistre la méthode HTTP utilisée pour appeler le serveur et parse |
| l'url appelée pour trouver le service demandé.</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_chargerClasse" name="method_chargerClasse" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">chargerClasse()</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;">chargerClasse( <span class="argument">$classe</span>) : void</pre> |
| <p><em>La méthode __autoload() charge dynamiquement les classes trouvées dans le code.</em></p> |
| <p>Cette fonction est appelée par php5 quand il trouve une instanciation de classe dans le code.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$classe</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_executer" name="method_executer" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">executer()</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;">executer()</pre> |
| <p><em>Execute la requête.</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_envoyerEnteteStatutHttp" name="method_envoyerEnteteStatutHttp" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">envoyerEnteteStatutHttp()</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;">envoyerEnteteStatutHttp(int <span class="argument">$code</span>)</pre> |
| <p><em>Envoyer un entête HTTP (version 1.0) de statut.</em></p> |
| <p>Il remplacera systématiquement tout entête HTTP de statut précédement envoyé.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>int</td> |
| <td>$code</td> |
| <td><p>entier indiquant le code du statut de l'entête HTTP à envoyer.</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_gererErreurs" name="method_gererErreurs" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">gererErreurs()</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;">gererErreurs()</pre> |
| <p><em>Si des exceptions ou des erreurs sont soulevées par le serveur ou les services, elles sont gérées par cette méthode.</em></p> |
| <p>Si nous avec des erreurs d'un type différent d'E_USER_NOTICE (réservé au débogage), elle sont renvoyées sur la sortie |
| standard (via echo). |
| Si seulement des erreurs de type E_USER_NOTICE, sont présentes, elle sont envoyées en fonction du contenu du paramètre de |
| config "debogage_mode" :</p> |
| <ul> |
| <li>Debug::MODE_ECHO : les messages sont affichés en utilisant echo au moment où ils sont déclenchés dans le code.</li> |
| <li>Debug::MODE_NOTICE : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type |
| E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'execution du programme (via echo).</li> |
| <li>Debug::MODE_ENTETE_HTTP : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type |
| E_USER_NOTICE et sont renvoyés dans un entête HTTP (X_REST_DEBOGAGE_MESSAGES) à la fin de l'execution du programme.</li> |
| <li>Autre valeur : les messages sont formatés puis retournés par la fonction de débogage (à vous de les afficher).</li> |
| </ul> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_ajouterMessage" name="method_ajouterMessage" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">ajouterMessage()</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;">ajouterMessage(string <span class="argument">$message</span>)</pre> |
| <p><em>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au client.</em></p> |
| <p>Le message doit être au format texte et en UTF-8.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$message</td> |
| <td><p>le message à envoyer.</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_initialiserMethode" name="method_initialiserMethode" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">initialiserMethode()</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;">initialiserMethode()</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_initialiserRequeteDonnees" name="method_initialiserRequeteDonnees" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">initialiserRequeteDonnees()</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;">initialiserRequeteDonnees()</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_decouperUrlChemin" name="method_decouperUrlChemin" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">decouperUrlChemin()</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;">decouperUrlChemin()</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_initialiserApiVersion" name="method_initialiserApiVersion" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">initialiserApiVersion()</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;">initialiserApiVersion( <span class="argument">$apiVersion</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$apiVersion</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_verifierApiVersion" name="method_verifierApiVersion" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">verifierApiVersion()</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;">verifierApiVersion( <span class="argument">$apiVersion</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$apiVersion</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_initialiserServiceNom" name="method_initialiserServiceNom" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">initialiserServiceNom()</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;">initialiserServiceNom( <span class="argument">$serviceNom</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$serviceNom</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_verifierServiceNom" name="method_verifierServiceNom" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">verifierServiceNom()</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;">verifierServiceNom( <span class="argument">$serviceNom</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$serviceNom</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_traiterNomService" name="method_traiterNomService" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">traiterNomService()</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;">traiterNomService( <span class="argument">$serviceNom</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$serviceNom</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_initialiserRessource" name="method_initialiserRessource" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">initialiserRessource()</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;">initialiserRessource( <span class="argument">$urlParts</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$urlParts</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_initialiserParametres" name="method_initialiserParametres" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">initialiserParametres()</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;">initialiserParametres()</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_recupererParametresGet" name="method_recupererParametresGet" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">recupererParametresGet()</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;">recupererParametresGet()</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_nettoyerParametres" name="method_nettoyerParametres" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">nettoyerParametres()</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;">nettoyerParametres(array <span class="argument">$parametres</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$parametres</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_recupererParametresBruts" name="method_recupererParametresBruts" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">recupererParametresBruts()</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;">recupererParametresBruts()</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_get" name="method_get" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">get()</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;">get()</pre> |
| <p><em>Execute a GET request. A GET request fetches a list of resource when no resource name is given, a list of element |
| when a resource name is given, or a resource element when a resource and resource unique identifier are given. It does not change the |
| database contents.</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_post" name="method_post" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">post()</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;">post()</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_put" name="method_put" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">put()</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;">put()</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_delete" name="method_delete" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">delete()</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;">delete()</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_parserDonneesRequete" name="method_parserDonneesRequete" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">parserDonneesRequete()</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;">parserDonneesRequete() : array</pre> |
| <p><em>Parse les données contenu dans le corps de la requête HTTP (= POST) en : |
| - décodant les clés et valeurs.</em></p> |
| <ul> |
| <li>supprimant les espaces en début et fin des clés et des valeurs.</li> |
| </ul> |
| <h4>Returns</h4> |
| array |
| — <p>Tableau de paires clé et valeur.</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_cloreAccesServeur" name="method_cloreAccesServeur" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">cloreAccesServeur()</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;">cloreAccesServeur( <span class="argument">$retour</span>)</pre> |
| <p><em>Termine l'accès au serveur après envoir envoyer les messages.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$retour</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_envoyerMessages" name="method_envoyerMessages" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">envoyerMessages()</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;">envoyerMessages()</pre> |
| <p><em>Envoie au client les éventuels messages d'erreur et d'avertissement du Serveur.</em></p> |
| <p>Le format d'envoie est text/plain encodé en UTF-8.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">RestServeur.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/RestServeur.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Bdd.html |
|---|
| New file |
| 0,0 → 1,1624 |
| <!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-2085932587"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-2085932587" 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>Bdd</h1> |
| <p><em>Classe Bdd, d'accés au base de données.</em></p> |
| <p>Elle fait office d'abstraction légère de base de données en utilisant diverses possibilités d'accès aux |
| bases de données (PDO, mysql, mysqli, SQLite3). |
| Les valeurs pour le paramètre 'bdd_abstraction' du fichier config.ini sont : pdo, mysql, mysqli, sqlite3 |
| Vous pouvez aussi utiliser : "php:Bdd::ABSTRACTION_PDO","php:Bdd::ABSTRACTION_MYSQL", "php:Bdd::ABSTRACTION_MYSQLI", |
| "php:Bdd::ABSTRACTION_SQLITE3". |
| Elle peut être étendue, pour ajouter le support d'autres bases de données où prendre en compte des méthodes spécifique à |
| un type d'abstraction.</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/Bdd.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/Bdd.html#method_ping" class="">ping()</a><br /> |
| <a href="../classes/Bdd.html#method_requeter" class="">requeter()</a><br /> |
| <a href="../classes/Bdd.html#method_recuperer" class="">recuperer()</a><br /> |
| <a href="../classes/Bdd.html#method_recupererTous" class="">recupererTous()</a><br /> |
| <a href="../classes/Bdd.html#method_proteger" class="">proteger()</a><br /> |
| <a href="../classes/Bdd.html#method_protegerTableau" class="deprecated">protegerTableau()</a><br /> |
| <a href="../classes/Bdd.html#method_recupererIdDernierAjout" class="">recupererIdDernierAjout()</a><br /> |
| <a href="../classes/Bdd.html#method___destruct" class="">__destruct()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No public properties found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Bdd.html#constant_ERREUR_REQUETE_TPL" class="">ERREUR_REQUETE_TPL</a><br /> |
| <a href="../classes/Bdd.html#constant_ERREUR_CONNEXION_TPL" class="">ERREUR_CONNEXION_TPL</a><br /> |
| <a href="../classes/Bdd.html#constant_ERREUR_SELECTION_BDD_TPL" class="">ERREUR_SELECTION_BDD_TPL</a><br /> |
| <a href="../classes/Bdd.html#constant_ABSTRACTION_PDO" class="">ABSTRACTION_PDO</a><br /> |
| <a href="../classes/Bdd.html#constant_ABSTRACTION_MYSQL" class="">ABSTRACTION_MYSQL</a><br /> |
| <a href="../classes/Bdd.html#constant_ABSTRACTION_MYSQLI" class="">ABSTRACTION_MYSQLI</a><br /> |
| <a href="../classes/Bdd.html#constant_ABSTRACTION_SQLITE3" class="">ABSTRACTION_SQLITE3</a><br /> |
| <a href="../classes/Bdd.html#constant_MODE_ASSOC" class="">MODE_ASSOC</a><br /> |
| <a href="../classes/Bdd.html#constant_MODE_OBJET" class="">MODE_OBJET</a><br /> |
| </section> |
| </section> |
| <section class="row-fluid protected"> |
| <section class="span4"> |
| <a href="../classes/Bdd.html#method_initialiserProtocole" class="">initialiserProtocole()</a><br /> |
| <a href="../classes/Bdd.html#method_connecter" class="">connecter()</a><br /> |
| <a href="../classes/Bdd.html#method_requete" class="deprecated">requete()</a><br /> |
| <a href="../classes/Bdd.html#method_requeteUn" class="deprecated">requeteUn()</a><br /> |
| <a href="../classes/Bdd.html#method_requeteTous" class="deprecated">requeteTous()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Bdd.html#property_ASSOC" class="">$ASSOC</a><br /> |
| <a href="../classes/Bdd.html#property_OBJECT" class="">$OBJECT</a><br /> |
| <a href="../classes/Bdd.html#property_abstraction" class="">$abstraction</a><br /> |
| <a href="../classes/Bdd.html#property_dsn" class="">$dsn</a><br /> |
| <a href="../classes/Bdd.html#property_type" class="">$type</a><br /> |
| <a href="../classes/Bdd.html#property_hote" class="">$hote</a><br /> |
| <a href="../classes/Bdd.html#property_bdd_nom" class="">$bdd_nom</a><br /> |
| <a href="../classes/Bdd.html#property_utilisateur" class="">$utilisateur</a><br /> |
| <a href="../classes/Bdd.html#property_pass" class="">$pass</a><br /> |
| <a href="../classes/Bdd.html#property_encodage" class="">$encodage</a><br /> |
| <a href="../classes/Bdd.html#property_connexion" class="">$connexion</a><br /> |
| <a href="../classes/Bdd.html#property_parametres_obligatoires" class="">$parametres_obligatoires</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/Bdd.html#method_protegerChaine" class="">protegerChaine()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No private properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| </section> |
| </div> |
| <aside class="span4 detailsbar"> |
| <dl> |
| <dt>File</dt> |
| <dd><a href="../files/Bdd.php.html"><div class="path-wrapper">Bdd.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Bdd</div> |
| </dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>php 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Aurélien PERONNET <a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a></p> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <a id="constants" name="constants"></a> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <h2>Constants</h2> |
| </div> |
| <aside class="span4 detailsbar"></aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="constant_ERREUR_REQUETE_TPL" name="constant_ERREUR_REQUETE_TPL" class="anchor"></a> |
| <article id="constant_ERREUR_REQUETE_TPL" class="constant"> |
| <h3 class="">ERREUR_REQUETE_TPL</h3> |
| <pre class="signature">ERREUR_REQUETE_TPL</pre> |
| <p><em>Constante stockant le squelette du message en cas d'erreur de requête sql.</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="constant_ERREUR_CONNEXION_TPL" name="constant_ERREUR_CONNEXION_TPL" class="anchor"></a> |
| <article id="constant_ERREUR_CONNEXION_TPL" class="constant"> |
| <h3 class="">ERREUR_CONNEXION_TPL</h3> |
| <pre class="signature">ERREUR_CONNEXION_TPL</pre> |
| <p><em>Constante stockant le squelette du message en cas d'erreur de connexion à la base de données.</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="constant_ERREUR_SELECTION_BDD_TPL" name="constant_ERREUR_SELECTION_BDD_TPL" class="anchor"></a> |
| <article id="constant_ERREUR_SELECTION_BDD_TPL" class="constant"> |
| <h3 class="">ERREUR_SELECTION_BDD_TPL</h3> |
| <pre class="signature">ERREUR_SELECTION_BDD_TPL</pre> |
| <p><em>Constante stockant le squelette du message en cas d'erreur de sélection de la base de données.</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="constant_ABSTRACTION_PDO" name="constant_ABSTRACTION_PDO" class="anchor"></a> |
| <article id="constant_ABSTRACTION_PDO" class="constant"> |
| <h3 class="">ABSTRACTION_PDO</h3> |
| <pre class="signature">ABSTRACTION_PDO</pre> |
| <p><em>Constante stockant le code pour l'abstraction de PDO.</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="constant_ABSTRACTION_MYSQL" name="constant_ABSTRACTION_MYSQL" class="anchor"></a> |
| <article id="constant_ABSTRACTION_MYSQL" class="constant"> |
| <h3 class="">ABSTRACTION_MYSQL</h3> |
| <pre class="signature">ABSTRACTION_MYSQL</pre> |
| <p><em>Constante stockant le code pour l'abstraction de mysql.</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="constant_ABSTRACTION_MYSQLI" name="constant_ABSTRACTION_MYSQLI" class="anchor"></a> |
| <article id="constant_ABSTRACTION_MYSQLI" class="constant"> |
| <h3 class="">ABSTRACTION_MYSQLI</h3> |
| <pre class="signature">ABSTRACTION_MYSQLI</pre> |
| <p><em>Constante stockant le code pour l'abstraction de mysqli.</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="constant_ABSTRACTION_SQLITE3" name="constant_ABSTRACTION_SQLITE3" class="anchor"></a> |
| <article id="constant_ABSTRACTION_SQLITE3" class="constant"> |
| <h3 class="">ABSTRACTION_SQLITE3</h3> |
| <pre class="signature">ABSTRACTION_SQLITE3</pre> |
| <p><em>Constante stockant le code pour l'abstraction de SQLite3.</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="constant_MODE_ASSOC" name="constant_MODE_ASSOC" class="anchor"></a> |
| <article id="constant_MODE_ASSOC" class="constant"> |
| <h3 class="">MODE_ASSOC</h3> |
| <pre class="signature">MODE_ASSOC</pre> |
| <p><em>Constante stockant le code pour le mode tableau associatif des résultats des requêtes.</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="constant_MODE_OBJET" name="constant_MODE_OBJET" class="anchor"></a> |
| <article id="constant_MODE_OBJET" class="constant"> |
| <h3 class="">MODE_OBJET</h3> |
| <pre class="signature">MODE_OBJET</pre> |
| <p><em>Constante stockant le code pour le mode objet des résultats des requêtes.</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="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_ASSOC" name="property_ASSOC" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$ASSOC</h3> |
| <pre class="signature">$ASSOC</pre> |
| <p><em>Mode de fetch associatif</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="property_OBJECT" name="property_OBJECT" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$OBJECT</h3> |
| <pre class="signature">$OBJECT</pre> |
| <p><em>Mode de fetch objet</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="property_abstraction" name="property_abstraction" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$abstraction</h3> |
| <pre class="signature">$abstraction</pre> |
| <p><em>abstraction de base de données utilisée</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="property_dsn" name="property_dsn" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$dsn</h3> |
| <pre class="signature">$dsn</pre> |
| <p><em>DSN pour accéder à la base de données</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="property_type" name="property_type" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$type</h3> |
| <pre class="signature">$type</pre> |
| <p><em>Type de base de données (mysql, mysqli, etc .</em></p> |
| <p>..)</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="property_hote" name="property_hote" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$hote</h3> |
| <pre class="signature">$hote</pre> |
| <p><em>Hote herbergeant la base de données</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="property_bdd_nom" name="property_bdd_nom" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$bdd_nom</h3> |
| <pre class="signature">$bdd_nom</pre> |
| <p><em>Nom de la base de données à laquelle le modèle doit se connecter</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="property_utilisateur" name="property_utilisateur" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$utilisateur</h3> |
| <pre class="signature">$utilisateur</pre> |
| <p><em>Nom d'utilisateur</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="property_pass" name="property_pass" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$pass</h3> |
| <pre class="signature">$pass</pre> |
| <p><em>Mot de passe</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="property_encodage" name="property_encodage" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$encodage</h3> |
| <pre class="signature">$encodage</pre> |
| <p><em>Encodage de la base de données</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="property_connexion" name="property_connexion" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$connexion</h3> |
| <pre class="signature">$connexion</pre> |
| <p><em>Connexion à la base de données</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="property_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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()</pre> |
| <p><em>Constructeur par défaut, appelé à l'initialisation.</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_ping" name="method_ping" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">ping()</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;">ping() : boolean</pre> |
| <p><em>Permet de tester, puis de reconnecter une connection au cas ou celle aurait été |
| perdue (utile dans le cas d'une connection ouverte depuis trop longtemps)</em></p> |
| <h4>Returns</h4> |
| boolean |
| </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_requeter" name="method_requeter" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">requeter()</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;">requeter( <span class="argument">$requete</span>) : mixed</pre> |
| <p><em>Execute une requête et retourne le résultat tel que renvoyé par l'abstraction courante.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$requete</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| — <p>un objet contenant le résultat de la requête</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_recuperer" name="method_recuperer" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">recuperer()</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;">recuperer( <span class="argument">$requete</span>, <span class="argument">$mode</span>) : mixed</pre> |
| <p><em>Execute une requête et retourne le premier résultat sous forme de tableau (par défaut) ou d'objet.</em></p> |
| <p>Les noms des champs de la base de données correspondent aux noms des clés du tableau ou aux noms des attributs de l'objet.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$requete</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$mode</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| — <p>un objet ou un tableau contenant le résultat de la requête</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_recupererTous" name="method_recupererTous" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">recupererTous()</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;">recupererTous( <span class="argument">$requete</span>, <span class="argument">$mode</span>) : array</pre> |
| <p><em>Execute une requête et retourne un tableau de résultats. Un résultat peut être présentés sous forme |
| de tableau (par défaut) ou d'objet.</em></p> |
| <p>Les noms des champs de la base de données correspondent aux noms des clés du tableau résultat ou |
| aux noms des attributs de l'objet résultat.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$requete</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$mode</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| array |
| — <p>un tableau contenant les résultats sous forme d'objets ou de tableau (par défaut).</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_proteger" name="method_proteger" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">proteger()</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;">proteger( <span class="argument">$donnees</span>) : mixed</pre> |
| <p><em>Protège une chaine de caractères ou le contenu d'un tablea avant l'insertion dans la base de données |
| (ajout de quotes ou guillemets).</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$donnees</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| — <p>la chaine ou le tableau à protégé</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_protegerTableau" name="method_protegerTableau" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public deprecated">protegerTableau()</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;">protegerTableau(array <span class="argument">$tableau</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$tableau</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <aside class="alert alert-block alert-error"> |
| <h4>Deprecated</h4> |
| changement de nom. Deviendra "private" dans la version 0.5. Utiliser à la place : @see proteger |
| </aside> |
| <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_recupererIdDernierAjout" name="method_recupererIdDernierAjout" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">recupererIdDernierAjout()</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;">recupererIdDernierAjout( <span class="argument">$parametres</span>) : mixed</pre> |
| <p><em>Retourne l'identifiant de la dernière ligne insérée, ou la dernière valeur d'une séquence d'objets, dépendamment, dans |
| le cas de PDO, du driver utilisé. Les méthodes utilisées pour retourner l'identifiant peuvent avoir des comportements |
| différent. Consulter la documentation PHP correspondant à l'abstraction choisie avant de l'utiliser :</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$parametres</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| — <p>le dernier identifiant de clé primaire ajouté dans la base de données (string ou int).</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href="(http://fr.php.net/manual/fr/pdo.lastinsertid.php,"><span class="namespace-wrapper">PDO::lastInsertId([ string $name = NULL ]))</span></a></dd> |
| <dd><a href="(http://php.net/manual/en/mysqli.insert-id.php,"><span class="namespace-wrapper">mysqli->insert_id())</span></a></dd> |
| <dd><a href="(http://fr.php.net/manual/fr/function.mysql-insert-id.php,"><span class="namespace-wrapper">mysql_insert_id())</span></a></dd> |
| <dd><a href="(http://fr.php.net/manual/fr/sqlite3.lastinsertrowid.php,"><span class="namespace-wrapper">SQLite3::lastInsertRowID())</span></a></dd> |
| </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___destruct" name="method___destruct" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">__destruct()</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;">__destruct()</pre> |
| <p><em>Destructeur de classe, se contente de fermer explicitement la connexion à la base de donnée.</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_initialiserProtocole" name="method_initialiserProtocole" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">initialiserProtocole()</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;">initialiserProtocole()</pre> |
| <p><em>Initialise les constantes de classe à leur bonne valeur et déclenche une erreur si le protocole n'est pas bien défini.</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_connecter" name="method_connecter" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">connecter()</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;">connecter()</pre> |
| <p><em>Connection à la base de données en utilisant les informations fournies par |
| le fichier de configuration.</em></p> |
| <p>Cette méthode est private et final car elle n'a pas vocation a être appelée par l'utilisateur. |
| TODO : il est peut être nécessaire pour MYSQL, MYSQLi et SQLITE3 afin d'éviter les boucles infinis |
| d'erreur quand la bdd n'est pas configuré d'utiliser : $this->connexion->query (comme pour PDO)</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_requete" name="method_requete" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected deprecated">requete()</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;">requete( <span class="argument">$requete</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$requete</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">final</span> |
| <aside class="alert alert-block alert-error"> |
| <h4>Deprecated</h4> |
| changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see requeter |
| </aside> |
| <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_requeteUn" name="method_requeteUn" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected deprecated">requeteUn()</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;">requeteUn( <span class="argument">$requete</span>, <span class="argument">$mode</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$requete</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$mode</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">final</span> |
| <aside class="alert alert-block alert-error"> |
| <h4>Deprecated</h4> |
| changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see recuperer |
| </aside> |
| <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_requeteTous" name="method_requeteTous" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected deprecated">requeteTous()</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;">requeteTous( <span class="argument">$requete</span>, <span class="argument">$mode</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$requete</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$mode</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">final</span> |
| <aside class="alert alert-block alert-error"> |
| <h4>Deprecated</h4> |
| changement de nom. Disparaîtra dans la version 0.4. Utiliser à la place : @see recupererTous |
| </aside> |
| <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_protegerChaine" name="method_protegerChaine" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">protegerChaine()</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;">protegerChaine( <span class="argument">$chaine</span>) : string</pre> |
| <p><em>Protège une chaine de caractères avant l'insertion dans la base de données (ajout de quotes ou guillemets).</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$chaine</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la chaine protégée</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> |
| </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">Bdd.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Bdd.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Controleur.html |
|---|
| New file |
| 0,0 → 1,788 |
| <!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-712961556"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-712961556" 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>Controleur</h1> |
| <p><em>Classe Controleur, coeur d'une application, c'est normalement la seule classe d'une application |
| qui devrait être appelée de l'extérieur.</em></p> |
| <p>Elle est abstraite donc doit obligatoirement être étendue.</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/Controleur.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/Controleur.html#method_chargerModele" class="">chargerModele()</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/Controleur.html#method_getModele" class="">getModele()</a><br /> |
| <a href="../classes/Controleur.html#method_getVue" class="">getVue()</a><br /> |
| <a href="../classes/Controleur.html#method_preTraiterDonnees" class="">preTraiterDonnees()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Controleur.html#property_parametres_obligatoires" class="">$parametres_obligatoires</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <em>No private methods found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Controleur.html#property_encodage" class="">$encodage</a><br /> |
| <a href="../classes/Controleur.html#property_base_chemin_modele" class="">$base_chemin_modele</a><br /> |
| <a href="../classes/Controleur.html#property_base_chemin_squelette" class="">$base_chemin_squelette</a><br /> |
| <a href="../classes/Controleur.html#property_base_chemin_controleur" class="">$base_chemin_controleur</a><br /> |
| <a href="../classes/Controleur.html#property_base_url_applicaton" class="">$base_url_applicaton</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| </section> |
| </div> |
| <aside class="span4 detailsbar"> |
| <span class="label label-info">abstract</span> |
| <dl> |
| <dt>File</dt> |
| <dd><a href="../files/Controleur.php.html"><div class="path-wrapper">Controleur.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Controleur</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>php 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Aurélien PERONNET <a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a></p> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Controleur.php 332 2011-03-22 16:54:23Z delphine $</p> |
| </td> |
| </tr> |
| <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_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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="property_encodage" name="property_encodage" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$encodage</h3> |
| <pre class="signature">$encodage</pre> |
| <p><em>Variable statique indiquant que les tableaux _GET et _POST ont déjà été encodé au format de l'appli.</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="property_base_chemin_modele" name="property_base_chemin_modele" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$base_chemin_modele</h3> |
| <pre class="signature">$base_chemin_modele</pre> |
| <p><em>Chemin de base vers les classes métiers de la partie Modèle de l'application.</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="property_base_chemin_squelette" name="property_base_chemin_squelette" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$base_chemin_squelette</h3> |
| <pre class="signature">$base_chemin_squelette</pre> |
| <p><em>Chemin de base vers les fichiers squelette de la partie Vue de l'application.</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="property_base_chemin_controleur" name="property_base_chemin_controleur" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$base_chemin_controleur</h3> |
| <pre class="signature">$base_chemin_controleur</pre> |
| <p><em>Chemin de base vers les classes controleurs de la partie Controleur de l'application.</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="property_base_url_applicaton" name="property_base_url_applicaton" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$base_url_applicaton</h3> |
| <pre class="signature">$base_url_applicaton</pre> |
| <p><em>Objet URL contant l'url de la base de l'application.</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()</pre> |
| <p><em>Constructeur par défaut</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_chargerModele" name="method_chargerModele" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">chargerModele()</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;">chargerModele(string <span class="argument">$nom_modele</span>) : boolean</pre> |
| <p><em>Charge un modele donné et le rend disponible sous la forme $this->nom_modele</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$nom_modele</td> |
| <td><p>le nom du modèle à charger</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>false si le chargement a échoué, sinon true.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">final</span> |
| <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_getModele" name="method_getModele" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">getModele()</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;">getModele(string <span class="argument">$nom_modele</span>, String <span class="argument">$ext</span>) : mixed</pre> |
| <p><em>Retourne un modele donné</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$nom_modele</td> |
| <td><p>le nom du fichier modèle à charger sans son extension</p></td> |
| </tr> |
| <tr> |
| <td>String</td> |
| <td>$ext</td> |
| <td><p>l'extension du fichier du modèel (par défaut : ".php"</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| — <p>false si le chargement a échoué, sinon l'objet du modèle demandé.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">final</span> |
| <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_getVue" name="method_getVue" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">getVue()</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;">getVue(String <span class="argument">$nom_squelette</span>, Array <span class="argument">$donnees</span>, String <span class="argument">$ext</span>) : boolean</pre> |
| <p><em>Fonction prenant en paramètre le nom d'un squelette et un tableau associatif de données, |
| en extrait les variables, charge le squelette et retourne le résultat des deux combinés.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>String</td> |
| <td>$nom_squelette</td> |
| <td><p>le nom du squelette sans son extension</p></td> |
| </tr> |
| <tr> |
| <td>Array</td> |
| <td>$donnees</td> |
| <td><p>un tableau associatif contenant les variables a injecter dans la vue</p></td> |
| </tr> |
| <tr> |
| <td>String</td> |
| <td>$ext</td> |
| <td><p>l'extension du fichier du squelette (par défaut : ".tpl.html"</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>false si la vue n'existe pas, sinon la chaine résultat.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">final</span> |
| <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_preTraiterDonnees" name="method_preTraiterDonnees" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">preTraiterDonnees()</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;">preTraiterDonnees(Array <span class="argument">$donnees</span>) : Array</pre> |
| <p><em>Fonction prenant en paramètre un tableau de données et effectuant un traitement dessus.</em></p> |
| <p>Cette fonction est à surcharger dans les classes filles pour automatiser un traitement |
| avant chaque chargement de vue.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>Array</td> |
| <td>$donnees</td> |
| <td><p>Le tableau de données à traiter</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| Array |
| — <p>$donnees Le tableau de données traité</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> |
| </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">Controleur.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Controleur.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Framework.html |
|---|
| New file |
| 0,0 → 1,1090 |
| <!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-258167610"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-258167610" 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>Framework</h1> |
| <p><em>Classe de base du Framework : |
| - fournissant des infos sur l'application, |
| - paramétrant l'environnement de l'appli et du framework, |
| - réalisant des traitements sur les variables globales ($_GET, $_POST, $_COOKIE.</em></p> |
| <p>..)</p> |
| <p>Cette classe contient la fonction de chargement automatique de classes. |
| Ce fichier doit toujours rester à la racine du framework car il initialise le chemin |
| de l'application en se basant sur son propre emplacement.</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/Framework.html#method_setCheminAppli" class="">setCheminAppli()</a><br /> |
| <a href="../classes/Framework.html#method_getCheminAppli" class="">getCheminAppli()</a><br /> |
| <a href="../classes/Framework.html#method_setInfoAppli" class="">setInfoAppli()</a><br /> |
| <a href="../classes/Framework.html#method_getInfoAppli" class="">getInfoAppli()</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/Framework.html#method_verifierEtReencoderTableauRequete" class="">verifierEtReencoderTableauRequete()</a><br /> |
| <a href="../classes/Framework.html#method_encoderTableau" class="">encoderTableau()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/Framework.html#method_initialiserEnvironnement" class="">initialiserEnvironnement()</a><br /> |
| <a href="../classes/Framework.html#method_initialiserFramework" class="">initialiserFramework()</a><br /> |
| <a href="../classes/Framework.html#method_definirConstantesGlobales" class="">definirConstantesGlobales()</a><br /> |
| <a href="../classes/Framework.html#method_definirCheminAppli" class="">definirCheminAppli()</a><br /> |
| <a href="../classes/Framework.html#method_enregistrerMethodesAutoload" class="">enregistrerMethodesAutoload()</a><br /> |
| <a href="../classes/Framework.html#method_autoloadFw" class="">autoloadFw()</a><br /> |
| <a href="../classes/Framework.html#method_autoloadAppliDefaut" class="">autoloadAppliDefaut()</a><br /> |
| <a href="../classes/Framework.html#method_initialiserUrl" class="">initialiserUrl()</a><br /> |
| <a href="../classes/Framework.html#method_verifierEtTraiterSlashTableauRequete" class="">verifierEtTraiterSlashTableauRequete()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Framework.html#property_encodage" class="">$encodage</a><br /> |
| <a href="../classes/Framework.html#property_info" class="">$info</a><br /> |
| <a href="../classes/Framework.html#property_chemin" class="">$chemin</a><br /> |
| <a href="../classes/Framework.html#property_parametres_obligatoires" class="">$parametres_obligatoires</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/Framework.php.html"><div class="path-wrapper">Framework.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Framework</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Framework.php 391 2011-11-09 16:55:53Z jpm $</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| </td> |
| </tr> |
| <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_encodage" name="property_encodage" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$encodage</h3> |
| <pre class="signature">$encodage</pre> |
| <p><em>Variable statique indiquant que les tableaux _GET et _POST ont déjà été encodé au format de l'appli.</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="property_info" name="property_info" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$info</h3> |
| <pre class="signature">$info</pre> |
| <p><em>Tableau d'informations sur l'application</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="property_chemin" name="property_chemin" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$chemin</h3> |
| <pre class="signature">$chemin</pre> |
| <p><em>Chemin de base de l'application</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="property_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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_setCheminAppli" name="method_setCheminAppli" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">setCheminAppli()</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;">setCheminAppli(string <span class="argument">$chemin_fichier_principal</span>)</pre> |
| <p><em>Permet d'indiquer le chemin de base de l'Application.</em></p> |
| <p>Cette méthode doit obligatoirement être utilisée par l'application pour que le Framework fonctionne correctement.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$chemin_fichier_principal</td> |
| <td><p>chemin de base</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_getCheminAppli" name="method_getCheminAppli" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getCheminAppli()</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;">getCheminAppli() : string</pre> |
| <p><em>accesseur pour le chemin</em></p> |
| <h4>Returns</h4> |
| string |
| — <p>le chemin</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_setInfoAppli" name="method_setInfoAppli" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">setInfoAppli()</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;">setInfoAppli(array <span class="argument">$info</span>) : void</pre> |
| <p><em>Le tableau des informations sur l'application possède les clés suivantes : |
| - nom : nom de l'application |
| - abr : abréviation de l'application |
| - encodage : encodage de l'application (ISO-8859-15, UTF-8.</em></p> |
| <p>..)</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$info</td> |
| <td><p>tableau fournissant des informations sur l'application</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_getInfoAppli" name="method_getInfoAppli" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getInfoAppli()</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;">getInfoAppli(string <span class="argument">$cle</span>)</pre> |
| <p><em>Accesseur pour le tableau d'infos sur l'application.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$cle</td> |
| <td><p>la clé à laquelle on veut accéder</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_verifierEtReencoderTableauRequete" name="method_verifierEtReencoderTableauRequete" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">verifierEtReencoderTableauRequete()</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;">verifierEtReencoderTableauRequete()</pre> |
| <p><em>Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les transcodant dans l'encodage de l'application</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_encoderTableau" name="method_encoderTableau" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">encoderTableau()</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;">encoderTableau(mixed <span class="argument">$tableau</span>, mixed <span class="argument">$encodage_sortie</span>, mixed <span class="argument">$encodage_entree</span>) : Array</pre> |
| <p><em>Fonction récursive transcodant toutes les valeurs d'un tableau de leur encodage d'entrée vers un encodage de sortie donné</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>mixed</td> |
| <td>$tableau</td> |
| <td><p>Array Un tableau de données à encoder</p></td> |
| </tr> |
| <tr> |
| <td>mixed</td> |
| <td>$encodage_sortie</td> |
| <td><p>String l'encodage vers lequel on doit transcoder</p></td> |
| </tr> |
| <tr> |
| <td>mixed</td> |
| <td>$encodage_entree</td> |
| <td><p>String l'encodage original des chaines du tableau (optionnel)</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| Array |
| — <p>Le tableau encodé dans l'encodage de sortie</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <span class="label label-info">final</span> |
| <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_initialiserEnvironnement" name="method_initialiserEnvironnement" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">initialiserEnvironnement()</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;">initialiserEnvironnement()</pre> |
| <p><em>Initialise l'environnement nécessaire au Framework : constantes globales, méthodeles autoload, séparateur d'arguments |
| d'url.</em></p> |
| <p>Cette méthode est appelée automatiquement suite à la définition du chemin de l'application via Application::setChemin().</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_initialiserFramework" name="method_initialiserFramework" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">initialiserFramework()</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;">initialiserFramework()</pre> |
| <p><em>Initialise différentes classes du Framework nécessaires pour le fonctionnement de l'application.</em></p> |
| <p>Ces classes sont ensuites controlées via les fichiers de config.ini. |
| Elle est appelée automatiquement suite à la définition du chemin de l'application via Application::setChemin().</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_definirConstantesGlobales" name="method_definirConstantesGlobales" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">definirConstantesGlobales()</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;">definirConstantesGlobales()</pre> |
| <p><em>Redéfinit des constantes globales utiles pour le Framework et les applis.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_definirCheminAppli" name="method_definirCheminAppli" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">definirCheminAppli()</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;">definirCheminAppli( <span class="argument">$chemin</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$chemin</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_enregistrerMethodesAutoload" name="method_enregistrerMethodesAutoload" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">enregistrerMethodesAutoload()</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;">enregistrerMethodesAutoload()</pre> |
| <p><em></em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_autoloadFw" name="method_autoloadFw" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">autoloadFw()</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;">autoloadFw( <span class="argument">$nom_classe_fw</span>)</pre> |
| <p><em>Autoload pour le Framework.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$nom_classe_fw</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_autoloadAppliDefaut" name="method_autoloadAppliDefaut" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">autoloadAppliDefaut()</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;">autoloadAppliDefaut( <span class="argument">$nom_classe</span>)</pre> |
| <p><em>Autoload par défaut pour l'application</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$nom_classe</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_initialiserUrl" name="method_initialiserUrl" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">initialiserUrl()</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;">initialiserUrl()</pre> |
| <p><em>Initialise le format des urls.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_verifierEtTraiterSlashTableauRequete" name="method_verifierEtTraiterSlashTableauRequete" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">verifierEtTraiterSlashTableauRequete()</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;">verifierEtTraiterSlashTableauRequete()</pre> |
| <p><em>Procédure vérifiant l'activation des magic quotes et remplacant les slash dans les tableaux de requete</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Framework.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Framework.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/CacheFichier.html |
|---|
| 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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/RestService.html |
|---|
| New file |
| 0,0 → 1,902 |
| <!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-825091324"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-825091324" 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>RestService</h1> |
| <p><em>Classe principale gérant les services.</em></p> |
| <p>Paramètres liés dans config.ini :</p> |
| <ul> |
| <li>serveur.baseURL</li> |
| </ul> |
| <p>Encodage en entrée : utf8 |
| Encodage en sortie : utf8</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/RestService.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/RestService.html#method_initialiser" class="">initialiser()</a><br /> |
| <a href="../classes/RestService.html#method_utiliserParametresBruts" class="">utiliserParametresBruts()</a><br /> |
| <a href="../classes/RestService.html#method_consulter" class="">consulter()</a><br /> |
| <a href="../classes/RestService.html#method_modifier" class="">modifier()</a><br /> |
| <a href="../classes/RestService.html#method_ajouter" class="">ajouter()</a><br /> |
| <a href="../classes/RestService.html#method_supprimer" class="">supprimer()</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/RestService.html#method_getBdd" class="">getBdd()</a><br /> |
| <a href="../classes/RestService.html#method_getRestClient" class="">getRestClient()</a><br /> |
| <a href="../classes/RestService.html#method_ajouterMessage" class="">ajouterMessage()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/RestService.html#property_bdd" class="deprecated">$bdd</a><br /> |
| <a href="../classes/RestService.html#property_utilisationParametresBruts" class="">$utilisationParametresBruts</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <em>No private methods found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/RestService.html#property_RestClient" class="">$RestClient</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| </section> |
| </div> |
| <aside class="span4 detailsbar"> |
| <span class="label label-info">abstract</span> |
| <dl> |
| <dt>File</dt> |
| <dd><a href="../files/RestService.php.html"><div class="path-wrapper">RestService.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\RestService</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>Php 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p>GPL v3 <a href="http://www.gnu.org/licenses/gpl.txt">http://www.gnu.org/licenses/gpl.txt</a></p> |
| <p>CECILL v2 <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: RestService.php 382 2011-10-14 10:36:41Z jpm $</p> |
| </td> |
| </tr> |
| <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_bdd" name="property_bdd" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected deprecated">$bdd</h3> |
| <pre class="signature">$bdd</pre> |
| <p><em>Objet de connection à la base de données.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <aside class="alert alert-block alert-error"> |
| <h4>Deprecated</h4> |
| Utiliser la methode getBdd(). |
| </aside> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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_utilisationParametresBruts" name="property_utilisationParametresBruts" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$utilisationParametresBruts</h3> |
| <pre class="signature">$utilisationParametresBruts</pre> |
| <p><em>Indique si oui (true) ou non (false), on veut utiliser les paramètres brutes.</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="property_RestClient" name="property_RestClient" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$RestClient</h3> |
| <pre class="signature">$RestClient</pre> |
| <p><em>Objet Rest Client.</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( <span class="argument">$config</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$config</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_initialiser" name="method_initialiser" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">initialiser()</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;">initialiser()</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_utiliserParametresBruts" name="method_utiliserParametresBruts" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">utiliserParametresBruts()</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;">utiliserParametresBruts()</pre> |
| <p><em>Méthode permettant de savoir si le service veut utiliser des paramètres bruts (issu de la QueryString) |
| ou pas (issu de $_GET).</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_consulter" name="method_consulter" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">consulter()</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;">consulter( <span class="argument">$ressources</span>, <span class="argument">$parametres</span>) : string</pre> |
| <p><em>Méthode appelée lors d'une requête HTTP de type GET.</em></p> |
| <p>Si la consultation est un succès, le code statut HTTP retourné sera 200. Dans tous les autres cas, |
| la méthode devra retourner le code statut HTTP adéquate.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$ressources</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$parametres</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>une chaine indiquant le succès de l'opération et les données demandées.</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_modifier" name="method_modifier" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">modifier()</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;">modifier( <span class="argument">$ressources</span>, <span class="argument">$requeteDonnees</span>) : mixed</pre> |
| <p><em>Méthode appelée lors d'une requête HTTP de type POST.</em></p> |
| <p>La ressource à modifier est indiquée via l'url. Les données devant servir à la mise à jours sont passées dans le corps |
| de la requête. |
| Si la modification est un succès, la méthode devra retourner "true" et le code statut HTTP retourné sera 201.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$ressources</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$requeteDonnees</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| — <p>une chaine indiquant le succès de l'opération ou rien.</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_ajouter" name="method_ajouter" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">ajouter()</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;">ajouter( <span class="argument">$ressources</span>, <span class="argument">$requeteDonnees</span>) : string</pre> |
| <p><em>Méthode appelée lors d'une requête HTTP de type PUT.</em></p> |
| <p>L'identifiant de la ressource à ajouter est indiqué via l'url si on le connait par avance. Sinon, il doit être créé par |
| le service. Dans ce dernier cas, le nouvel identifiant devrait être renvoyé dans le corps de la réponse. |
| Si l'ajout est un succès, la méthode devra retourner "true" ou l'identifiant. |
| Le code statut HTTP retourné sera 201 en cas de succès. |
| Dans le cas contraire, la méthode devra retourner false.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$ressources</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$requeteDonnees</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>l'identifiant créé.</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( <span class="argument">$ressources</span>) : mixed</pre> |
| <p><em>Méthode appelée lors d'une requête HTTP de type DELETE (ou POST avec action=DELETE dans le corps de la requete).</em></p> |
| <p>Si la suppression est un succès, la méthode devra retourner "true" et le code statut HTTP retourné par |
| RestServeur sera 204. |
| Si la ressource à supprimer est introuvable, la méthode devra retourner "false" et le code statut HTTP |
| retourné par RestServeur sera 404. |
| Dans les autres cas de figure ou si vous souhaitez gérer vos propres codes de retour erreur, retourner |
| la valeur null ou rien.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$ressources</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| — <p>une chaine indiquant le succès de l'opération ou rien.</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_getBdd" name="method_getBdd" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">getBdd()</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;">getBdd()</pre> |
| <p><em>Méthode de connection à la base de données sur demande.</em></p> |
| <p>Tous les services web n'ont pas besoin de s'y connecter.</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_getRestClient" name="method_getRestClient" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">getRestClient()</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;">getRestClient()</pre> |
| <p><em>Méthode permettant de faire appel à un client REST en fonction des besoins du service.</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_ajouterMessage" name="method_ajouterMessage" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">ajouterMessage()</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;">ajouterMessage(string <span class="argument">$message</span>)</pre> |
| <p><em>Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au client.</em></p> |
| <p>Le message doit être au format texte et en UTF-8.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$message</td> |
| <td><p>le message à envoyer.</p></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">RestService.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/RestService.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Url.html |
|---|
| New file |
| 0,0 → 1,1326 |
| <!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-1788291058"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-1788291058" 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>Url</h1> |
| <p><em>Classe Url, gérant le découpage des paramètres, leurs modification etc.</em></p> |
| <p>.. |
| Traduction et conversion d'une classe (NET_Url2) issue de Pear</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/Url.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/Url.html#method_getOption" class="">getOption()</a><br /> |
| <a href="../classes/Url.html#method_setOption" class="">setOption()</a><br /> |
| <a href="../classes/Url.html#method_setRequete" class="">setRequete()</a><br /> |
| <a href="../classes/Url.html#method_fusionnerRequete" class="">fusionnerRequete()</a><br /> |
| <a href="../classes/Url.html#method_normaliser" class="">normaliser()</a><br /> |
| <a href="../classes/Url.html#method_getCanonique" class="">getCanonique()</a><br /> |
| <a href="../classes/Url.html#method_getDemande" class="">getDemande()</a><br /> |
| <a href="../classes/Url.html#method_getURL" class="">getURL()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No public properties found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Url.html#constant_OPTION_UTILISER_CROCHETS" class="">OPTION_UTILISER_CROCHETS</a><br /> |
| <a href="../classes/Url.html#constant_OPTION_ENCODER_CLES" class="">OPTION_ENCODER_CLES</a><br /> |
| <a href="../classes/Url.html#constant_OPTION_ENCODER_VALEURS" class="">OPTION_ENCODER_VALEURS</a><br /> |
| <a href="../classes/Url.html#constant_OPTION_SEPARATEUR_ENTREE" class="">OPTION_SEPARATEUR_ENTREE</a><br /> |
| <a href="../classes/Url.html#constant_OPTION_SEPARATEUR_SORTIE" class="">OPTION_SEPARATEUR_SORTIE</a><br /> |
| </section> |
| </section> |
| <section class="row-fluid protected"> |
| <section class="span4"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/Url.html#method_getAutorite" class="">getAutorite()</a><br /> |
| <a href="../classes/Url.html#method_setAutorite" class="">setAutorite()</a><br /> |
| <a href="../classes/Url.html#method_etreAbsolue" class="">etreAbsolue()</a><br /> |
| <a href="../classes/Url.html#method_supprimerSegmentsAPoints" class="">supprimerSegmentsAPoints()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Url.html#property_options" class="">$options</a><br /> |
| <a href="../classes/Url.html#property_schema" class="">$schema</a><br /> |
| <a href="../classes/Url.html#property_infoUtilisateur" class="">$infoUtilisateur</a><br /> |
| <a href="../classes/Url.html#property_hote" class="">$hote</a><br /> |
| <a href="../classes/Url.html#property_port" class="">$port</a><br /> |
| <a href="../classes/Url.html#property_chemin" class="">$chemin</a><br /> |
| <a href="../classes/Url.html#property_requete" class="">$requete</a><br /> |
| <a href="../classes/Url.html#property_fragment" class="">$fragment</a><br /> |
| <a href="../classes/Url.html#property_parametres_obligatoires" class="">$parametres_obligatoires</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/Url.php.html"><div class="path-wrapper">Url.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Url</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>Php 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Christian SCHMIDT <a href="mailto:schmidt@php.net">schmidt@php.net</a> (Auteur classe originale)</p> |
| <p>Aurélien PERONNET <a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a></p> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <a id="constants" name="constants"></a> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <h2>Constants</h2> |
| </div> |
| <aside class="span4 detailsbar"></aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="constant_OPTION_UTILISER_CROCHETS" name="constant_OPTION_UTILISER_CROCHETS" class="anchor"></a> |
| <article id="constant_OPTION_UTILISER_CROCHETS" class="constant"> |
| <h3 class="">OPTION_UTILISER_CROCHETS</h3> |
| <pre class="signature">OPTION_UTILISER_CROCHETS</pre> |
| <p><em>Répresenter les tableaux dans les requêtes en utilisant la notation php []. Par défaut à true.</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="constant_OPTION_ENCODER_CLES" name="constant_OPTION_ENCODER_CLES" class="anchor"></a> |
| <article id="constant_OPTION_ENCODER_CLES" class="constant"> |
| <h3 class="">OPTION_ENCODER_CLES</h3> |
| <pre class="signature">OPTION_ENCODER_CLES</pre> |
| <p><em>URL-encoder les clés des variables dans les requêtes. Par défaut à true.</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="constant_OPTION_ENCODER_VALEURS" name="constant_OPTION_ENCODER_VALEURS" class="anchor"></a> |
| <article id="constant_OPTION_ENCODER_VALEURS" class="constant"> |
| <h3 class="">OPTION_ENCODER_VALEURS</h3> |
| <pre class="signature">OPTION_ENCODER_VALEURS</pre> |
| <p><em>URL-encoder les valeurs des variables dans les requêtes. Par défaut à false.</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="constant_OPTION_SEPARATEUR_ENTREE" name="constant_OPTION_SEPARATEUR_ENTREE" class="anchor"></a> |
| <article id="constant_OPTION_SEPARATEUR_ENTREE" class="constant"> |
| <h3 class="">OPTION_SEPARATEUR_ENTREE</h3> |
| <pre class="signature">OPTION_SEPARATEUR_ENTREE</pre> |
| <p><em>Séparateurs de variables lors du parsing de la requête. Chaque caractère |
| est considéré comme un séparateur. Par défaut, spécifié par le paramêtre |
| arg_separator.input dans php.ini (par défaut "&").</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="constant_OPTION_SEPARATEUR_SORTIE" name="constant_OPTION_SEPARATEUR_SORTIE" class="anchor"></a> |
| <article id="constant_OPTION_SEPARATEUR_SORTIE" class="constant"> |
| <h3 class="">OPTION_SEPARATEUR_SORTIE</h3> |
| <pre class="signature">OPTION_SEPARATEUR_SORTIE</pre> |
| <p><em>Séparateur de variables lors de la génération de la requête. Par défaut, spécifié |
| par le paramètre arg_separator.output dans php.ini (par défaut "&").</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="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="private ">$options</h3> |
| <pre class="signature">$options</pre> |
| <p><em>Options par défaut correspondant au comportement de php |
| vis à vis de $_GET</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="property_schema" name="property_schema" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$schema</h3> |
| <pre class="signature">$schema : string|bool</pre> |
| <p><em></em></p> |
| <h4>Type</h4> |
| string|bool |
| </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_infoUtilisateur" name="property_infoUtilisateur" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$infoUtilisateur</h3> |
| <pre class="signature">$infoUtilisateur : string|bool</pre> |
| <p><em></em></p> |
| <h4>Type</h4> |
| string|bool |
| </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_hote" name="property_hote" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$hote</h3> |
| <pre class="signature">$hote : string|bool</pre> |
| <p><em></em></p> |
| <h4>Type</h4> |
| string|bool |
| </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_port" name="property_port" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$port</h3> |
| <pre class="signature">$port : int|bool</pre> |
| <p><em></em></p> |
| <h4>Type</h4> |
| int|bool |
| </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_chemin" name="property_chemin" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$chemin</h3> |
| <pre class="signature">$chemin : string</pre> |
| <p><em></em></p> |
| <h4>Type</h4> |
| string |
| </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_requete" name="property_requete" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$requete</h3> |
| <pre class="signature">$requete : string|bool</pre> |
| <p><em></em></p> |
| <h4>Type</h4> |
| string|bool |
| </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_fragment" name="property_fragment" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$fragment</h3> |
| <pre class="signature">$fragment : string|bool</pre> |
| <p><em></em></p> |
| <h4>Type</h4> |
| string|bool |
| </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_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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(string <span class="argument">$url</span>, array <span class="argument">$options</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$url</td> |
| <td><p>une URL relative ou absolue</p></td> |
| </tr> |
| <tr> |
| <td>array</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 class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_getOption" name="method_getOption" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getOption()</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;">getOption(string <span class="argument">$nomOption</span>) : mixed</pre> |
| <p><em>Renvoie la valeur de l'option specifiée.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$nomOption</td> |
| <td><p>Nom de l'option demandée</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| </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_setOption" name="method_setOption" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">setOption()</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;">setOption(string <span class="argument">$nomOption</span>, mixed <span class="argument">$valeur</span>) : void</pre> |
| <p><em>Met à jour la valeur de l'option spécifiée.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$nomOption</td> |
| <td><p>une des constantes commençant par self::OPTION_</p></td> |
| </tr> |
| <tr> |
| <td>mixed</td> |
| <td>$valeur</td> |
| <td><p>valeur de l'option</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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_setRequete" name="method_setRequete" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">setRequete()</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;">setRequete(array <span class="argument">$parametres</span>) : void</pre> |
| <p><em>(Re-)Création de la partie requête de l'URL à partir des données du tableau (passé en paramètre).</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$parametres</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_fusionnerRequete" name="method_fusionnerRequete" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">fusionnerRequete()</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;">fusionnerRequete(array <span class="argument">$parametres</span>) : void</pre> |
| <p><em>(Re-)Création de la partie requête de l'URL à partir de la fusion du tableau (passé en paramètre) et |
| les valeurs présentes dans $_GET.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$parametres</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_normaliser" name="method_normaliser" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">normaliser()</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;">normaliser() : void</pre> |
| <p><em>Normalise les données de l'instance d'Url faisant appel à cette méthode.</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_getCanonique" name="method_getCanonique" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getCanonique()</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;">getCanonique() : \Url</pre> |
| <p><em>Renvoie une instance d'objet Url representant l'URL canonique du script PHP en cours d'éxécution.</em></p> |
| <h4>Returns</h4> |
| <a href="../classes/Url.html">\Url</a> |
| — <p>retourne un objet Url ou null en cas d'erreur.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_getDemande" name="method_getDemande" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getDemande()</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;">getDemande() : \Url</pre> |
| <p><em>Renvoie une instance d'objet Url representant l'URL utilisée pour récupérer la requête en cours.</em></p> |
| <h4>Returns</h4> |
| <a href="../classes/Url.html">\Url</a> |
| — <p>retourne un objet Url ou null en cas d'erreur.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_getURL" name="method_getURL" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getURL()</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;">getURL() : string</pre> |
| <p><em>Renvoie un représentation sous forme de chaine de l'URL.</em></p> |
| <h4>Returns</h4> |
| string |
| — <p>l'url</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_getAutorite" name="method_getAutorite" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">getAutorite()</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;">getAutorite() : string|bool</pre> |
| <p><em>Renvoie la partie autorité, i.e. [ infoUtilisateur "@" ] hote [ ":" port ], ou |
| false si celle-ci est absente.</em></p> |
| <h4>Returns</h4> |
| string|bool |
| </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_setAutorite" name="method_setAutorite" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">setAutorite()</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;">setAutorite(string|false <span class="argument">$autorite</span>) : void</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string|false</td> |
| <td>$autorite</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_etreAbsolue" name="method_etreAbsolue" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">etreAbsolue()</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;">etreAbsolue() : bool</pre> |
| <p><em>Renvoie vrai ou faux suivant que l'instance en cours représente une URL relative ou absolue.</em></p> |
| <h4>Returns</h4> |
| bool |
| </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_supprimerSegmentsAPoints" name="method_supprimerSegmentsAPoints" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">supprimerSegmentsAPoints()</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;">supprimerSegmentsAPoints(string <span class="argument">$chemin</span>) : string</pre> |
| <p><em>La suppression des segments à points est décrite dans la RFC 3986, section 5.2.4, e.g.</em></p> |
| <p>"/foo/../bar/baz" => "/bar/baz"</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$chemin</td> |
| <td><p>un chemin</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>un chemin</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Url.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Url.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Cache.html |
|---|
| New file |
| 0,0 → 1,1944 |
| <!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-928765481"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-928765481" 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>Cache</h1> |
| <p><em>Classe Cache permettant de mettre en cache des données.</em></p> |
| <p>Basée sur les principes de Zend_Cache (Copyright (c) 2005-2010, Zend Technologies USA, Inc. All rights reserved.)</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/Cache.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/Cache.html#method_setEmplacement" class="">setEmplacement()</a><br /> |
| <a href="../classes/Cache.html#method_fabriquer" class="">fabriquer()</a><br /> |
| <a href="../classes/Cache.html#method_charger" class="">charger()</a><br /> |
| <a href="../classes/Cache.html#method_tester" class="">tester()</a><br /> |
| <a href="../classes/Cache.html#method_sauver" class="">sauver()</a><br /> |
| <a href="../classes/Cache.html#method_supprimer" class="">supprimer()</a><br /> |
| <a href="../classes/Cache.html#method_nettoyer" class="">nettoyer()</a><br /> |
| <a href="../classes/Cache.html#method_getIds" class="">getIds()</a><br /> |
| <a href="../classes/Cache.html#method_getTags" class="">getTags()</a><br /> |
| <a href="../classes/Cache.html#method_getIdsAvecLesTags" class="">getIdsAvecLesTags()</a><br /> |
| <a href="../classes/Cache.html#method_getIdsSansLesTags" class="">getIdsSansLesTags()</a><br /> |
| <a href="../classes/Cache.html#method_getIdsAvecUnTag" class="">getIdsAvecUnTag()</a><br /> |
| <a href="../classes/Cache.html#method_getPourcentageRemplissage" class="">getPourcentageRemplissage()</a><br /> |
| <a href="../classes/Cache.html#method_getMetadonnees" class="">getMetadonnees()</a><br /> |
| <a href="../classes/Cache.html#method_ajouterSupplementDureeDeVie" class="">ajouterSupplementDureeDeVie()</a><br /> |
| <a href="../classes/Cache.html#method_getTimestampExpiration" class="">getTimestampExpiration()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No public properties found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Cache.html#constant_STOCKAGE_MODE_SIMPLE" class="">STOCKAGE_MODE_SIMPLE</a><br /> |
| <a href="../classes/Cache.html#constant_STOCKAGE_MODE_FICHIER" class="">STOCKAGE_MODE_FICHIER</a><br /> |
| <a href="../classes/Cache.html#constant_STOCKAGE_MODE_SQLITE" class="">STOCKAGE_MODE_SQLITE</a><br /> |
| <a href="../classes/Cache.html#constant_NETTOYAGE_MODE_TOUS" class="">NETTOYAGE_MODE_TOUS</a><br /> |
| <a href="../classes/Cache.html#constant_NETTOYAGE_MODE_EXPIRATION" class="">NETTOYAGE_MODE_EXPIRATION</a><br /> |
| <a href="../classes/Cache.html#constant_NETTOYAGE_MODE_AVEC_LES_TAGS" class="">NETTOYAGE_MODE_AVEC_LES_TAGS</a><br /> |
| <a href="../classes/Cache.html#constant_NETTOYAGE_MODE_SANS_LES_TAGS" class="">NETTOYAGE_MODE_SANS_LES_TAGS</a><br /> |
| <a href="../classes/Cache.html#constant_NETTOYAGE_MODE_AVEC_UN_TAG" class="">NETTOYAGE_MODE_AVEC_UN_TAG</a><br /> |
| </section> |
| </section> |
| <section class="row-fluid protected"> |
| <section class="span4"> |
| <a href="../classes/Cache.html#method_validerIdOuTag" class="">validerIdOuTag()</a><br /> |
| <a href="../classes/Cache.html#method_validerTableauDeTags" class="">validerTableauDeTags()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Cache.html#property_options" class="">$options</a><br /> |
| <a href="../classes/Cache.html#property_stockage" class="">$stockage</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/Cache.html#method_initialiserOptionsParConfig" class="">initialiserOptionsParConfig()</a><br /> |
| <a href="../classes/Cache.html#method_setOptions" class="">setOptions()</a><br /> |
| <a href="../classes/Cache.html#method_prefixerId" class="">prefixerId()</a><br /> |
| <a href="../classes/Cache.html#method_executerMethodeStockage" class="">executerMethodeStockage()</a><br /> |
| <a href="../classes/Cache.html#method_supprimerPrefixe" class="">supprimerPrefixe()</a><br /> |
| <a href="../classes/Cache.html#method_controlerEcriture" class="">controlerEcriture()</a><br /> |
| <a href="../classes/Cache.html#method_deserialiserAutomatiquement" class="">deserialiserAutomatiquement()</a><br /> |
| <a href="../classes/Cache.html#method_serialiserAutomatiquement" class="">serialiserAutomatiquement()</a><br /> |
| <a href="../classes/Cache.html#method_nettoyerAutomatiquement" class="">nettoyerAutomatiquement()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Cache.html#property_dernier_id" class="">$dernier_id</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/Cache.php.html"><div class="path-wrapper">Cache.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Cache</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>php 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://framework.zend.com/license/new-bsd">http://framework.zend.com/license/new-bsd</a> Licence New BSD</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Cache.php 299 2011-01-18 14:03:46Z jpm $</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <a id="constants" name="constants"></a> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <h2>Constants</h2> |
| </div> |
| <aside class="span4 detailsbar"></aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="constant_STOCKAGE_MODE_SIMPLE" name="constant_STOCKAGE_MODE_SIMPLE" class="anchor"></a> |
| <article id="constant_STOCKAGE_MODE_SIMPLE" class="constant"> |
| <h3 class="">STOCKAGE_MODE_SIMPLE</h3> |
| <pre class="signature">STOCKAGE_MODE_SIMPLE</pre> |
| <p><em>Socke les enregistrements du cache dans des fichiers textes de façon extremement simple.</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="constant_STOCKAGE_MODE_FICHIER" name="constant_STOCKAGE_MODE_FICHIER" class="anchor"></a> |
| <article id="constant_STOCKAGE_MODE_FICHIER" class="constant"> |
| <h3 class="">STOCKAGE_MODE_FICHIER</h3> |
| <pre class="signature">STOCKAGE_MODE_FICHIER</pre> |
| <p><em>Socke les enregistrements du cache dans des fichiers textes.</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="constant_STOCKAGE_MODE_SQLITE" name="constant_STOCKAGE_MODE_SQLITE" class="anchor"></a> |
| <article id="constant_STOCKAGE_MODE_SQLITE" class="constant"> |
| <h3 class="">STOCKAGE_MODE_SQLITE</h3> |
| <pre class="signature">STOCKAGE_MODE_SQLITE</pre> |
| <p><em>Socke les enregistrements du cache dans une base de données SQLite.</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="constant_NETTOYAGE_MODE_TOUS" name="constant_NETTOYAGE_MODE_TOUS" class="anchor"></a> |
| <article id="constant_NETTOYAGE_MODE_TOUS" class="constant"> |
| <h3 class="">NETTOYAGE_MODE_TOUS</h3> |
| <pre class="signature">NETTOYAGE_MODE_TOUS</pre> |
| <p><em>'tous' (par défaut) : supprime tous les enregistrements.</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="constant_NETTOYAGE_MODE_EXPIRATION" name="constant_NETTOYAGE_MODE_EXPIRATION" class="anchor"></a> |
| <article id="constant_NETTOYAGE_MODE_EXPIRATION" class="constant"> |
| <h3 class="">NETTOYAGE_MODE_EXPIRATION</h3> |
| <pre class="signature">NETTOYAGE_MODE_EXPIRATION</pre> |
| <p><em>'expiration' : supprime tous les enregistrements dont la date d'expériration est dépassée.</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="constant_NETTOYAGE_MODE_AVEC_LES_TAGS" name="constant_NETTOYAGE_MODE_AVEC_LES_TAGS" class="anchor"></a> |
| <article id="constant_NETTOYAGE_MODE_AVEC_LES_TAGS" class="constant"> |
| <h3 class="">NETTOYAGE_MODE_AVEC_LES_TAGS</h3> |
| <pre class="signature">NETTOYAGE_MODE_AVEC_LES_TAGS</pre> |
| <p><em>'avecLesTags' : supprime tous les enregistrements contenant tous les tags indiqués.</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="constant_NETTOYAGE_MODE_SANS_LES_TAGS" name="constant_NETTOYAGE_MODE_SANS_LES_TAGS" class="anchor"></a> |
| <article id="constant_NETTOYAGE_MODE_SANS_LES_TAGS" class="constant"> |
| <h3 class="">NETTOYAGE_MODE_SANS_LES_TAGS</h3> |
| <pre class="signature">NETTOYAGE_MODE_SANS_LES_TAGS</pre> |
| <p><em>'sansLesTags' : supprime tous les enregistrements contenant aucun des tags indiqués.</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="constant_NETTOYAGE_MODE_AVEC_UN_TAG" name="constant_NETTOYAGE_MODE_AVEC_UN_TAG" class="anchor"></a> |
| <article id="constant_NETTOYAGE_MODE_AVEC_UN_TAG" class="constant"> |
| <h3 class="">NETTOYAGE_MODE_AVEC_UN_TAG</h3> |
| <pre class="signature">NETTOYAGE_MODE_AVEC_UN_TAG</pre> |
| <p><em>'avecUnTag' : supprime tous les enregistrements contenant au moins un des tags indiqués.</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="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>Les options disponibles pour le cache : |
| ====> (string) stockage_mode : |
| Indique le mode de stockage du cache à utiliser parmis : |
| - Cache::STOCKAGE_MODE_FICHIER : sous forme d'une arborescence de fichiers et dossier |
| - Cache::STOCKAGE_MODE_SQLITE : sous forme d'une base de données SQLite</em></p> |
| <p>====> (string) stockage_chemin : |
| Chemin vers :</p> |
| <ul> |
| <li>Cache::STOCKAGE_MODE_FICHIER : le dossier devant contenir l'arborescence.</li> |
| <li>Cache::STOCKAGE_MODE_SQLITE : le fichier contenant la base SQLite.</li> |
| </ul> |
| <p>====> (boolean) controle_ecriture :</p> |
| <ul> |
| <li>Active / Désactive le controle d'écriture (le cache est lue jute après l'écriture du fichier pour détecter sa corruption)</li> |
| <li>Activer le controle d'écriture ralentira légèrement l'écriture du fichier de cache mais pas sa lecture |
| Le controle d'écriture peut détecter la corruption de fichier mais ce n'est pas un système de controle parfait.</li> |
| </ul> |
| <p>====> (boolean) mise_en_cache :</p> |
| <ul> |
| <li>Active / Désactive la mise en cache |
| (peut être très utile pour le débogage des scripts utilisant le cache</li> |
| </ul> |
| <p>=====> (string) cache_id_prefixe :</p> |
| <ul> |
| <li>préfixe pour les identifiant de cache ( = espace de nom)</li> |
| </ul> |
| <p>====> (boolean) serialisation_auto :</p> |
| <ul> |
| <li>Active / Désactive la sérialisation automatique</li> |
| <li>Peut être utilisé pour sauver directement des données qui ne sont pas des chaines (mais c'est plus lent)</li> |
| </ul> |
| <p>====> (int) nettoyage_auto :</p> |
| <ul> |
| <li>Désactive / Régler le processus de nettoyage automatique</li> |
| <li>Le processus de nettoyage automatiques détruit les fichier trop vieux (pour la durée de vie donnée) |
| quand un nouveau fichier de cache est écrit : |
| 0 => pas de nettoyage automatique |
| 1 => nettoyage automatique systématique |
| x (integer) > 1 => nettoyage automatique toutes les 1 fois (au hasard) sur x écriture de fichier de cache</li> |
| </ul> |
| <p>====> (int) duree_de_vie :</p> |
| <ul> |
| <li>Durée de vie du cache (en secondes)</li> |
| <li>Si null, le cache est valide indéfiniment.</li> |
| </ul> |
| <h4>Type</h4> |
| array |
| — les options disponibles pour le cache . </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_stockage" name="property_stockage" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$stockage</h3> |
| <pre class="signature">$stockage</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="property_dernier_id" name="property_dernier_id" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$dernier_id</h3> |
| <pre class="signature">$dernier_id : string</pre> |
| <p><em>Dernier identifiant de cache utilisé.</em></p> |
| <h4>Type</h4> |
| string |
| </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( <span class="argument">$options</span>, <span class="argument">$options_stockage</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> |
| <tr> |
| <td></td> |
| <td>$options_stockage</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_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(string <span class="argument">$emplacement</span>) : void</pre> |
| <p><em>Permet de (re-)définir l'emplacement pour le stockage du cache.</em></p> |
| <p>En fonction du mode de stockage utilisé , l'emplacement indiqué correspondra au chemin du :</p> |
| <ul> |
| <li>dossier où stocker les fichiers pour le mode "fichier".</li> |
| <li>fichier de la base de données pour le mode "sqlite".</li> |
| </ul> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$emplacement</td> |
| <td><p>chemin vers dossier (Cache::STOCKAGE_MODE_FICHIER) ou fichier base Sqlite (Cache::STOCKAGE_MODE_SQLITE)</p></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_fabriquer" name="method_fabriquer" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">fabriquer()</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;">fabriquer( <span class="argument">$mode</span>, <span class="argument">$options</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$mode</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$options</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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>, boolean <span class="argument">$ne_pas_tester_validiter_du_cache</span>) : mixed|false</pre> |
| <p><em>Teste si un cache est disponible pour l'identifiant donné et (si oui) le retourne (false dans le cas contraire)</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> |
| <tr> |
| <td>boolean</td> |
| <td>$ne_pas_tester_validiter_du_cache</td> |
| <td><p>Si mis à true, la validité du cache n'est pas testée</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed|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>) : int|false</pre> |
| <p><em>Test if a cache is available 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> |
| int|false |
| — <p>Last modified time of cache entry if it is available, false otherwise</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(mixed <span class="argument">$donnees</span>, string <span class="argument">$id</span>, array <span class="argument">$tags</span>, int <span class="argument">$duree_de_vie_specifique</span>) : boolean</pre> |
| <p><em>Sauvegarde en cache les données passées en paramètre.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>mixed</td> |
| <td>$donnees</td> |
| <td><p>Données à mettre en cache (peut être différent d'une chaine si serialisation_auto vaut true).</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$id</td> |
| <td><p>Identifiant du cache (s'il n'est pas définit, le dernier identifiant sera utilisé).</p></td> |
| </tr> |
| <tr> |
| <td>array</td> |
| <td>$tags</td> |
| <td><p>Mots-clés du cache.</p></td> |
| </tr> |
| <tr> |
| <td>int</td> |
| <td>$duree_de_vie_specifique</td> |
| <td><p>Si != false, indique une durée de vie spécifique pour cet enregistrement en cache (null => durée de vie infinie)</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>True si aucun problème n'est survenu.</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>Supprime un enregistrement en cache.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$id</td> |
| <td><p>Identificant du cache à supprimer.</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>True si 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_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>, array|string <span class="argument">$tags</span>) : boolean</pre> |
| <p><em>Nettoyage des enregistrements en cache</em></p> |
| <p>Mode de nettoyage disponibles : |
| 'tous' (défaut) => supprime tous les enregistrements ($tags n'est pas utilisé) |
| 'expiration' => supprime tous les enregistrements dont la date d'expériration est dépassée ($tags n'est pas utilisé) |
| 'avecLesTag' => supprime tous les enregistrements contenant tous les tags indiqués |
| 'sansLesTag' => supprime tous les enregistrements contenant aucun des tags indiqués |
| 'avecUnTag' => supprime tous les enregistrements contenant au moins un des tags indiqués</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$mode</td> |
| <td><p>mode de nettoyage</p></td> |
| </tr> |
| <tr> |
| <td>array|string</td> |
| <td>$tags</td> |
| <td><p>peut être un tableau de chaîne ou une simple chaine.</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>True si 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_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 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 matching any 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>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 will 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_getTimestampExpiration" name="method_getTimestampExpiration" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getTimestampExpiration()</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;">getTimestampExpiration( <span class="argument">$duree_de_vie</span>) : int</pre> |
| <p><em>Calcule et retourne le timestamp d'expiration</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$duree_de_vie</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| int |
| — <p>timestamp d'expiration (unix timestamp)</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_validerIdOuTag" name="method_validerIdOuTag" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">validerIdOuTag()</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;">validerIdOuTag(string <span class="argument">$chaine</span>) : void</pre> |
| <p><em>Valide un identifiant de cache ou un tag (securité, nom de fichiers fiables, préfixes réservés.</em></p> |
| <p>..)</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$chaine</td> |
| <td><p>Identificant de cache ou tag</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_validerTableauDeTags" name="method_validerTableauDeTags" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">validerTableauDeTags()</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;">validerTableauDeTags(array <span class="argument">$tags</span>) : void</pre> |
| <p><em>Valide un tableau de tags (securité, nom de fichiers fiables, préfixes réservés.</em></p> |
| <p>..)</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$tags</td> |
| <td><p>tableau de tags</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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 class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_prefixerId" name="method_prefixerId" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">prefixerId()</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;">prefixerId(string <span class="argument">$id</span>) : string</pre> |
| <p><em>Fabrique et retourne l'identifiant du cache avec son préfixe.</em></p> |
| <p>Vérifie l'option 'cache_id_prefixe' et retourne le nouvel id avec préfixe ou simplement l'id lui même si elle vaut null.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$id</td> |
| <td><p>Identifiant du cache.</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>Identifiant du cache avec ou sans préfixe.</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_executerMethodeStockage" name="method_executerMethodeStockage" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">executerMethodeStockage()</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;">executerMethodeStockage( <span class="argument">$methode</span>, <span class="argument">$params</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$methode</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$params</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_supprimerPrefixe" name="method_supprimerPrefixe" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">supprimerPrefixe()</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;">supprimerPrefixe( <span class="argument">$ids</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$ids</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_controlerEcriture" name="method_controlerEcriture" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">controlerEcriture()</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;">controlerEcriture( <span class="argument">$id</span>, <span class="argument">$donnees_avant_ecriture</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$id</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$donnees_avant_ecriture</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_deserialiserAutomatiquement" name="method_deserialiserAutomatiquement" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">deserialiserAutomatiquement()</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;">deserialiserAutomatiquement( <span class="argument">$donnees</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$donnees</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_serialiserAutomatiquement" name="method_serialiserAutomatiquement" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">serialiserAutomatiquement()</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;">serialiserAutomatiquement( <span class="argument">$donnees</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$donnees</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_nettoyerAutomatiquement" name="method_nettoyerAutomatiquement" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">nettoyerAutomatiquement()</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;">nettoyerAutomatiquement()</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> |
| </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">Cache.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Cache.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Script.html |
|---|
| New file |
| 0,0 → 1,1374 |
| <!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-1514334818"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-1514334818" 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>Script</h1> |
| <p><em>Script est une classe abstraite qui doit être implémenté par les classes éxecutant des scripts en ligne de commande.</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/Script.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/Script.html#method_executer" class="">executer()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No public properties found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Script.html#constant_MSG_LOG" class="">MSG_LOG</a><br /> |
| <a href="../classes/Script.html#constant_MSG_ERREUR" class="">MSG_ERREUR</a><br /> |
| <a href="../classes/Script.html#constant_MSG_AVERTISSEMENT" class="">MSG_AVERTISSEMENT</a><br /> |
| <a href="../classes/Script.html#constant_MSG_INFO" class="">MSG_INFO</a><br /> |
| </section> |
| </section> |
| <section class="row-fluid protected"> |
| <section class="span4"> |
| <a href="../classes/Script.html#method_getScriptNom" class="">getScriptNom()</a><br /> |
| <a href="../classes/Script.html#method_getScriptChemin" class="">getScriptChemin()</a><br /> |
| <a href="../classes/Script.html#method_getParametre" class="">getParametre()</a><br /> |
| <a href="../classes/Script.html#method_traiterErreur" class="">traiterErreur()</a><br /> |
| <a href="../classes/Script.html#method_traiterAvertissement" class="">traiterAvertissement()</a><br /> |
| <a href="../classes/Script.html#method_traiterInfo" class="">traiterInfo()</a><br /> |
| <a href="../classes/Script.html#method_formaterMsg" class="">formaterMsg()</a><br /> |
| <a href="../classes/Script.html#method_afficherAvancement" class="">afficherAvancement()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Script.html#property_parametres_autorises" class="">$parametres_autorises</a><br /> |
| <a href="../classes/Script.html#property_parametres" class="">$parametres</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/Script.html#method_getMsgNiveauTxt" class="">getMsgNiveauTxt()</a><br /> |
| <a href="../classes/Script.html#method_chargerParametresAutorises" class="">chargerParametresAutorises()</a><br /> |
| <a href="../classes/Script.html#method_chargerParametres" class="">chargerParametres()</a><br /> |
| <a href="../classes/Script.html#method_traiterMessage" class="">traiterMessage()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Script.html#property_msg_niveaux_txt" class="">$msg_niveaux_txt</a><br /> |
| <a href="../classes/Script.html#property_script_nom" class="">$script_nom</a><br /> |
| <a href="../classes/Script.html#property_parametres_autorises_defaut" class="">$parametres_autorises_defaut</a><br /> |
| <a href="../classes/Script.html#property_parametres_cli" class="">$parametres_cli</a><br /> |
| <a href="../classes/Script.html#property_avancement" class="">$avancement</a><br /> |
| <a href="../classes/Script.html#property_parametres_obligatoires" class="">$parametres_obligatoires</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| </section> |
| </div> |
| <aside class="span4 detailsbar"> |
| <span class="label label-info">abstract</span> |
| <dl> |
| <dt>File</dt> |
| <dd><a href="../files/Script.php.html"><div class="path-wrapper">Script.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Script</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| <p>Delphine CAUQUIL <a href="mailto:delphine@tela-botanica.org">delphine@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Script.php 299 2011-01-18 14:03:46Z jpm $</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <a id="constants" name="constants"></a> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <h2>Constants</h2> |
| </div> |
| <aside class="span4 detailsbar"></aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="constant_MSG_LOG" name="constant_MSG_LOG" class="anchor"></a> |
| <article id="constant_MSG_LOG" class="constant"> |
| <h3 class="">MSG_LOG</h3> |
| <pre class="signature">MSG_LOG</pre> |
| <p><em>Niveau de message de type LOG</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="constant_MSG_ERREUR" name="constant_MSG_ERREUR" class="anchor"></a> |
| <article id="constant_MSG_ERREUR" class="constant"> |
| <h3 class="">MSG_ERREUR</h3> |
| <pre class="signature">MSG_ERREUR</pre> |
| <p><em>Niveau de message de type ERREUR</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="constant_MSG_AVERTISSEMENT" name="constant_MSG_AVERTISSEMENT" class="anchor"></a> |
| <article id="constant_MSG_AVERTISSEMENT" class="constant"> |
| <h3 class="">MSG_AVERTISSEMENT</h3> |
| <pre class="signature">MSG_AVERTISSEMENT</pre> |
| <p><em>Niveau de message de type AVERTISSEMENT</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="constant_MSG_INFO" name="constant_MSG_INFO" class="anchor"></a> |
| <article id="constant_MSG_INFO" class="constant"> |
| <h3 class="">MSG_INFO</h3> |
| <pre class="signature">MSG_INFO</pre> |
| <p><em>Niveau de message de type INFORMATION</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="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_parametres_autorises" name="property_parametres_autorises" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$parametres_autorises</h3> |
| <pre class="signature">$parametres_autorises : array</pre> |
| <p><em>Paramêtres autorisés par le script.</em></p> |
| <p>le tableau est de la forme suivante :</p> |
| <ul> |
| <li>clé = nom du paramêtre '-foo'</li> |
| <li>value = contient un nouveau tableau composé de cette façon : |
| <ul> |
| <li>booléen: true si le paramêtre est obligatoire</li> |
| <li>booléen ou var : true si le paramêtre nécessite un valeur à sa suite ou la valeur par défaut</li> |
| <li>string: description du contenu du paramêtre |
| Les paramêtres optionels devraient être déclaré à la fin du tableau. |
| Le dernier parametre du tableau peut avoir la valeur '...', |
| il contiendra alors l'ensemble des paramêtres suivant trouvés sur la ligne de commande.</li> |
| </ul> |
| </li> |
| </ul> |
| <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_parametres" name="property_parametres" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$parametres</h3> |
| <pre class="signature">$parametres : array</pre> |
| <p><em>Contient le tableau des paramètres disponible après vérification : |
| le tableau est de la forme suivante : |
| - clé = nom du paramêtre '-foo' |
| - valeur = la valeur récupérée sur la ligne de commande</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_msg_niveaux_txt" name="property_msg_niveaux_txt" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$msg_niveaux_txt</h3> |
| <pre class="signature">$msg_niveaux_txt</pre> |
| <p><em>Inititulé des différents types de message.</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="property_script_nom" name="property_script_nom" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$script_nom</h3> |
| <pre class="signature">$script_nom : string</pre> |
| <p><em>Le nom du script tel que passé dans la ligne de commande.</em></p> |
| <h4>Type</h4> |
| string |
| </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_parametres_autorises_defaut" name="property_parametres_autorises_defaut" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_autorises_defaut</h3> |
| <pre class="signature">$parametres_autorises_defaut : array</pre> |
| <p><em>Paramêtres par défaut disponibles pour la ligne de commande |
| le tableau se construit de la forme suivante : |
| - clé = nom du paramêtre '-foo' |
| - value = contient un nouveau tableau composé de cette façon : |
| - booléen: true si le paramêtre est obligatoire |
| - booléen ou var : true si le paramêtre nécessite un valeur à sa suite ou la valeur par défaut |
| - string: description du contenu du paramêtre |
| Les paramêtres optionels devraient être déclaré à la fin du tableau.</em></p> |
| <p>Le dernier parametre du tableau peut avoir la valeur '...', |
| il contiendra alors l'ensemble des paramêtres suivant trouvés sur la ligne de commande.</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_parametres_cli" name="property_parametres_cli" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_cli</h3> |
| <pre class="signature">$parametres_cli : array</pre> |
| <p><em>Contient les valeurs des paramêtres récupérés de la ligne de commande : |
| le tableau se construit de la forme suivnate : |
| - clé = nom du paramêtre '-foo' |
| - valeur = la valeur récupérée sur la ligne de commande</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_avancement" name="property_avancement" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$avancement</h3> |
| <pre class="signature">$avancement : array</pre> |
| <p><em>Tableau associatif permettant de stocker l'avancement dans une boucle.</em></p> |
| <p>La clé est un md5 du message à afficher au démarrage de la boucle.</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_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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( <span class="argument">$script_nom</span>, <span class="argument">$parametres_cli</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$script_nom</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$parametres_cli</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_executer" name="method_executer" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">executer()</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;">executer()</pre> |
| <p><em></em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">abstract</span> |
| <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_getScriptNom" name="method_getScriptNom" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">getScriptNom()</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;">getScriptNom()</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_getScriptChemin" name="method_getScriptChemin" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">getScriptChemin()</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;">getScriptChemin( <span class="argument">$doit_exister</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$doit_exister</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_getParametre" name="method_getParametre" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">getParametre()</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;">getParametre( <span class="argument">$parametre</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$parametre</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_traiterErreur" name="method_traiterErreur" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">traiterErreur()</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;">traiterErreur( <span class="argument">$message</span>, <span class="argument">$tab_arguments</span>) : \void.</pre> |
| <p><em>Affiche un message d'erreur formaté.</em></p> |
| <p>Si le paramétre de verbosité (-v) vaut 1 ou plus, le message est écrit dans le fichier de log et afficher dans la console.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$message</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$tab_arguments</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| \void. |
| </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_traiterAvertissement" name="method_traiterAvertissement" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">traiterAvertissement()</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;">traiterAvertissement( <span class="argument">$message</span>, <span class="argument">$tab_arguments</span>) : \void.</pre> |
| <p><em>Affiche un message d'avertissement formaté.</em></p> |
| <p>Si le paramétre de verbosité (-v) vaut 1, le message est écrit dans le fichier de log. |
| Si le paramétre de verbosité (-v) vaut 2 ou plus, le message est écrit dans le fichier de log et afficher dans la console.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$message</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$tab_arguments</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| \void. |
| </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_traiterInfo" name="method_traiterInfo" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">traiterInfo()</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;">traiterInfo( <span class="argument">$message</span>, <span class="argument">$tab_arguments</span>) : \void.</pre> |
| <p><em>Retourne un message d'information formaté.</em></p> |
| <p>Si le paramétre de verbosité (-v) vaut 1 ou 2 , le message est écrit dans le fichier de log. |
| Si le paramétre de verbosité (-v) vaut 3 ou plus, le message est écrit dans le fichier de log et afficher dans la console.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$message</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$tab_arguments</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| \void. |
| </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_formaterMsg" name="method_formaterMsg" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">formaterMsg()</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;">formaterMsg( <span class="argument">$message</span>, <span class="argument">$tab_arguments</span>, <span class="argument">$niveau</span>) : string</pre> |
| <p><em>Retourne un message d'information formaté.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$message</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$tab_arguments</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$niveau</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>le message d'erreur formaté.</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_afficherAvancement" name="method_afficherAvancement" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">afficherAvancement()</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;">afficherAvancement( <span class="argument">$message</span>, <span class="argument">$depart</span>) : void</pre> |
| <p><em>Utiliser cette méthode dans une boucle pour afficher un message suivi du nombre de tour de boucle effectué.</em></p> |
| <p>Vous devrez vous même gérer le retour à la ligne à la sortie de la boucle.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$message</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$depart</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_getMsgNiveauTxt" name="method_getMsgNiveauTxt" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">getMsgNiveauTxt()</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;">getMsgNiveauTxt( <span class="argument">$niveau</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$niveau</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_chargerParametresAutorises" name="method_chargerParametresAutorises" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">chargerParametresAutorises()</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;">chargerParametresAutorises()</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_chargerParametres" name="method_chargerParametres" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">chargerParametres()</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;">chargerParametres()</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_traiterMessage" name="method_traiterMessage" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">traiterMessage()</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;">traiterMessage( <span class="argument">$message</span>, <span class="argument">$tab_arguments</span>, <span class="argument">$niveau</span>) : \void.</pre> |
| <p><em>Retourne un message formaté en le stockant dans un fichier de log si nécessaire.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$message</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$tab_arguments</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$niveau</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| \void. |
| </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">Script.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Script.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Encodage.html |
|---|
| New file |
| 0,0 → 1,476 |
| <!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-1435163241"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-1435163241" 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>Encodage</h1> |
| <p><em>Classe fournissant des méthodes statiques concernant l'encodage et le décodage des caractères de variable.</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/Encodage.html#method_encoderEnUtf8" class="">encoderEnUtf8()</a><br /> |
| <a href="../classes/Encodage.html#method_detecterUtf8" class="">detecterUtf8()</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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <em>No private methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No private properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| </section> |
| </div> |
| <aside class="span4 detailsbar"> |
| <dl> |
| <dt>File</dt> |
| <dd><a href="../files/utilitaires.Encodage.php.html"><div class="path-wrapper">utilitaires/Encodage.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Utilitaire</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Encodage</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Encodage.php 299 2011-01-18 14:03:46Z jpm $</p> |
| </td> |
| </tr> |
| <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_encoderEnUtf8" name="method_encoderEnUtf8" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">encoderEnUtf8()</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;">encoderEnUtf8( <span class="argument">$variable</span>, <span class="argument">$encodage</span>) : mixed</pre> |
| <p><em>Méthode permettant d'encoder par défaut de ISO-8859-15 vers UTF-8 une variable ou un tableau de variables.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$variable</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$encodage</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| — <p>la chaine ou le tableau encodé en UTF-8.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_detecterUtf8" name="method_detecterUtf8" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">detecterUtf8()</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;">detecterUtf8( <span class="argument">$chaine</span>) : bool</pre> |
| <p><em>Méthode permettant de détecter réellement l'encodage UTF-8.</em></p> |
| <p>mb_detect_encoding plante si la chaine de caractère se termine par un caractère accentué. |
| Provient de PHPDIG.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$chaine</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| bool |
| — <p>true si c'est de UTF-8, sinon false.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Encodage.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/utilitaires/Encodage.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Config.html |
|---|
| New file |
| 0,0 → 1,1099 |
| <!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-1349826691"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-1349826691" 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>Config</h1> |
| <p><em>Config permet de charger automatiquement les fichiers ini du Framework et de l'application.</em></p> |
| <p>Elle offre l'accès en lecture seule aux paramètres de config. |
| C'est une Singleton. |
| Si vous avez besoin de modifier dynamiquement des paramètres de configuration, utiliser le @see Registe, il est fait pour ça.</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/Config.html#method_charger" class="">charger()</a><br /> |
| <a href="../classes/Config.html#method_get" class="">get()</a><br /> |
| <a href="../classes/Config.html#method_existe" class="">existe()</a><br /> |
| <a href="../classes/Config.html#method_verifierPresenceParametres" class="">verifierPresenceParametres()</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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/Config.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/Config.html#method_chargerFichierContexte" class="">chargerFichierContexte()</a><br /> |
| <a href="../classes/Config.html#method_parserFichierIni" class="">parserFichierIni()</a><br /> |
| <a href="../classes/Config.html#method_fusionner" class="">fusionner()</a><br /> |
| <a href="../classes/Config.html#method_getValeur" class="">getValeur()</a><br /> |
| <a href="../classes/Config.html#method_existeValeur" class="">existeValeur()</a><br /> |
| <a href="../classes/Config.html#method_verifierCreationInstance" class="">verifierCreationInstance()</a><br /> |
| <a href="../classes/Config.html#method_analyserTableauIni" class="">analyserTableauIni()</a><br /> |
| <a href="../classes/Config.html#method_evaluerCle" class="">evaluerCle()</a><br /> |
| <a href="../classes/Config.html#method_evaluerReferences" class="">evaluerReferences()</a><br /> |
| <a href="../classes/Config.html#method_evaluerPhp" class="">evaluerPhp()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Config.html#property_instance" class="">$instance</a><br /> |
| <a href="../classes/Config.html#property_parametres" class="">$parametres</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/Config.php.html"><div class="path-wrapper">Config.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Config</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Config.php 448 2013-12-19 13:37:39Z jpm $</p> |
| </td> |
| </tr> |
| <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_instance" name="property_instance" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$instance</h3> |
| <pre class="signature">$instance</pre> |
| <p><em>Instance de la classe pointant sur elle même (pour le pattern singleton).</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="property_parametres" name="property_parametres" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres</h3> |
| <pre class="signature">$parametres</pre> |
| <p><em>Paramètres de configuration.</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_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">$fichier_ini</span>) : array</pre> |
| <p><em>Charge un fichier ini dans le tableau des paramètres de l'appli.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$fichier_ini</td> |
| <td><p>le nom du fichier à charger</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| array |
| — <p>le fichier ini parsé</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_get" name="method_get" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">get()</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;">get(string <span class="argument">$param</span>) : string</pre> |
| <p><em>Accesseur pour la valeur d'un paramètre.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$param</td> |
| <td><p>le nom du paramètre</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la valeur du paramètre</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_existe" name="method_existe" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">existe()</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;">existe(string <span class="argument">$param</span>) : boolean</pre> |
| <p><em>Vérifie si la valeur d'un paramètre existe.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$param</td> |
| <td><p>le nom du paramètre</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>vrai si le paramètre existe, false sinon</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_verifierPresenceParametres" name="method_verifierPresenceParametres" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">verifierPresenceParametres()</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;">verifierPresenceParametres(array <span class="argument">$parametres</span>) : boolean</pre> |
| <p><em>Vérifie que tous les paramêtres de config nécessaires au fonctionnement d'une classe existe dans les fichiers |
| de configurations.</em></p> |
| <p>L'utilisation de cette méthode depuis la classe Config évite de faire appel à une classe supplémentaire.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$parametres</td> |
| <td><p>tableau des noms des paramètres de la config à verifier.</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>true si tous les paramétres sont présents sinon false.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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___construct" name="method___construct" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">__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()</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_chargerFichierContexte" name="method_chargerFichierContexte" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">chargerFichierContexte()</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;">chargerFichierContexte(string <span class="argument">$contexte</span>)</pre> |
| <p><em>Charge le fichier de config correspondant au contexte</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$contexte</td> |
| <td><p>le contexte</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_parserFichierIni" name="method_parserFichierIni" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">parserFichierIni()</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;">parserFichierIni(string <span class="argument">$fichier_ini</span>) : array</pre> |
| <p><em>Parse le fichier ini donné en paramètre</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$fichier_ini</td> |
| <td><p>nom du fichier ini à parser</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| array |
| — <p>tableau contenant les paramètres du fichier ini</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_fusionner" name="method_fusionner" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">fusionner()</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;">fusionner(array <span class="argument">$ini</span>)</pre> |
| <p><em>Fusionne un tableau de paramètres avec le tableau de paramètres global</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$ini</td> |
| <td><p>le tableau à fusionner</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_getValeur" name="method_getValeur" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">getValeur()</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;">getValeur(string <span class="argument">$param</span>, array <span class="argument">$config</span>) : string</pre> |
| <p><em>Renvoie la valeur demandée grâce une chaîne de paramètres</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$param</td> |
| <td><p>la chaine de paramètres</p></td> |
| </tr> |
| <tr> |
| <td>array</td> |
| <td>$config</td> |
| <td><p>le tableau de paramètre</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la valeur de la chaine demandée</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_existeValeur" name="method_existeValeur" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">existeValeur()</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;">existeValeur(string <span class="argument">$param</span>, <span class="argument">$config</span>)</pre> |
| <p><em>Teste si param existe dans le tableau config</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$param</td> |
| <td><p>nom du paramètre</p></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$config</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_verifierCreationInstance" name="method_verifierCreationInstance" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">verifierCreationInstance()</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;">verifierCreationInstance()</pre> |
| <p><em>Vérifie si l'instance de classe à été crée, si non la crée</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_analyserTableauIni" name="method_analyserTableauIni" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">analyserTableauIni()</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;">analyserTableauIni(array <span class="argument">$config</span>) : array</pre> |
| <p><em>Analyse un tableau de paramètres.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$config</td> |
| <td><p>le tableau de paramètres</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| array |
| — <p>le tableau analysé</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_evaluerCle" name="method_evaluerCle" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">evaluerCle()</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;">evaluerCle(array <span class="argument">$config</span>, string <span class="argument">$cle</span>, string <span class="argument">$valeur</span>)</pre> |
| <p><em>Dans le cas des chaine de configuration à sous clé (ex.: cle.souscle) |
| évalue les valeurs correspondantes et crée les sous tableaux associés.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$config</td> |
| <td><p>tableau de configuration (par référence)</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$cle</td> |
| <td><p>la cle dans le tableau</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$valeur</td> |
| <td><p>la valeur à affecter</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_evaluerReferences" name="method_evaluerReferences" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">evaluerReferences()</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;">evaluerReferences(array <span class="argument">$config</span>, string <span class="argument">$cle</span>)</pre> |
| <p><em>Évalue les valeurs de références à une clé dans le tableau config (cas du ref:cle).</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$config</td> |
| <td><p>tableau de configuration</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$cle</td> |
| <td><p>la clé dont il faut évaluer les références</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_evaluerPhp" name="method_evaluerPhp" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">evaluerPhp()</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;">evaluerPhp(array <span class="argument">$config</span>, string <span class="argument">$cle</span>)</pre> |
| <p><em>Évalue le code php contenu dans un clé tu tableau config.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$config</td> |
| <td><p>tableau de configuration (par référence)</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$cle</td> |
| <td><p>le clé du tableau dont il faut évaluer la valeur</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Config.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Config.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/GestionnaireException.html |
|---|
| New file |
| 0,0 → 1,1251 |
| <!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-1383317307"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-1383317307" 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>GestionnaireException</h1> |
| <p><em>Classe de gestion des exceptions.</em></p> |
| <p>C'est un Singleton.</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/GestionnaireException.html#method_initialiser" class="">initialiser()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_configurer" class="">configurer()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_getExceptionsNbre" class="">getExceptionsNbre()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_getContexte" class="">getContexte()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_setContexte" class="">setContexte()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_gererException" class="">gererException()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_gererErreur" class="">gererErreur()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_getExceptions" class="deprecated">getExceptions()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_getExceptionsFormatees" class="">getExceptionsFormatees()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_getExceptionsTriees" class="">getExceptionsTriees()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_formaterExceptionDebug" class="">formaterExceptionDebug()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_formaterExceptionTxt" class="">formaterExceptionTxt()</a><br /> |
| <a href="../classes/GestionnaireException.html#method_formaterExceptionXhtml" class="">formaterExceptionXhtml()</a><br /> |
| <a href="../classes/GestionnaireException.html#method___destruct" class="">__destruct()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No public properties found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/GestionnaireException.html#constant_MODE_CLI" class="">MODE_CLI</a><br /> |
| </section> |
| </section> |
| <section class="row-fluid protected"> |
| <section class="span4"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/GestionnaireException.html#method_loggerException" class="">loggerException()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/GestionnaireException.html#property_exceptions" class="">$exceptions</a><br /> |
| <a href="../classes/GestionnaireException.html#property_contexte" class="">$contexte</a><br /> |
| <a href="../classes/GestionnaireException.html#property_logger" class="">$logger</a><br /> |
| <a href="../classes/GestionnaireException.html#property_afficher" class="">$afficher</a><br /> |
| <a href="../classes/GestionnaireException.html#property_mode" class="">$mode</a><br /> |
| <a href="../classes/GestionnaireException.html#property_parametres_obligatoires" class="">$parametres_obligatoires</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/GestionnaireException.php.html"><div class="path-wrapper">GestionnaireException.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\GestionnaireException</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Aurélien PERONNET <a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a></p> |
| <p>Jean-Pascal MILCENT <a href="mailto:jmp@tela-botanica.org">jmp@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: GestionnaireException.php 367 2011-10-03 12:40:48Z jpm $$</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <a id="constants" name="constants"></a> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <h2>Constants</h2> |
| </div> |
| <aside class="span4 detailsbar"></aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="constant_MODE_CLI" name="constant_MODE_CLI" class="anchor"></a> |
| <article id="constant_MODE_CLI" class="constant"> |
| <h3 class="">MODE_CLI</h3> |
| <pre class="signature">MODE_CLI</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="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_exceptions" name="property_exceptions" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$exceptions</h3> |
| <pre class="signature">$exceptions</pre> |
| <p><em>Liste des exceptions enregistrées</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="property_contexte" name="property_contexte" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$contexte</h3> |
| <pre class="signature">$contexte</pre> |
| <p><em>Détermine si l'on affiche ou non le contexte</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="property_logger" name="property_logger" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$logger</h3> |
| <pre class="signature">$logger</pre> |
| <p><em>Détermine si l'on loggue ou non les erreurs</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="property_afficher" name="property_afficher" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$afficher</h3> |
| <pre class="signature">$afficher</pre> |
| <p><em>Détermine si l'affichage des erreurs est forcé (true) ou pas (false) à la destruction de la classe</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="property_mode" name="property_mode" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$mode</h3> |
| <pre class="signature">$mode</pre> |
| <p><em>Definit si php est lancé en ligne de commande ou en mode serveur</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="property_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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_initialiser" name="method_initialiser" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">initialiser()</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;">initialiser()</pre> |
| <p><em>Initialise le Gestionnaire d'exceptions et d'erreur sans tenir comptes des paramêtres de config.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_configurer" name="method_configurer" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">configurer()</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;">configurer()</pre> |
| <p><em>Configure le Gestionnaire d'exceptions et d'erreur à partir des paramêtres de config.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_getExceptionsNbre" name="method_getExceptionsNbre" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getExceptionsNbre()</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;">getExceptionsNbre() : int</pre> |
| <p><em>Renvoie le nombre d'exceptions et d'erreurs levées.</em></p> |
| <h4>Returns</h4> |
| int |
| — <p>le nombre d'exception actuellement levées</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper">pour obtenir les exceptions formatées.</span></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| 0.3 |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_getContexte" name="method_getContexte" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getContexte()</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;">getContexte() : bool</pre> |
| <p><em>Renvoie le booleen définissant si l'on affiche le contexte ou non</em></p> |
| <h4>Returns</h4> |
| bool |
| — <p>true si on affiche le contexte sinon false.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_setContexte" name="method_setContexte" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">setContexte()</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;">setContexte( <span class="argument">$contexte</span>)</pre> |
| <p><em>Definit si l'on veut afficher le contexte ou non</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$contexte</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_gererException" name="method_gererException" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">gererException()</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;">gererException(\Exception <span class="argument">$e</span>)</pre> |
| <p><em>Fonction de gestion des exceptions, remplace le handler par défaut.</em></p> |
| <p>Si une boucle génère de multiple exception (ou erreur) identique une seule sera stockée.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>\Exception</td> |
| <td>$e</td> |
| <td><p>l'exception à traiter</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_gererErreur" name="method_gererErreur" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">gererErreur()</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;">gererErreur(int <span class="argument">$niveau</span>, string <span class="argument">$message</span>, string <span class="argument">$fichier</span>, int <span class="argument">$ligne</span>, string <span class="argument">$contexte</span>)</pre> |
| <p><em>Gère les erreurs en les convertissant en exceptions (remplace la fonction gestion d'erreurs native de php)</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>int</td> |
| <td>$niveau</td> |
| <td><p>le niveau de l'erreur</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$message</td> |
| <td><p>le message associé à l'erreur</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$fichier</td> |
| <td><p>le nom du fichier où l'erreur s'est produite</p></td> |
| </tr> |
| <tr> |
| <td>int</td> |
| <td>$ligne</td> |
| <td><p>la ligne où l'erreur s'est produite</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$contexte</td> |
| <td><p>le contexte associé à l'erreur</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_getExceptions" name="method_getExceptions" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public deprecated">getExceptions()</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;">getExceptions() : string</pre> |
| <p><em>Renvoie les exceptions au format (X)HTML ou bien au format texte suivant le mode d'utilisation de PHP.</em></p> |
| <h4>Returns</h4> |
| string |
| — <p>les exceptions formatées en texte ou (X)HTML.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <aside class="alert alert-block alert-error"> |
| <h4>Deprecated</h4> |
| </aside> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| 0.3 |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_getExceptionsFormatees" name="method_getExceptionsFormatees" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getExceptionsFormatees()</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;">getExceptionsFormatees() : string</pre> |
| <p><em>Renvoie les exceptions au format (X)HTML ou bien au format texte suivant le mode d'utilisation de PHP.</em></p> |
| <h4>Returns</h4> |
| string |
| — <p>les exceptions formatées en texte ou (X)HTML.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| 0.3 |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_getExceptionsTriees" name="method_getExceptionsTriees" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getExceptionsTriees()</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;">getExceptionsTriees() : array</pre> |
| <p><em>Renvoie le tableau d'objets Exception générées par le script PHP triées du niveau de sévérité le plus élevé au moins élevé.</em></p> |
| <p>Format du tableau : |
| array{sévérité_1 = array{Exception1, Exception2, Exception3,...}, sévérité_1 = array{Exception1, Exception2, ...}, ...}; |
| ATTENTION : si vous utilisez cette méthode, c'est à vous de gérer l'affichage des Exceptions. Le gestionnaire d'exception |
| n'enverra plus rien au navigateur ou à la console.</p> |
| <h4>Returns</h4> |
| array |
| — <p>le tableau trié d'objet Exception.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| 0.3 |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_formaterExceptionDebug" name="method_formaterExceptionDebug" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">formaterExceptionDebug()</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;">formaterExceptionDebug(\Exception <span class="argument">$e</span>)</pre> |
| <p><em>Formate en texte une exception passée en paramètre.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>\Exception</td> |
| <td>$e</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| 0.3 |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_formaterExceptionTxt" name="method_formaterExceptionTxt" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">formaterExceptionTxt()</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;">formaterExceptionTxt(\Exception <span class="argument">$e</span>)</pre> |
| <p><em>Formate en texte une exception passée en paramètre.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>\Exception</td> |
| <td>$e</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| 0.3 |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_formaterExceptionXhtml" name="method_formaterExceptionXhtml" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">formaterExceptionXhtml()</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;">formaterExceptionXhtml(\Exception <span class="argument">$e</span>)</pre> |
| <p><em>Formate en (X)HTML une exception passée en paramètre.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>\Exception</td> |
| <td>$e</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| 0.3 |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method___destruct" name="method___destruct" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">__destruct()</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;">__destruct()</pre> |
| <p><em>Lors de la destruction de la classe si des exceptions n'ont pas été affichées, et si le débogage est à true, elles sont |
| affichées.</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_loggerException" name="method_loggerException" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">loggerException()</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;">loggerException(\Exception <span class="argument">$e</span>)</pre> |
| <p><em>Logue une exception donnée sous une forme lisible si self::logger vaut true.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>\Exception</td> |
| <td>$e</td> |
| <td><p>l'exception à logger</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">GestionnaireException.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/GestionnaireException.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Cli.html |
|---|
| New file |
| 0,0 → 1,589 |
| <!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-63671814"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-63671814" 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>Cli</h1> |
| <p><em>CLI permet de récupérer les paramètres passés en ligne de commande pour instancier une classe héritant de la classe abstraite |
| Script.</em></p> |
| <p>Elle va déclencher l'éxecution du script via l'appel de la méthode executer(). |
| C'est une Singleton.</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/Cli.html#method_executer" class="">executer()</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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/Cli.html#method_charger" class="">charger()</a><br /> |
| <a href="../classes/Cli.html#method_obtenirNomClasse" class="">obtenirNomClasse()</a><br /> |
| <a href="../classes/Cli.html#method_getParametres" class="">getParametres()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Cli.html#property_parametres_obligatoires" class="">$parametres_obligatoires</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/Cli.php.html"><div class="path-wrapper">Cli.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Cli</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| <p>Delphine CAUQUIL <a href="mailto:delphine@tela-botanica.org">delphine@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Cli.php 386 2011-10-28 15:56:25Z jpm $</p> |
| </td> |
| </tr> |
| <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_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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_executer" name="method_executer" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">executer()</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;">executer() : void</pre> |
| <p><em>Execute la ligne de commande en récupérant le nom du script à lancer et ses paramètres.</em></p> |
| <p>Instancie la classe du script à lancer et appelle la méthode executer().</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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="private ">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( <span class="argument">$script_nom</span>, <span class="argument">$parametres</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$script_nom</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$parametres</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_obtenirNomClasse" name="method_obtenirNomClasse" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">obtenirNomClasse()</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;">obtenirNomClasse( <span class="argument">$script_nom</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$script_nom</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_getParametres" name="method_getParametres" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">getParametres()</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;">getParametres( <span class="argument">$argv</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$argv</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Cli.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Cli.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Fichier.html |
|---|
| New file |
| 0,0 → 1,646 |
| <!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-2042763931"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-2042763931" 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>Fichier</h1> |
| <p><em>Classe fournissant des méthodes statiques de manipulation des fichiers.</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/Fichier.html#method_creerFichier" class="">creerFichier()</a><br /> |
| <a href="../classes/Fichier.html#method_creerFichierGzip" class="">creerFichierGzip()</a><br /> |
| <a href="../classes/Fichier.html#method_supprimerDossier" class="">supprimerDossier()</a><br /> |
| <a href="../classes/Fichier.html#method_convertirTaille" class="">convertirTaille()</a><br /> |
| <a href="../classes/Fichier.html#method_getDossierTmp" class="">getDossierTmp()</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/Fichier.html#method_etreAccessibleEnLectureEtEcriture" class="">etreAccessibleEnLectureEtEcriture()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <em>No private methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No private properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| </section> |
| </div> |
| <aside class="span4 detailsbar"> |
| <dl> |
| <dt>File</dt> |
| <dd><a href="../files/utilitaires.Fichier.php.html"><div class="path-wrapper">utilitaires/Fichier.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Utilitaire</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Fichier</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Fichier.php 351 2011-07-21 10:22:34Z jpm $</p> |
| </td> |
| </tr> |
| <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_creerFichier" name="method_creerFichier" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">creerFichier()</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;">creerFichier( <span class="argument">$fichier</span>, <span class="argument">$contenu</span>) : string</pre> |
| <p><em>Créer et stocke du contenu dans un fichier.</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>$contenu</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>true en cas de succès sinon false.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_creerFichierGzip" name="method_creerFichierGzip" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">creerFichierGzip()</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;">creerFichierGzip( <span class="argument">$fichier</span>, <span class="argument">$contenu</span>) : string</pre> |
| <p><em>Créer et stocke du contenu dans un fichier compressé en Gzip.</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>$contenu</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>true en cas de succès sinon false.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_supprimerDossier" name="method_supprimerDossier" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">supprimerDossier()</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;">supprimerDossier(string <span class="argument">$dossier</span>) : void</pre> |
| <p><em>Supprime récursivement un dossier et tout son contenu.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$dossier</td> |
| <td><p>le chemin vers le dossier à supprimer.</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_convertirTaille" name="method_convertirTaille" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">convertirTaille()</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;">convertirTaille(integer <span class="argument">$taille</span>) : string</pre> |
| <p><em>Convertion d'un nombre d'octet en kB, MB, GB.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>integer</td> |
| <td>$taille</td> |
| <td><p>la taille en octet à convertir</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la chaine représentant la taille en octets.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href="http://forum.webmaster-rank.info/developpement-site/code-taille-memoire-d-une-variable-en-php-t1344.html"><span class="namespace-wrapper">http://forum.webmaster-rank.info/developpement-site/code-taille-memoire-d-une-variable-en-php-t1344.html</span></a></dd> |
| </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_getDossierTmp" name="method_getDossierTmp" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getDossierTmp()</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;">getDossierTmp() : string|false</pre> |
| <p><em>Détermine le dossier système temporaire et détecte si nous y avons accès en lecture et écriture.</em></p> |
| <p>Inspiré de Zend_File_Transfer_Adapter_Abstract & Zend_Cache</p> |
| <h4>Returns</h4> |
| string|false |
| — <p>le chemine vers le dossier temporaire ou false en cas d'échec.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_etreAccessibleEnLectureEtEcriture" name="method_etreAccessibleEnLectureEtEcriture" class="anchor"></a> |
| <article class="method"> |
| <h3 class="protected ">etreAccessibleEnLectureEtEcriture()</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;">etreAccessibleEnLectureEtEcriture(mixed <span class="argument">$ressource</span>) : boolean</pre> |
| <p><em>Vérifie si le fichier ou dossier est accessible en lecture et écriture.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>mixed</td> |
| <td>$ressource</td> |
| <td><p>chemin vers le dossier ou fichier à tester</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>true si la ressource est accessible en lecture et écriture.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Fichier.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/utilitaires/Fichier.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/RestClient.html |
|---|
| New file |
| 0,0 → 1,1141 |
| <!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-12626325"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-12626325" 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>RestClient</h1> |
| <p><em>Classe client permettant d'interroger des services web REST.</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/RestClient.html#method_getReponseEntetes" class="">getReponseEntetes()</a><br /> |
| <a href="../classes/RestClient.html#method_getParametre" class="">getParametre()</a><br /> |
| <a href="../classes/RestClient.html#method_ajouterParametre" class="">ajouterParametre()</a><br /> |
| <a href="../classes/RestClient.html#method_supprimerParametre" class="">supprimerParametre()</a><br /> |
| <a href="../classes/RestClient.html#method_nettoyerParametres" class="">nettoyerParametres()</a><br /> |
| <a href="../classes/RestClient.html#method_consulter" class="">consulter()</a><br /> |
| <a href="../classes/RestClient.html#method_ajouter" class="">ajouter()</a><br /> |
| <a href="../classes/RestClient.html#method_modifier" class="">modifier()</a><br /> |
| <a href="../classes/RestClient.html#method_supprimer" class="">supprimer()</a><br /> |
| <a href="../classes/RestClient.html#method_envoyerRequete" class="">envoyerRequete()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No public properties found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/RestClient.html#constant_HTTP_URL_REQUETE_SEPARATEUR" class="">HTTP_URL_REQUETE_SEPARATEUR</a><br /> |
| <a href="../classes/RestClient.html#constant_HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR" class="">HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR</a><br /> |
| </section> |
| </section> |
| <section class="row-fluid protected"> |
| <section class="span4"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/RestClient.html#property_parametres" class="">$parametres</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/RestClient.html#method_traiterUrlParametres" class="">traiterUrlParametres()</a><br /> |
| <a href="../classes/RestClient.html#method_traiterEntete" class="">traiterEntete()</a><br /> |
| <a href="../classes/RestClient.html#method_analyserEntete" class="">analyserEntete()</a><br /> |
| <a href="../classes/RestClient.html#method_traiterEnteteDebogage" class="">traiterEnteteDebogage()</a><br /> |
| <a href="../classes/RestClient.html#method_reinitialiser" class="">reinitialiser()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/RestClient.html#property_http_methodes" class="">$http_methodes</a><br /> |
| <a href="../classes/RestClient.html#property_url" class="">$url</a><br /> |
| <a href="../classes/RestClient.html#property_reponse_entetes" class="">$reponse_entetes</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/RestClient.php.html"><div class="path-wrapper">RestClient.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\RestClient</div> |
| </dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>php 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: RestClient.php 353 2011-08-01 16:02:32Z jpm $</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <a id="constants" name="constants"></a> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <h2>Constants</h2> |
| </div> |
| <aside class="span4 detailsbar"></aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="constant_HTTP_URL_REQUETE_SEPARATEUR" name="constant_HTTP_URL_REQUETE_SEPARATEUR" class="anchor"></a> |
| <article id="constant_HTTP_URL_REQUETE_SEPARATEUR" class="constant"> |
| <h3 class="">HTTP_URL_REQUETE_SEPARATEUR</h3> |
| <pre class="signature">HTTP_URL_REQUETE_SEPARATEUR</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="constant_HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR" name="constant_HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR" class="anchor"></a> |
| <article id="constant_HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR" class="constant"> |
| <h3 class="">HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR</h3> |
| <pre class="signature">HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR</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="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_parametres" name="property_parametres" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$parametres</h3> |
| <pre class="signature">$parametres</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="property_http_methodes" name="property_http_methodes" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$http_methodes</h3> |
| <pre class="signature">$http_methodes</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="property_url" name="property_url" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$url</h3> |
| <pre class="signature">$url</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="property_reponse_entetes" name="property_reponse_entetes" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$reponse_entetes</h3> |
| <pre class="signature">$reponse_entetes</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_getReponseEntetes" name="method_getReponseEntetes" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getReponseEntetes()</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;">getReponseEntetes()</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_getParametre" name="method_getParametre" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getParametre()</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;">getParametre( <span class="argument">$cle</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$cle</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_ajouterParametre" name="method_ajouterParametre" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">ajouterParametre()</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;">ajouterParametre( <span class="argument">$cle</span>, <span class="argument">$valeur</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$cle</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$valeur</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_supprimerParametre" name="method_supprimerParametre" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">supprimerParametre()</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;">supprimerParametre( <span class="argument">$cle</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$cle</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_nettoyerParametres" name="method_nettoyerParametres" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">nettoyerParametres()</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;">nettoyerParametres()</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_consulter" name="method_consulter" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">consulter()</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;">consulter( <span class="argument">$url</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$url</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_ajouter" name="method_ajouter" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">ajouter()</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;">ajouter( <span class="argument">$url</span>, array <span class="argument">$donnees</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$url</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>array</td> |
| <td>$donnees</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_modifier" name="method_modifier" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">modifier()</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;">modifier( <span class="argument">$url</span>, array <span class="argument">$donnees</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$url</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>array</td> |
| <td>$donnees</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_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( <span class="argument">$url</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$url</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_envoyerRequete" name="method_envoyerRequete" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">envoyerRequete()</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;">envoyerRequete( <span class="argument">$url</span>, <span class="argument">$mode</span>, array <span class="argument">$donnees</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$url</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$mode</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>array</td> |
| <td>$donnees</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_traiterUrlParametres" name="method_traiterUrlParametres" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">traiterUrlParametres()</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;">traiterUrlParametres()</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_traiterEntete" name="method_traiterEntete" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">traiterEntete()</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;">traiterEntete()</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_analyserEntete" name="method_analyserEntete" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">analyserEntete()</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;">analyserEntete()</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_traiterEnteteDebogage" name="method_traiterEnteteDebogage" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">traiterEnteteDebogage()</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;">traiterEnteteDebogage( <span class="argument">$entetes_analyses</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$entetes_analyses</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_reinitialiser" name="method_reinitialiser" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">reinitialiser()</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;">reinitialiser()</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> |
| </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">RestClient.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/RestClient.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Tableau.html |
|---|
| New file |
| 0,0 → 1,542 |
| <!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-818241723"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-818241723" 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>Tableau</h1> |
| <p><em>Classe fournissant des méthodes statiques de manipulation des tableaux (Array).</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/Tableau.html#method_etendre" class="">etendre()</a><br /> |
| <a href="../classes/Tableau.html#method_trierTableauMd" class="deprecated">trierTableauMd()</a><br /> |
| <a href="../classes/Tableau.html#method_trierMD" class="">trierMD()</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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <em>No private methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No private properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| </section> |
| </div> |
| <aside class="span4 detailsbar"> |
| <dl> |
| <dt>File</dt> |
| <dd><a href="../files/utilitaires.Tableau.php.html"><div class="path-wrapper">utilitaires/Tableau.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Utilitaire</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Tableau</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Tableau.php 400 2011-11-25 16:26:26Z jpm $</p> |
| </td> |
| </tr> |
| <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_etendre" name="method_etendre" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">etendre()</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;">etendre(array <span class="argument">$tableau_a_etendre</span>, array <span class="argument">$tableau_a_copier</span>) : void</pre> |
| <p><em>Etend le tableau à étendre avec les données du tableau à copier. Si des clés sont identiques entre les deux tableaux |
| une erreur est déclenchée et la valeur du tableau à étendre est gardée. Si les deux tableaux ont des clés numériques |
| leurs valeurs sont gardées (à la différence de array_merge).</em></p> |
| <p>Les tableaux sont passés par références et le tableau à copier est progressivement détruit pour éviter la consomation |
| de mémoire.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$tableau_a_etendre</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>array</td> |
| <td>$tableau_a_copier</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_trierTableauMd" name="method_trierTableauMd" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public deprecated">trierTableauMd()</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;">trierTableauMd( <span class="argument">$array</span>, <span class="argument">$cols</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$array</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$cols</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <aside class="alert alert-block alert-error"> |
| <h4>Deprecated</h4> |
| Utiliser la méthode trierMD() |
| </aside> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper"></span></a></dd> |
| </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_trierMD" name="method_trierMD" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">trierMD()</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;">trierMD(Array <span class="argument">$array</span>, Array <span class="argument">$cols</span>) : Array</pre> |
| <p><em>Permet de trier un tableau multi-dimenssionnel en gardant l'ordre des clés.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>Array</td> |
| <td>$array</td> |
| <td><p>le tableau à trier</p></td> |
| </tr> |
| <tr> |
| <td>Array</td> |
| <td>$cols</td> |
| <td><p>tableau indiquant en clé la colonne à trier et en valeur l'ordre avec SORT_ASC ou SORT_DESC</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| Array |
| — <p>le tableau trié.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href=""><span class="namespace-wrapper">Post du 21-Jun-2009 12:38</span></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>cagret at gmail dot com</p> |
| </td> |
| </tr> |
| <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">Tableau.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/utilitaires/Tableau.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Pattern.html |
|---|
| New file |
| 0,0 → 1,580 |
| <!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-1559720898"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-1559720898" 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>Pattern</h1> |
| <p><em>Classe fournissant des constantes correspondant à des expressions régulières de vérification très courrantes.</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"> |
| <em>No public methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No public properties found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Pattern.html#constant_PRENOM" class="">PRENOM</a><br /> |
| <a href="../classes/Pattern.html#constant_NOM" class="">NOM</a><br /> |
| <a href="../classes/Pattern.html#constant_COURRIEL" class="">COURRIEL</a><br /> |
| <a href="../classes/Pattern.html#constant_URL" class="">URL</a><br /> |
| <a href="../classes/Pattern.html#constant_HEURE_MINUTE" class="">HEURE_MINUTE</a><br /> |
| <a href="../classes/Pattern.html#constant_LATITUDE" class="">LATITUDE</a><br /> |
| <a href="../classes/Pattern.html#constant_LONGITUDE" class="">LONGITUDE</a><br /> |
| </section> |
| </section> |
| <section class="row-fluid protected"> |
| <section class="span4"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <em>No private methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No private properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| </section> |
| </div> |
| <aside class="span4 detailsbar"> |
| <dl> |
| <dt>File</dt> |
| <dd><a href="../files/utilitaires.Pattern.php.html"><div class="path-wrapper">utilitaires/Pattern.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Utilitaire</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Pattern</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Pattern.php 299 2011-01-18 14:03:46Z jpm $</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <a id="constants" name="constants"></a> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <h2>Constants</h2> |
| </div> |
| <aside class="span4 detailsbar"></aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="constant_PRENOM" name="constant_PRENOM" class="anchor"></a> |
| <article id="constant_PRENOM" class="constant"> |
| <h3 class="">PRENOM</h3> |
| <pre class="signature">PRENOM</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="constant_NOM" name="constant_NOM" class="anchor"></a> |
| <article id="constant_NOM" class="constant"> |
| <h3 class="">NOM</h3> |
| <pre class="signature">NOM</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="constant_COURRIEL" name="constant_COURRIEL" class="anchor"></a> |
| <article id="constant_COURRIEL" class="constant"> |
| <h3 class="">COURRIEL</h3> |
| <pre class="signature">COURRIEL</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="constant_URL" name="constant_URL" class="anchor"></a> |
| <article id="constant_URL" class="constant"> |
| <h3 class="">URL</h3> |
| <pre class="signature">URL</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="constant_HEURE_MINUTE" name="constant_HEURE_MINUTE" class="anchor"></a> |
| <article id="constant_HEURE_MINUTE" class="constant"> |
| <h3 class="">HEURE_MINUTE</h3> |
| <pre class="signature">HEURE_MINUTE</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="constant_LATITUDE" name="constant_LATITUDE" class="anchor"></a> |
| <article id="constant_LATITUDE" class="constant"> |
| <h3 class="">LATITUDE</h3> |
| <pre class="signature">LATITUDE</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="constant_LONGITUDE" name="constant_LONGITUDE" class="anchor"></a> |
| <article id="constant_LONGITUDE" class="constant"> |
| <h3 class="">LONGITUDE</h3> |
| <pre class="signature">LONGITUDE</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> |
| </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">Pattern.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/utilitaires/Pattern.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/CacheSimple.html |
|---|
| New file |
| 0,0 → 1,673 |
| <!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-956893251"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-956893251" 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>CacheSimple</h1> |
| <p><em>Classe Cache permettant de mettre en cache des données de façon extremement simple.</em></p> |
| <p>Le cache est stocker dans des fichiers textes. |
| Le contrôle de la durée de vie du cache se fait avec la fonction PHP filemtime. |
| Si la durée de vie du cache est modifiée dans le constructeur ou le fichier de config, alors la durée de vie de l'ensemble |
| des fichiers de cache est modifiée en conséquence. |
| Les clés pour le tableau des options et les valeurs par défaut sont indiquées dans l'attribut options de la classe.</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/CacheSimple.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/CacheSimple.html#method_charger" class="">charger()</a><br /> |
| <a href="../classes/CacheSimple.html#method_sauver" class="">sauver()</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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/CacheSimple.html#method_initialiserOptionsParConfig" class="">initialiserOptionsParConfig()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/CacheSimple.html#property_mise_en_cache" class="">$mise_en_cache</a><br /> |
| <a href="../classes/CacheSimple.html#property_stockage_chemin" class="">$stockage_chemin</a><br /> |
| <a href="../classes/CacheSimple.html#property_duree_de_vie" class="">$duree_de_vie</a><br /> |
| <a href="../classes/CacheSimple.html#property_options" class="">$options</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/CacheSimple.php.html"><div class="path-wrapper">CacheSimple.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\CacheSimple</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>php 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| <p>Aurélien PERONNET <a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://framework.zend.com/license/new-bsd">http://framework.zend.com/license/new-bsd</a> Licence New BSD</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: CacheSimple.php 435 2013-09-04 14:29:43Z jpm $</p> |
| </td> |
| </tr> |
| <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_mise_en_cache" name="property_mise_en_cache" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$mise_en_cache</h3> |
| <pre class="signature">$mise_en_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> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="property_stockage_chemin" name="property_stockage_chemin" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$stockage_chemin</h3> |
| <pre class="signature">$stockage_chemin</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="property_duree_de_vie" name="property_duree_de_vie" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$duree_de_vie</h3> |
| <pre class="signature">$duree_de_vie</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="property_options" name="property_options" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$options</h3> |
| <pre class="signature">$options</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( <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 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>) : string|false</pre> |
| <p><em>Teste si le cache est disponible pour l'id donné et (si oui) le retourne (sinon renvoie false)</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$id</td> |
| <td><p>l'identifiant du Cache.</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string|false |
| — <p>les données 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(string <span class="argument">$contenu</span>, string <span class="argument">$id</span>) : boolean</pre> |
| <p><em>Sauvegarde la chaine de données dans un fichier texte.</em></p> |
| <p>Note : $contenu est toujours de type "string". C'est à vous de gérer la sérialisation.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$contenu</td> |
| <td><p>les données à mettre en cache.</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$id</td> |
| <td><p>l'identifiant du Cache.</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>true si aucun problème</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> |
| </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">CacheSimple.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/CacheSimple.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/I18n.html |
|---|
| New file |
| 0,0 → 1,1038 |
| <!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-1521194684"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-1521194684" 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>I18n</h1> |
| <p><em>I18n permet de traduire une application à partir de données stockées dans des fichiers ini.</em></p> |
| <p>Si vous souhaitez utiliser le fonctionnement par défaut vous devrez :</p> |
| <ul> |
| <li>déposer les fichiers ini dans le dossier définit par la variable de config "chemin_i18n".</li> |
| <li>nommer les fichiers selon la forme "locale.ini" (Ex.: fr.ini ou fr_CH.ini ).</li> |
| </ul> |
| <p>Elle offre l'accès en lecture seule aux paramètres des fichiers ini. |
| C'est une Singleton. Une seule classe de traduction peut être instanciée par Application.</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/I18n.html#method_get" class="">get()</a><br /> |
| <a href="../classes/I18n.html#method_charger" class="">charger()</a><br /> |
| <a href="../classes/I18n.html#method_setLangue" class="">setLangue()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No public properties found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/I18n.html#constant_FORMAT_INI" class="">FORMAT_INI</a><br /> |
| </section> |
| </section> |
| <section class="row-fluid protected"> |
| <section class="span4"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/I18n.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/I18n.html#method_getValeur" class="">getValeur()</a><br /> |
| <a href="../classes/I18n.html#method_chargerFichierIni" class="">chargerFichierIni()</a><br /> |
| <a href="../classes/I18n.html#method_analyserTableauIni" class="">analyserTableauIni()</a><br /> |
| <a href="../classes/I18n.html#method_evaluerCle" class="">evaluerCle()</a><br /> |
| <a href="../classes/I18n.html#method_trouverLangue" class="">trouverLangue()</a><br /> |
| <a href="../classes/I18n.html#method_verifierCreationInstance" class="">verifierCreationInstance()</a><br /> |
| <a href="../classes/I18n.html#method_ajouterErreur" class="">ajouterErreur()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/I18n.html#property_instance" class="">$instance</a><br /> |
| <a href="../classes/I18n.html#property_traductions" class="">$traductions</a><br /> |
| <a href="../classes/I18n.html#property_langue" class="">$langue</a><br /> |
| <a href="../classes/I18n.html#property_parametres_obligatoires" class="">$parametres_obligatoires</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/I18n.php.html"><div class="path-wrapper">I18n.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\I18n</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: I18n.php 330 2011-02-24 18:03:07Z jpm $</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <a id="constants" name="constants"></a> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <h2>Constants</h2> |
| </div> |
| <aside class="span4 detailsbar"></aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="constant_FORMAT_INI" name="constant_FORMAT_INI" class="anchor"></a> |
| <article id="constant_FORMAT_INI" class="constant"> |
| <h3 class="">FORMAT_INI</h3> |
| <pre class="signature">FORMAT_INI</pre> |
| <p><em>Format de traduction utilisant les fichier .ini</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="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_instance" name="property_instance" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$instance</h3> |
| <pre class="signature">$instance</pre> |
| <p><em>Instance de la classe pointant sur elle même (pour le pattern singleton)</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="property_traductions" name="property_traductions" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$traductions</h3> |
| <pre class="signature">$traductions</pre> |
| <p><em>Fichiers de traduction disponibles.</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="property_langue" name="property_langue" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$langue</h3> |
| <pre class="signature">$langue</pre> |
| <p><em>Langue courrante utilisée par l'application.</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="property_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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_get" name="method_get" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">get()</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;">get( <span class="argument">$identifiant</span>, <span class="argument">$langue</span>) : string</pre> |
| <p><em>Accesseur pour la valeur d'une traduction</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$identifiant</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$langue</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la valeur du paramètre</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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( <span class="argument">$langue</span>, <span class="argument">$fichier</span>, <span class="argument">$format</span>) : boolean</pre> |
| <p><em>Charge un fichier ini dans le tableau des paramètres de l'appli</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$langue</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$fichier</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$format</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>true, si le fichier a été trouvé et correctement chargé, sinon false.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_setLangue" name="method_setLangue" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">setLangue()</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;">setLangue( <span class="argument">$langue</span>) : array</pre> |
| <p><em>Définit la langue utiliser pour rechercher une traduction.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$langue</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| array |
| — <p>le fichier ini parsé</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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___construct" name="method___construct" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">__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()</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_getValeur" name="method_getValeur" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">getValeur()</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;">getValeur(string <span class="argument">$param</span>, array <span class="argument">$i18n</span>) : mixed</pre> |
| <p><em>Renvoie la valeur demandé grâce une chaine de paramètres</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$param</td> |
| <td><p>la chaine identifiante</p></td> |
| </tr> |
| <tr> |
| <td>array</td> |
| <td>$i18n</td> |
| <td><p>le tableau de traductions</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| — <p>la valeur correspondante à la chaine identifiante si elle est trouvée, sinon false.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_chargerFichierIni" name="method_chargerFichierIni" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">chargerFichierIni()</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;">chargerFichierIni(string <span class="argument">$fichier_ini</span>, string <span class="argument">$langue</span>) : boolean</pre> |
| <p><em>Parse le fichier ini donné en paramètre</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$fichier_ini</td> |
| <td><p>nom du fichier ini à parser</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$langue</td> |
| <td><p>la langue correspondant au fichier</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>true si le chargement c'est bien passé, sinon false.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_analyserTableauIni" name="method_analyserTableauIni" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">analyserTableauIni()</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;">analyserTableauIni(array <span class="argument">$i18n</span>) : array</pre> |
| <p><em>Analyse un tableau de traductions pour évaluer les clés.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$i18n</td> |
| <td><p>le tableau de traductions</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| array |
| — <p>le tableau analysé et modifié si nécessaire.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_evaluerCle" name="method_evaluerCle" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">evaluerCle()</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;">evaluerCle(array <span class="argument">$i18n</span>, string <span class="argument">$cle</span>, string <span class="argument">$valeur</span>)</pre> |
| <p><em>Dans le cas des chaines de traduction à sous clé (ex.: cle.souscle), cette méthode |
| évalue les valeurs correspondantes et créée les sous tableaux associés.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>array</td> |
| <td>$i18n</td> |
| <td><p>tableau de traductions (par référence)</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$cle</td> |
| <td><p>la cle dans le tableau</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$valeur</td> |
| <td><p>la valeur à affecter</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_trouverLangue" name="method_trouverLangue" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">trouverLangue()</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;">trouverLangue()</pre> |
| <p><em>Cherche l'information sur la langue demandée par l'application</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_verifierCreationInstance" name="method_verifierCreationInstance" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">verifierCreationInstance()</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;">verifierCreationInstance()</pre> |
| <p><em>Vérifie si l'instance de classe à été crée, si non la crée</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_ajouterErreur" name="method_ajouterErreur" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">ajouterErreur()</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;">ajouterErreur( <span class="argument">$m</span>, <span class="argument">$e</span>)</pre> |
| <p><em>Ajouter une message d'erreur</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$m</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$e</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">I18n.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/I18n.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Log.html |
|---|
| New file |
| 0,0 → 1,972 |
| <!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-1711036386"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-1711036386" 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>Log</h1> |
| <p><em>Classe permettant de logger des messages dans les fichier situés dans le dossier de log.</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/Log.html#method_initialiser" class="">initialiser()</a><br /> |
| <a href="../classes/Log.html#method_configurer" class="">configurer()</a><br /> |
| <a href="../classes/Log.html#method_ajouterEntree" class="">ajouterEntree()</a><br /> |
| <a href="../classes/Log.html#method_viderLog" class="">viderLog()</a><br /> |
| <a href="../classes/Log.html#method_verifierOuvrirFichier" class="">verifierOuvrirFichier()</a><br /> |
| <a href="../classes/Log.html#method___destruct" class="">__destruct()</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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/Log.html#method_verifierTailleFichierOuArchiver" class="">verifierTailleFichierOuArchiver()</a><br /> |
| <a href="../classes/Log.html#method_desactiverEcriture" class="">desactiverEcriture()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Log.html#property_logger" class="">$logger</a><br /> |
| <a href="../classes/Log.html#property_fichiersLog" class="">$fichiersLog</a><br /> |
| <a href="../classes/Log.html#property_cheminLogs" class="">$cheminLogs</a><br /> |
| <a href="../classes/Log.html#property_droitLogger" class="">$droitLogger</a><br /> |
| <a href="../classes/Log.html#property_timeZone" class="">$timeZone</a><br /> |
| <a href="../classes/Log.html#property_tailleMax" class="">$tailleMax</a><br /> |
| <a href="../classes/Log.html#property_sd" class="">$sd</a><br /> |
| <a href="../classes/Log.html#property_ext" class="">$ext</a><br /> |
| <a href="../classes/Log.html#property_parametres_obligatoires" class="">$parametres_obligatoires</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/Log.php.html"><div class="path-wrapper">Log.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Log</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Aurélien PERONNET <a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a></p> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Log.php 274 2010-12-28 15:37:22Z jpm $</p> |
| </td> |
| </tr> |
| <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_logger" name="property_logger" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$logger</h3> |
| <pre class="signature">$logger</pre> |
| <p><em>Boolean indiquant si l'on doit utiliser les logs ou pas.</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="property_fichiersLog" name="property_fichiersLog" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$fichiersLog</h3> |
| <pre class="signature">$fichiersLog</pre> |
| <p><em>Tableau associatif stockant les descripteurs de fichiers.</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="property_cheminLogs" name="property_cheminLogs" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$cheminLogs</h3> |
| <pre class="signature">$cheminLogs</pre> |
| <p><em>Chemin de base du dossier log de l'application.</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="property_droitLogger" name="property_droitLogger" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$droitLogger</h3> |
| <pre class="signature">$droitLogger</pre> |
| <p><em>Booleen indiquant si l'on peut correctement écrire dans les fichiers de logs.</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="property_timeZone" name="property_timeZone" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$timeZone</h3> |
| <pre class="signature">$timeZone</pre> |
| <p><em>Zone horaire (pour éviter des avertissements dans les dates).</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="property_tailleMax" name="property_tailleMax" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$tailleMax</h3> |
| <pre class="signature">$tailleMax</pre> |
| <p><em>Taille maximum d'un fichier de log avant que celui ne soit archivé (en octets).</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="property_sd" name="property_sd" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$sd</h3> |
| <pre class="signature">$sd</pre> |
| <p><em>séparateur de dossier dans un chemin.</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="property_ext" name="property_ext" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$ext</h3> |
| <pre class="signature">$ext</pre> |
| <p><em>Extension des fichiers de log.</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="property_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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_initialiser" name="method_initialiser" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">initialiser()</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;">initialiser()</pre> |
| <p><em>Initialiser les logs par défaut, sans tenir comptes des paramêtres de config.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_configurer" name="method_configurer" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">configurer()</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;">configurer()</pre> |
| <p><em>Configure le Log à partir des paramêtres de config.</em></p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_ajouterEntree" name="method_ajouterEntree" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">ajouterEntree()</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;">ajouterEntree(string <span class="argument">$nomFichier</span>, <span class="argument">$entree</span>, <span class="argument">$mode</span>)</pre> |
| <p><em>Ajoute une entrée au log spécifié par le paramètre $nomFichier</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$nomFichier</td> |
| <td><p>le nom du fichier dans lequel écrire</p></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$entree</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$mode</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_viderLog" name="method_viderLog" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">viderLog()</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;">viderLog(string <span class="argument">$nomFichier</span>)</pre> |
| <p><em>Vide un fichier log indiqué</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$nomFichier</td> |
| <td><p>le nom du fichier à vider</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_verifierOuvrirFichier" name="method_verifierOuvrirFichier" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">verifierOuvrirFichier()</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;">verifierOuvrirFichier(string <span class="argument">$nomFichier</span>, <span class="argument">$mode</span>) : boolean</pre> |
| <p><em>Vérifie la présence d'un fichier dans le tableau, ses droits d'écriture, l'ouvre si nécessaire.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$nomFichier</td> |
| <td><p>le nom du fichier dont on doit vérifier la présence</p></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$mode</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>true si le fichier est ouvert ou maintenant accessible, false sinon</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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___destruct" name="method___destruct" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">__destruct()</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;">__destruct()</pre> |
| <p><em>Destructeur de classe, ferme les descripteurs ouverts.</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_verifierTailleFichierOuArchiver" name="method_verifierTailleFichierOuArchiver" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">verifierTailleFichierOuArchiver()</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;">verifierTailleFichierOuArchiver(string <span class="argument">$nomFichier</span>)</pre> |
| <p><em>Vérifie la taille d'un fichier donné et si celle ci est trop importante |
| archive le fichier de log</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$nomFichier</td> |
| <td><p>nom du fichier à vérifier</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_desactiverEcriture" name="method_desactiverEcriture" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">desactiverEcriture()</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;">desactiverEcriture(string <span class="argument">$nomFichier</span>)</pre> |
| <p><em>Désactive l'écriture du log et envoie un message au gestionnaire d'erreurs</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$nomFichier</td> |
| <td><p>le nom du fichier qui a causé l'erreur</p></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Log.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Log.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/SquelettePhp.html |
|---|
| New file |
| 0,0 → 1,475 |
| <!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-307909126"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-307909126" 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>SquelettePhp</h1> |
| <p><em>Classe SquelettePhp, traitant les squelette Php utilisant la syntaxe courte php ou pas.</em></p> |
| <p>Ces méthodes sont statiques.</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/SquelettePhp.html#method_analyser" class="">analyser()</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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/SquelettePhp.html#method_traiterTagsCourts" class="">traiterTagsCourts()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No private properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| </section> |
| </div> |
| <aside class="span4 detailsbar"> |
| <dl> |
| <dt>File</dt> |
| <dd><a href="../files/SquelettePhp.php.html"><div class="path-wrapper">SquelettePhp.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\SquelettePhp</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>php5</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: SquelettePhp.php 241 2010-12-06 15:19:07Z jpm $</p> |
| </td> |
| </tr> |
| <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_analyser" name="method_analyser" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">analyser()</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;">analyser(String <span class="argument">$fichier</span>, Array <span class="argument">$donnees</span>) : boolean</pre> |
| <p><em>Fonction prenant en paramètre un chemin de fichier squelette et un tableau associatif de données, |
| en extrait les variables, charge le squelette et retourne le résultat des deux combinés.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>String</td> |
| <td>$fichier</td> |
| <td><p>le chemin du fichier du squelette</p></td> |
| </tr> |
| <tr> |
| <td>Array</td> |
| <td>$donnees</td> |
| <td><p>un tableau associatif contenant les variables a injecter dans le squelette.</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>false si la vue n'existe pas, sinon la chaine résultat.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_traiterTagsCourts" name="method_traiterTagsCourts" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">traiterTagsCourts()</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;">traiterTagsCourts(String <span class="argument">$chemin_squelette</span>) : string</pre> |
| <p><em>Fonction chargeant le contenu du squelette et remplaçant les tags court php (<?= .</em></p> |
| <p>..) par un tag long avec echo.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>String</td> |
| <td>$chemin_squelette</td> |
| <td><p>le chemin du fichier du squelette</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>le contenu du fichier du squelette php avec les tags courts remplacés.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">SquelettePhp.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/SquelettePhp.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Registre.html |
|---|
| New file |
| 0,0 → 1,595 |
| <!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-2114325617"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-2114325617" 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>Registre</h1> |
| <p><em>Classe Registre, qui permet un accès à différentes variables et paramètres à travers les autres classes.</em></p> |
| <p>C'est un remplaçant à la variable magique $_GLOBALS de Php. |
| C'est un singleton. |
| Si vous voulez paramètré votre application via un fichier de configuration, utilisez plutôt la classe @see Config.</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/Registre.html#method_set" class="">set()</a><br /> |
| <a href="../classes/Registre.html#method_get" class="">get()</a><br /> |
| <a href="../classes/Registre.html#method_detruire" class="">detruire()</a><br /> |
| <a href="../classes/Registre.html#method_existe" class="">existe()</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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <em>No private methods found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Registre.html#property_stockage" class="">$stockage</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/Registre.php.html"><div class="path-wrapper">Registre.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Registre</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>php 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jmp@tela-botanica.org">jmp@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL</p> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Registre.php 301 2011-01-18 14:23:52Z jpm $</p> |
| </td> |
| </tr> |
| <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_stockage" name="property_stockage" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$stockage</h3> |
| <pre class="signature">$stockage</pre> |
| <p><em>Tableau associatif stockant les variables.</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_set" name="method_set" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">set()</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;">set( <span class="argument">$intitule</span>, <span class="argument">$objet</span>)</pre> |
| <p><em>Ajoute un objet au tableau selon un intitulé donné.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$intitule</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>$objet</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_get" name="method_get" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">get()</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;">get( <span class="argument">$intitule</span>) : mixed</pre> |
| <p><em>Renvoie le contenu associé à l'intitulé donné en paramètre.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$intitule</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed |
| — <p>l'objet associé à l'intitulé ou null s'il n'est pas présent</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_detruire" name="method_detruire" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">detruire()</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;">detruire( <span class="argument">$intitule</span>)</pre> |
| <p><em>Détruit l'objet associé à l'intitulé, n'a pas d'effet si il n'y a pas d'objet associé.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$intitule</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_existe" name="method_existe" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">existe()</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;">existe( <span class="argument">$intitule</span>) : boolean</pre> |
| <p><em>Teste si le registre contient une donnée pour un intitulé d'entrée donné.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$intitule</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| boolean |
| — <p>true si un objet associé à cet intitulé est présent, false sinon</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Registre.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Registre.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/CacheSqlite.html |
|---|
| New file |
| 0,0 → 1,1585 |
| <!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-202955332"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-202955332" 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>CacheSqlite</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/CacheSqlite.html#method___construct" class="">__construct()</a><br /> |
| <a href="../classes/CacheSqlite.html#method___destruct" class="">__destruct()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_setEmplacement" class="">setEmplacement()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_charger" class="">charger()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_tester" class="">tester()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_sauver" class="">sauver()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_supprimer" class="">supprimer()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_nettoyer" class="">nettoyer()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_getIds" class="">getIds()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_getTags" class="">getTags()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_getIdsAvecLesTags" class="">getIdsAvecLesTags()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_getIdsSansLesTags" class="">getIdsSansLesTags()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_getIdsAvecUnTag" class="">getIdsAvecUnTag()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_getPourcentageRemplissage" class="">getPourcentageRemplissage()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_getMetadonnees" class="">getMetadonnees()</a><br /> |
| <a href="../classes/CacheSqlite.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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/CacheSqlite.html#property_options" class="">$options</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/CacheSqlite.html#method_initialiserOptionsParConfig" class="">initialiserOptionsParConfig()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_setOptions" class="">setOptions()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_getConnexion" class="">getConnexion()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_requeter" class="">requeter()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_defragmenterAutomatiquement" class="">defragmenterAutomatiquement()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_enregisterTag" class="">enregisterTag()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_creerStructure" class="">creerStructure()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_verifierBddStructureVersion" class="">verifierBddStructureVersion()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_nettoyerSqlite" class="">nettoyerSqlite()</a><br /> |
| <a href="../classes/CacheSqlite.html#method_verifierEtCreerStructureBdd" class="">verifierEtCreerStructureBdd()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/CacheSqlite.html#property_bdd" class="">$bdd</a><br /> |
| <a href="../classes/CacheSqlite.html#property_structure_ok" class="">$structure_ok</a><br /> |
| <a href="../classes/CacheSqlite.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/CacheSqlite.php.html"><div class="path-wrapper">CacheSqlite.php</div></a></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\CacheSqlite</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 fichier contenant la base SQLite.</p> |
| <p>====> (int) defragmentation_auto :</p> |
| <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 : |
| 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</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_bdd" name="property_bdd" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$bdd</h3> |
| <pre class="signature">$bdd : mixed</pre> |
| <p><em>DB ressource</em></p> |
| <h4>Type</h4> |
| mixed |
| </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_structure_ok" name="property_structure_ok" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$structure_ok</h3> |
| <pre class="signature">$structure_ok : boolean</pre> |
| <p><em>Boolean to store if the structure has benn checked or not</em></p> |
| <h4>Type</h4> |
| boolean |
| </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___destruct" name="method___destruct" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">__destruct()</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;">__destruct() : void</pre> |
| <p><em>Destructor</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_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|false</pre> |
| <p><em>Test if a cache is available or not (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> |
| mixed|false |
| — <p>(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_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>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_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>, array <span class="argument">$tags</span>) : boolean</pre> |
| <p><em>Clean some cache records</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>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>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_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 class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_getConnexion" name="method_getConnexion" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">getConnexion()</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;">getConnexion() : resource</pre> |
| <p><em>Return the connection resource</em></p> |
| <p>If we are not connected, the connection is made</p> |
| <h4>Throws</h4> |
| <dl> |
| <dt>\Zend_Cache_Exception</dt> |
| <dd></dd> |
| </dl> |
| <h4>Returns</h4> |
| resource |
| — <p>Connection resource</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_requeter" name="method_requeter" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">requeter()</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;">requeter(string <span class="argument">$requete</span>) : mixed|false</pre> |
| <p><em>Execute une requête SQL sans afficher de messages d'erreur.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$requete</td> |
| <td><p>requête SQL</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| mixed|false |
| — <p>resultats de la requête</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_defragmenterAutomatiquement" name="method_defragmenterAutomatiquement" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">defragmenterAutomatiquement()</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;">defragmenterAutomatiquement() : void</pre> |
| <p><em>Deal with the automatic vacuum process</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_enregisterTag" name="method_enregisterTag" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">enregisterTag()</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;">enregisterTag(string <span class="argument">$id</span>, string <span class="argument">$tag</span>) : boolean</pre> |
| <p><em>Register a cache id with the given tag</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>string</td> |
| <td>$tag</td> |
| <td><p>Tag</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_creerStructure" name="method_creerStructure" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">creerStructure()</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;">creerStructure() : false</pre> |
| <p><em>Build the database structure</em></p> |
| <h4>Returns</h4> |
| false |
| </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_verifierBddStructureVersion" name="method_verifierBddStructureVersion" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">verifierBddStructureVersion()</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;">verifierBddStructureVersion() : boolean</pre> |
| <p><em>Check if the database structure is ok (with the good version)</em></p> |
| <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_nettoyerSqlite" name="method_nettoyerSqlite" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">nettoyerSqlite()</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;">nettoyerSqlite(string <span class="argument">$mode</span>, array <span class="argument">$tags</span>) : boolean</pre> |
| <p><em>Clean some cache records</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>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>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_verifierEtCreerStructureBdd" name="method_verifierEtCreerStructureBdd" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">verifierEtCreerStructureBdd()</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;">verifierEtCreerStructureBdd() : boolean</pre> |
| <p><em>Check if the database structure is ok (with the good version), if no : build it</em></p> |
| <h4>Throws</h4> |
| <dl> |
| <dt>\Zend_Cache_Exception</dt> |
| <dd></dd> |
| </dl> |
| <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> |
| </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">CacheSqlite.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/CacheSqlite.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Chronometre.html |
|---|
| New file |
| 0,0 → 1,683 |
| <!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-1160205348"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-1160205348" 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>Chronometre</h1> |
| <p><em>Chronometre permet de stocker et d'afficher les temps d'éxécution de script.</em></p> |
| <p>Cette classe permet de réaliser un ensemble de mesure de temps prises à différents endroits d'un script. |
| Ces mesures peuvent ensuite être affichées au sein d'un tableau XHTML.</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/Chronometre.html#method_chrono" class="">chrono()</a><br /> |
| <a href="../classes/Chronometre.html#method_afficherChrono" class="">afficherChrono()</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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/Chronometre.html#method_getTemps" class="">getTemps()</a><br /> |
| <a href="../classes/Chronometre.html#method_setTemps" class="">setTemps()</a><br /> |
| <a href="../classes/Chronometre.html#method_getMicroTime" class="">getMicroTime()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Chronometre.html#property_pointArretNumero" class="">$pointArretNumero</a><br /> |
| <a href="../classes/Chronometre.html#property_temps" class="">$temps</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/Chronometre.php.html"><div class="path-wrapper">Chronometre.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Chronometre</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Chronometre.php 327 2011-02-08 17:54:34Z jpm $</p> |
| </td> |
| </tr> |
| <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_pointArretNumero" name="property_pointArretNumero" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$pointArretNumero</h3> |
| <pre class="signature">$pointArretNumero</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="property_temps" name="property_temps" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$temps</h3> |
| <pre class="signature">$temps</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_chrono" name="method_chrono" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">chrono()</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;">chrono( <span class="argument">$cle</span>) : null</pre> |
| <p><em>Effectue un chronometrage.</em></p> |
| <p>Vous pouvez indiquer le nom du point de chronométrage. |
| Si vous n'indiquez rien, un nombre sera généré en débutant à 1.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$cle</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| null |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_afficherChrono" name="method_afficherChrono" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">afficherChrono()</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;">afficherChrono( <span class="argument">$cle</span>) : string</pre> |
| <p><em>Permet d'afficher les temps d'éxécution de différentes parties d'un script.</em></p> |
| <p>Cette fonction permet d'afficher un ensemble de mesure de temps prises à différents endroits d'un script. |
| Ces mesures sont affichées au sein d'un tableau XHTML dont on peut controler l'indentation des balises. |
| Pour un site en production, il suffit d'ajouter un style #chrono {display:none;} dans la css. |
| De cette façon, le tableau ne s'affichera pas. Le webmaster lui pourra rajouter sa propre feuille de style |
| affichant le tableau. |
| Le développeur initial de cette fonction est Loic d'Anterroches. |
| Elle a été modifiée par Jean-Pascal Milcent.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$cle</td> |
| <td></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la chaine XHTML de mesure des temps.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Loic d'Anterroches</p> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_getTemps" name="method_getTemps" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">getTemps()</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;">getTemps(string <span class="argument">$cle</span>) : int</pre> |
| <p><em>Accesseurs :</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$cle</td> |
| <td><p>la cle associée à un chronomètre particulier</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| int |
| — <p>le temps écoulé</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_setTemps" name="method_setTemps" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">setTemps()</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;">setTemps( <span class="argument">$cle</span>, \array() <span class="argument">$moment</span>) : null</pre> |
| <p><em>Setteur pour la variable temps</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$cle</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>\array()</td> |
| <td>$moment</td> |
| <td><p>ajoute des points de chronométrage au tableau _temps</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| null |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_getMicroTime" name="method_getMicroTime" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">getMicroTime()</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;">getMicroTime( <span class="argument">$utps</span>)</pre> |
| <p><em></em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td></td> |
| <td>$utps</td> |
| <td></td> |
| </tr> |
| </table> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Chronometre.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Chronometre.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Debug.html |
|---|
| New file |
| 0,0 → 1,956 |
| <!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-776868168"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-776868168" 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>Debug</h1> |
| <p><em>Classe fournissant des fonctions de débogage équivalante à var_dump et print_r.</em></p> |
| <p>L'affichage et l'utilisation de ces fonctions sont améliorés via cette classe. |
| Cette classe est inspirée de la classe Zend_Debug.</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/Debug.html#method_getMode" class="">getMode()</a><br /> |
| <a href="../classes/Debug.html#method_dump" class="">dump()</a><br /> |
| <a href="../classes/Debug.html#method_printr" class="">printr()</a><br /> |
| <a href="../classes/Debug.html#method_tailleMemoireVar" class="">tailleMemoireVar()</a><br /> |
| <a href="../classes/Debug.html#method_tailleMemoireScript" class="">tailleMemoireScript()</a><br /> |
| </section> |
| <section class="span4"> |
| <em>No public properties found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Debug.html#constant_MODE_ECHO" class="">MODE_ECHO</a><br /> |
| <a href="../classes/Debug.html#constant_MODE_NOTICE" class="">MODE_NOTICE</a><br /> |
| <a href="../classes/Debug.html#constant_MODE_ENTETE_HTTP" class="">MODE_ENTETE_HTTP</a><br /> |
| </section> |
| </section> |
| <section class="row-fluid protected"> |
| <section class="span4"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Debug.html#property_mode" class="">$mode</a><br /> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <a href="../classes/Debug.html#method_traiterDebogage" class="">traiterDebogage()</a><br /> |
| <a href="../classes/Debug.html#method_formaterMotCle" class="">formaterMotCle()</a><br /> |
| <a href="../classes/Debug.html#method_traiterSortieSuivantMode" class="">traiterSortieSuivantMode()</a><br /> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Debug.html#property_parametres_obligatoires" class="">$parametres_obligatoires</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/Debug.php.html"><div class="path-wrapper">Debug.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Framework</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Debug</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Debug.php 366 2011-09-30 08:20:45Z jpm $</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <a id="constants" name="constants"></a> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <h2>Constants</h2> |
| </div> |
| <aside class="span4 detailsbar"></aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="constant_MODE_ECHO" name="constant_MODE_ECHO" class="anchor"></a> |
| <article id="constant_MODE_ECHO" class="constant"> |
| <h3 class="">MODE_ECHO</h3> |
| <pre class="signature">MODE_ECHO</pre> |
| <p><em>Paramètrer le fichier de config avec "php:Debug::MODE_ECHO" : les messages sont affichés en utilisant echo au moment |
| où ils sont déclenchés dans le code.</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="constant_MODE_NOTICE" name="constant_MODE_NOTICE" class="anchor"></a> |
| <article id="constant_MODE_NOTICE" class="constant"> |
| <h3 class="">MODE_NOTICE</h3> |
| <pre class="signature">MODE_NOTICE</pre> |
| <p><em>Paramètrer le fichier de config avec "php:Debug::MODE_NOTICE" : les message sont stockés par le gestionnaire |
| d'exception sous forme d'erreur de type E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'execution |
| du programme (via echo).</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="constant_MODE_ENTETE_HTTP" name="constant_MODE_ENTETE_HTTP" class="anchor"></a> |
| <article id="constant_MODE_ENTETE_HTTP" class="constant"> |
| <h3 class="">MODE_ENTETE_HTTP</h3> |
| <pre class="signature">MODE_ENTETE_HTTP</pre> |
| <p><em>Paramètrer le fichier de config avec "php:Debug::MODE_ENTETE_HTTP" : les message sont stockés par le gestionnaire |
| d'exception sous forme d'erreur de type E_USER_NOTICE et sont renvoyés dans un entête HTTP (X_REST_DEBOGAGE_MESSAGES) |
| à la fin de l'execution du programme.</em></p> |
| <p>Surtout utile pour le Serveur REST.</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="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_mode" name="property_mode" class="anchor"></a> |
| <article class="property"> |
| <h3 class="protected ">$mode</h3> |
| <pre class="signature">$mode</pre> |
| <p><em>Mode de php (cli ou sapi)</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="property_parametres_obligatoires" name="property_parametres_obligatoires" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$parametres_obligatoires</h3> |
| <pre class="signature">$parametres_obligatoires</pre> |
| <p><em>Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</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_getMode" name="method_getMode" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">getMode()</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;">getMode() : string</pre> |
| <p><em>Accesseur pour le mode</em></p> |
| <h4>Returns</h4> |
| string |
| — <p>le mode de php</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_dump" name="method_dump" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">dump()</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;">dump(mixed <span class="argument">$variable</span>, string <span class="argument">$mot_cle</span>, boolean <span class="argument">$echo</span>) : string</pre> |
| <p><em>Equivalent de var_dump</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>mixed</td> |
| <td>$variable</td> |
| <td><p>la variable à dumper</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$mot_cle</td> |
| <td><p>le mot cle à associer à la variable</p></td> |
| </tr> |
| <tr> |
| <td>boolean</td> |
| <td>$echo</td> |
| <td><p>si true on affiche le résultat, si false on ne renvoie que la chaine sans l'afficher</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la chaine à afficher representant le dump ou null si echo</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_printr" name="method_printr" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">printr()</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;">printr(mixed <span class="argument">$variable</span>, string <span class="argument">$mot_cle</span>, boolean <span class="argument">$echo</span>) : string</pre> |
| <p><em>Equivalent de print_r.</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>mixed</td> |
| <td>$variable</td> |
| <td><p>la variable à afficher</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$mot_cle</td> |
| <td><p>le mot cle à associer</p></td> |
| </tr> |
| <tr> |
| <td>boolean</td> |
| <td>$echo</td> |
| <td><p>faire un echo ou non</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la chaine contenant la variable printée ou null si echo</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_tailleMemoireVar" name="method_tailleMemoireVar" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">tailleMemoireVar()</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;">tailleMemoireVar(mixed <span class="argument">$var</span>, string <span class="argument">$mot_cle</span>, boolean <span class="argument">$echo</span>) : string</pre> |
| <p><em>Affichage d'informations sur l'espace mémoire occupé par une variable</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>mixed</td> |
| <td>$var</td> |
| <td><p>la variable dont on veut connaître l'empreinte mémoire.</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$mot_cle</td> |
| <td><p>le mot cle à associer</p></td> |
| </tr> |
| <tr> |
| <td>boolean</td> |
| <td>$echo</td> |
| <td><p>faire un echo ou non</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la chaine d'information sur l'espace mémoire occupé ou bien null si echo</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href="http://forum.webmaster-rank.info/developpement-site/code-taille-memoire-d-une-variable-en-php-t1344.html"><span class="namespace-wrapper">http://forum.webmaster-rank.info/developpement-site/code-taille-memoire-d-une-variable-en-php-t1344.html</span></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| 0.3 |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_tailleMemoireScript" name="method_tailleMemoireScript" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">tailleMemoireScript()</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;">tailleMemoireScript(string <span class="argument">$mot_cle</span>, boolean <span class="argument">$echo</span>) : string</pre> |
| <p><em>Affichage d'informations sur l'espace mémoire occupé par le script PHP</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$mot_cle</td> |
| <td><p>le mot cle à associer</p></td> |
| </tr> |
| <tr> |
| <td>boolean</td> |
| <td>$echo</td> |
| <td><p>faire un echo ou non</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la chaine d'information sur l'espace mémoire occupé ou bien null si echo</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <dl> |
| <dt>See also</dt> |
| <dd><a href="http://forum.webmaster-rank.info/developpement-site/code-taille-memoire-d-une-variable-en-php-t1344.html"><span class="namespace-wrapper">http://forum.webmaster-rank.info/developpement-site/code-taille-memoire-d-une-variable-en-php-t1344.html</span></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| since |
| </th> |
| <td> |
| 0.3 |
| </td> |
| </tr> |
| <tr> |
| <th> |
| todo |
| </th> |
| <td> |
| </td> |
| </tr> |
| </table> |
| </aside> |
| </div> |
| <div class="row-fluid"> |
| <div class="span8 content class"> |
| <a id="method_traiterDebogage" name="method_traiterDebogage" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">traiterDebogage()</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;">traiterDebogage(string <span class="argument">$mot_cle</span>, string <span class="argument">$sortie</span>, boolean <span class="argument">$echo</span>) : string</pre> |
| <p><em>Traite une chaine de débogage et les mots clés associés</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$mot_cle</td> |
| <td><p>le mot à associer à la chaine</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$sortie</td> |
| <td><p>le chaine de debogage</p></td> |
| </tr> |
| <tr> |
| <td>boolean</td> |
| <td>$echo</td> |
| <td><p>faire un echo du resultat ou non</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la chaine de debogage formatée ou bien null si echo</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_formaterMotCle" name="method_formaterMotCle" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">formaterMotCle()</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;">formaterMotCle(string <span class="argument">$mot_cle</span>) : string</pre> |
| <p><em>formate un mot clé donné</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$mot_cle</td> |
| <td><p>le mot clé à formaté</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>le mot clé formaté ou bien un chaine vide le mot clé est null ou vide</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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_traiterSortieSuivantMode" name="method_traiterSortieSuivantMode" class="anchor"></a> |
| <article class="method"> |
| <h3 class="private ">traiterSortieSuivantMode()</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;">traiterSortieSuivantMode(string <span class="argument">$mot_cle</span>, string <span class="argument">$sortie</span>) : string</pre> |
| <p><em>traite la sortie de la chaine de débogage suivant le mode de php</em></p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>string</td> |
| <td>$mot_cle</td> |
| <td><p>le mot clé associé à la chaine</p></td> |
| </tr> |
| <tr> |
| <td>string</td> |
| <td>$sortie</td> |
| <td><p>la chaine de débogage</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| string |
| — <p>la sortie formatée pour le mode en cours</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Debug.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/Debug.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> |
| /branches/v0.3-aleaume/doc/PhpDoc/classes/Chaine.html |
|---|
| New file |
| 0,0 → 1,501 |
| <!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-1886898021"></a> |
| <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> |
| </div> |
| <div id="namespace-1886898021" 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>Chaine</h1> |
| <p><em>Classe fournissant des méthodes statiques de manipulation des chaînes de caractères (String).</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/Chaine.html#method_supprimerAccents" class="">supprimerAccents()</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"> |
| <em>No protected methods found</em> |
| </section> |
| <section class="span4"> |
| <em>No protected properties found</em> |
| </section> |
| <section class="span4"> |
| <em>N/A</em> |
| </section> |
| </section> |
| <section class="row-fluid private"> |
| <section class="span4"> |
| <em>No private methods found</em> |
| </section> |
| <section class="span4"> |
| <a href="../classes/Chaine.html#property_caracteres_accentues" class="">$caracteres_accentues</a><br /> |
| <a href="../classes/Chaine.html#property_caracteres_normaux" class="">$caracteres_normaux</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/utilitaires.Chaine.php.html"><div class="path-wrapper">utilitaires/Chaine.php</div></a></dd> |
| <dt>Package</dt> |
| <dd><div class="namespace-wrapper">\Utilitaire</div></dd> |
| <dt>Class hierarchy</dt> |
| <dd class="hierarchy"> |
| <div class="namespace-wrapper">\Chaine</div> |
| </dd> |
| <dt>See also</dt> |
| <dd><a href="/doc/framework/"><div class="namespace-wrapper">/doc/framework/</div></a></dd> |
| </dl> |
| <h2>Tags</h2> |
| <table class="table table-condensed"> |
| <tr> |
| <th> |
| category |
| </th> |
| <td> |
| <p>PHP 5.2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| author |
| </th> |
| <td> |
| <p>Jean-Pascal MILCENT <a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a></p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| copyright |
| </th> |
| <td> |
| <p>Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| license |
| </th> |
| <td> |
| <p><a href="http://www.gnu.org/licenses/gpl.html">http://www.gnu.org/licenses/gpl.html</a> Licence GNU-GPL-v3</p> |
| <p><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt</a> Licence CECILL-v2</p> |
| </td> |
| </tr> |
| <tr> |
| <th> |
| version |
| </th> |
| <td> |
| <p>$Id: Chaine.php 343 2011-06-09 14:59:36Z jpm $</p> |
| </td> |
| </tr> |
| <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_caracteres_accentues" name="property_caracteres_accentues" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$caracteres_accentues</h3> |
| <pre class="signature">$caracteres_accentues</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="property_caracteres_normaux" name="property_caracteres_normaux" class="anchor"></a> |
| <article class="property"> |
| <h3 class="private ">$caracteres_normaux</h3> |
| <pre class="signature">$caracteres_normaux</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_supprimerAccents" name="method_supprimerAccents" class="anchor"></a> |
| <article class="method"> |
| <h3 class="public ">supprimerAccents()</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;">supprimerAccents(String <span class="argument">$chaine</span>, String <span class="argument">$encodage</span>) : \la</pre> |
| <p><em>Supprime ou remplace les accents d'une chaine en PHP.</em></p> |
| <p>La solution retenu, provenant du site |
| {@link <a href="http://www.lecoindunet.com/zone_php/scripts_utiles/remplacer-les-caracteres-accentues-dune-chaine-en-php-72">http://www.lecoindunet.com/zone_php/scripts_utiles/remplacer-les-caracteres-accentues-dune-chaine-en-php-72</a> lecoindunet.com}, |
| consiste en deux tableaux (caractères avec et sans accents) car cela permetra éventuellement |
| de fournir des méthodes pour récupérer ces tableaux pour d'autres traitements. |
| Une autre solution aurait été d'utiliser les entités HTML comme proposé par le site |
| {@link <a href="http://www.weirdog.com/blog/php/supprimer-les-accents-des-caracteres-accentues.html">http://www.weirdog.com/blog/php/supprimer-les-accents-des-caracteres-accentues.html</a> weirdog.com}.</p> |
| <h4>Parameters</h4> |
| <table class="table table-condensed table-hover"> |
| <tr> |
| <td>String</td> |
| <td>$chaine</td> |
| <td><p>la chaine de caractères dans laquelle supprimer les accents.</p></td> |
| </tr> |
| <tr> |
| <td>String</td> |
| <td>$encodage</td> |
| <td><p>le code d'encodage de la chaine si ce n'est pas de l'UTF-8.</p></td> |
| </tr> |
| </table> |
| <h4>Returns</h4> |
| \la |
| — <p>chaine de caractères sans accent.</p> |
| </article> |
| </div> |
| <aside class="span4 detailsbar"> |
| <h1><i class="icon-arrow-down"></i></h1> |
| <span class="label label-info">static</span> |
| <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">Chaine.php</h3> |
| </div> |
| <div class="modal-body"> |
| <pre data-src="../files/utilitaires/Chaine.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> |