Rev 302 | Blame | Compare with Previous | Last modification | View Log | RSS feed
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><!-- template designed by Marco Von Ballmoos --><title>Docs For Class Framework</title><meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/><link rel="stylesheet" href="../media/stylesheet.css" /><script src="../media/lib/classTree.js"></script><script language="javascript" type="text/javascript">var imgPlus = new Image();var imgMinus = new Image();imgPlus.src = "../media/images/plus.png";imgMinus.src = "../media/images/minus.png";function showNode(Node){switch(navigator.family){case 'nn4':// Nav 4.x code fork...var oTable = document.layers["span" + Node];var oImg = document.layers["img" + Node];break;case 'ie4':// IE 4/5 code fork...var oTable = document.all["span" + Node];var oImg = document.all["img" + Node];break;case 'gecko':// Standards Compliant code fork...var oTable = document.getElementById("span" + Node);var oImg = document.getElementById("img" + Node);break;}oImg.src = imgMinus.src;oTable.style.display = "block";}function hideNode(Node){switch(navigator.family){case 'nn4':// Nav 4.x code fork...var oTable = document.layers["span" + Node];var oImg = document.layers["img" + Node];break;case 'ie4':// IE 4/5 code fork...var oTable = document.all["span" + Node];var oImg = document.all["img" + Node];break;case 'gecko':// Standards Compliant code fork...var oTable = document.getElementById("span" + Node);var oImg = document.getElementById("img" + Node);break;}oImg.src = imgPlus.src;oTable.style.display = "none";}function nodeIsVisible(Node){switch(navigator.family){case 'nn4':// Nav 4.x code fork...var oTable = document.layers["span" + Node];break;case 'ie4':// IE 4/5 code fork...var oTable = document.all["span" + Node];break;case 'gecko':// Standards Compliant code fork...var oTable = document.getElementById("span" + Node);break;}return (oTable && oTable.style.display == "block");}function toggleNodeVisibility(Node){if (nodeIsVisible(Node)){hideNode(Node);}else{showNode(Node);}}</script></head><body><div class="page-body"><h2 class="class-name">Class Framework</h2><a name="sec-description"></a><div class="info-box"><div class="info-box-title">Description</div><div class="nav-bar"><span class="disabled">Description</span> |<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)</div><div class="info-box-body"><!-- ========== Info from phpDoc block ========= --><p class="short-description">Classe de base du Framework :</p><p class="description"><p><ul><li>fournissant des infos sur l'application,</li><li>paramétrant l'environnement de l'appli et du framework,</li><li>réalisant des traitements sur les variables globales ($_GET, $_POST, $_COOKIE...)</li></ul> 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></p><ul class="tags"><li><span class="field">author:</span> Jean-Pascal MILCENT <<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>></li><li><span class="field">version:</span> $Id: Framework.php 274 2010-12-28 15:37:22Z jpm $</li><li><span class="field">copyright:</span> Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)</li><li><span class="field">link:</span> /doc/framework/</li><li><span class="field">since:</span> 0.3</li><li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL-v3</a></li><li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL-v2</a></li></ul><p class="notes">Located in <a class="field" href="_Framework.php.html">/Framework.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Framework.php.html#a23">23</a></span>)</p><pre></pre></div></div><a name="sec-method-summary"></a><div class="info-box"><div class="info-box-title">Method Summary</span></div><div class="nav-bar"><a href="#sec-description">Description</a> |<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)</div><div class="info-box-body"><div class="method-summary"><div class="method-definition">static <span class="method-result">Array</span><a href="#encoderTableau" title="details" class="method-name">encoderTableau</a>(<span class="var-type">$tableau</span> <span class="var-name">$tableau</span>, <span class="var-type">$encodage_sortie</span> <span class="var-name">$encodage_sortie</span>, [<span class="var-type">$encodage_entree</span> <span class="var-name">$encodage_entree</span> = <span class="var-default">null</span>])</div><div class="method-definition">static <span class="method-result">string</span><a href="#getCheminAppli" title="details" class="method-name">getCheminAppli</a>()</div><div class="method-definition">static <span class="method-result">void</span><a href="#getInfoAppli" title="details" class="method-name">getInfoAppli</a>([<span class="var-type">string</span> <span class="var-name">$cle</span> = <span class="var-default">null</span>])</div><div class="method-definition">static <span class="method-result">void</span><a href="#setCheminAppli" title="details" class="method-name">setCheminAppli</a>(<span class="var-type">string</span> <span class="var-name">$chemin_fichier_principal</span>)</div><div class="method-definition">static <span class="method-result">void</span><a href="#setInfoAppli" title="details" class="method-name">setInfoAppli</a>(<span class="var-type">array</span> <span class="var-name">$info</span>)</div><div class="method-definition">static <span class="method-result">void</span><a href="#verifierEtReencoderTableauRequete" title="details" class="method-name">verifierEtReencoderTableauRequete</a>()</div></div></div></div><a name="sec-methods"></a><div class="info-box"><div class="info-box-title">Methods</div><div class="nav-bar"><a href="#sec-description">Description</a> |<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)</div><div class="info-box-body"><A NAME='method_detail'></A><a name="methodencoderTableau" id="encoderTableau"><!-- --></a><div class="oddrow"><div class="method-header"><span class="method-title">static encoderTableau</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Framework.php.html#a228">228</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Fonction récursive transcodant toutes les valeurs d'un tableau de leur encodage d'entrée vers un encodage de sortie donné</p><ul class="tags"><li><span class="field">return:</span> Le tableau encodé dans l'encodage de sortie</li><li><span class="field">access:</span> protected</li></ul><div class="method-signature">static <span class="method-result">Array</span><span class="method-name">encoderTableau</span>(<span class="var-type">$tableau</span> <span class="var-name">$tableau</span>, <span class="var-type">$encodage_sortie</span> <span class="var-name">$encodage_sortie</span>, [<span class="var-type">$encodage_entree</span> <span class="var-name">$encodage_entree</span> = <span class="var-default">null</span>])</div><ul class="parameters"><li><span class="var-type">$tableau</span><span class="var-name">$tableau</span><span class="var-description">: Array Un tableau de données à encoder</span> </li><li><span class="var-type">$encodage_sortie</span><span class="var-name">$encodage_sortie</span><span class="var-description">: String l'encodage vers lequel on doit transcoder</span> </li><li><span class="var-type">$encodage_entree</span><span class="var-name">$encodage_entree</span><span class="var-description">: String l'encodage original des chaines du tableau (optionnel)</span> </li></ul></div><a name="methodgetCheminAppli" id="getCheminAppli"><!-- --></a><div class="evenrow"><div class="method-header"><span class="method-title">static getCheminAppli</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Framework.php.html#a155">155</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">accesseur pour le chemin</p><ul class="tags"><li><span class="field">return:</span> le chemin</li><li><span class="field">access:</span> public</li></ul><div class="method-signature">static <span class="method-result">string</span><span class="method-name">getCheminAppli</span>()</div></div><a name="methodgetInfoAppli" id="getInfoAppli"><!-- --></a><div class="oddrow"><div class="method-header"><span class="method-title">static getInfoAppli</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Framework.php.html#a179">179</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Accesseur pour le tableau d'infos sur l'application.</p><ul class="tags"><li><span class="field">access:</span> public</li></ul><div class="method-signature">static <span class="method-result">void</span><span class="method-name">getInfoAppli</span>([<span class="var-type">string</span> <span class="var-name">$cle</span> = <span class="var-default">null</span>])</div><ul class="parameters"><li><span class="var-type">string</span><span class="var-name">$cle</span><span class="var-description">: la clé à laquelle on veut accéder</span> </li></ul></div><a name="methodsetCheminAppli" id="setCheminAppli"><!-- --></a><div class="evenrow"><div class="method-header"><span class="method-title">static setCheminAppli</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Framework.php.html#a136">136</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Permet d'indiquer le chemin de base de l'Application.</p><p class="description"><p>Cette méthode doit obligatoirement être utilisée par l'application pour que le Framework fonctionne correctement.</p></p><ul class="tags"><li><span class="field">access:</span> public</li></ul><div class="method-signature">static <span class="method-result">void</span><span class="method-name">setCheminAppli</span>(<span class="var-type">string</span> <span class="var-name">$chemin_fichier_principal</span>)</div><ul class="parameters"><li><span class="var-type">string</span><span class="var-name">$chemin_fichier_principal</span><span class="var-description">: chemin de base</span> </li></ul></div><a name="methodsetInfoAppli" id="setInfoAppli"><!-- --></a><div class="oddrow"><div class="method-header"><span class="method-title">static setInfoAppli</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Framework.php.html#a167">167</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Le tableau des informations sur l'application possède les clés suivantes :</p><p class="description"><p><ul><li>nom : nom de l'application</li><li>abr : abréviation de l'application</li><li>encodage : encodage de l'application (ISO-8859-15, UTF-8...)</li></ul></p></p><ul class="tags"><li><span class="field">access:</span> public</li></ul><div class="method-signature">static <span class="method-result">void</span><span class="method-name">setInfoAppli</span>(<span class="var-type">array</span> <span class="var-name">$info</span>)</div><ul class="parameters"><li><span class="var-type">array</span><span class="var-name">$info</span><span class="var-description">: tableau fournissant des informations sur l'application</span> </li></ul></div><a name="methodverifierEtReencoderTableauRequete" id="verifierEtReencoderTableauRequete"><!-- --></a><div class="evenrow"><div class="method-header"><span class="method-title">static verifierEtReencoderTableauRequete</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Framework.php.html#a192">192</a></span>)</div><!-- ========== Info from phpDoc block ========= --><p class="short-description">Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les transcodant dans l'encodage de l'application</p><ul class="tags"><li><span class="field">access:</span> protected</li></ul><div class="method-signature">static <span class="method-result">void</span><span class="method-name">verifierEtReencoderTableauRequete</span>()</div></div></div></div><p class="notes" id="credit">Documentation generated on Tue, 18 Jan 2011 15:30:49 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a></p></div></body></html>