Blame | Last modification | View Log | RSS feed
<!DOCTYPE html><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="ApiGen 2.8.0"><meta name="robots" content="noindex"><title>File Controleur.php | TBFramework - v0.3</title><script type="text/javascript" src="resources/combined.js?4205936287"></script><script type="text/javascript" src="elementlist.js?4111837732"></script><link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360"></head><body><div id="left"><div id="menu"><a href="index.html" title="Overview"><span>Overview</span></a><div id="groups"><h3>Packages</h3><ul><li class="active"><a href="package-Framework.html">Framework</a></li><li><a href="package-None.html">None</a></li><li><a href="package-PHP.html">PHP</a></li><li><a href="package-Utilitaire.html">Utilitaire</a></li></ul></div><hr><div id="elements"><h3>Classes</h3><ul><li><a href="class-Bdd.html">Bdd</a></li><li><a href="class-Cache.html">Cache</a></li><li><a href="class-CacheSimple.html">CacheSimple</a></li><li><a href="class-Chronometre.html">Chronometre</a></li><li><a href="class-Cli.html">Cli</a></li><li><a href="class-Config.html">Config</a></li><li class="active"><a href="class-Controleur.html">Controleur</a></li><li><a href="class-Debug.html">Debug</a></li><li><a href="class-Framework.html">Framework</a></li><li><a href="class-GestionnaireException.html">GestionnaireException</a></li><li><a href="class-I18n.html">I18n</a></li><li><a href="class-Log.html">Log</a></li><li><a href="class-Registre.html">Registre</a></li><li><a href="class-RestClient.html">RestClient</a></li><li><a href="class-RestServeur.html">RestServeur</a></li><li><a href="class-RestService.html">RestService</a></li><li><a href="class-Script.html">Script</a></li><li><a href="class-SquelettePhp.html">SquelettePhp</a></li><li><a href="class-Url.html">Url</a></li></ul></div></div></div><div id="splitter"></div><div id="right"><div id="rightInner"><form id="search"><input type="hidden" name="cx" value=""><input type="hidden" name="ie" value="UTF-8"><input type="text" name="q" class="text"><input type="submit" value="Search"></form><div id="navigation"><ul><li><a href="index.html" title="Overview"><span>Overview</span></a></li><li><a href="package-Framework.html" title="Summary of Framework"><span>Package</span></a></li><li><a href="class-Controleur.html" title="Summary of Controleur"><span>Class</span></a></li></ul><ul><li><a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a></li><li><a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a></li><li><a href="todo.html" title="Todo list"><span>Todo</span></a></li></ul><ul></ul></div><pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span></span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">// declare(encoding='UTF-8');</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment">/**</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> * Classe Controleur, coeur d'une application, c'est normalement la seule classe d'une application</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * qui devrait être appelée de l'extérieur.</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * Elle est abstraite donc doit obligatoirement être étendue.</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> *</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * @category php 5.2</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * @package Framework</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> * @author Aurélien PERONNET <aurelien@tela-botanica.org></span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * @author Jean-Pascal MILCENT <jpm@tela-botanica.org></span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * @copyright Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * @version $Id: Controleur.php 332 2011-03-22 16:54:23Z delphine $</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * @link /doc/framework/</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> *</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> */</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> <a id="Controleur" href="#Controleur">Controleur</a> {</span><span id="20" class="l"><a class="l" href="#20"> 20: </a> <span class="php-comment">/** Variable statique indiquant que les tableaux _GET et _POST ont déjà été encodé au format de l'appli. */</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$encodage" href="#$encodage">$encodage</a></span> = <span class="php-keyword1">false</span>;</span><span id="22" class="l"><a class="l" href="#22"> 22: </a></span><span id="23" class="l"><a class="l" href="#23"> 23: </a> <span class="php-comment">/** Chemin de base vers les classes métiers de la partie Modèle de l'application. */</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$base_chemin_modele" href="#$base_chemin_modele">$base_chemin_modele</a></span> = <span class="php-keyword1">null</span>;</span><span id="25" class="l"><a class="l" href="#25"> 25: </a></span><span id="26" class="l"><a class="l" href="#26"> 26: </a> <span class="php-comment">/** Chemin de base vers les fichiers squelette de la partie Vue de l'application. */</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$base_chemin_squelette" href="#$base_chemin_squelette">$base_chemin_squelette</a></span> = <span class="php-keyword1">null</span>;</span><span id="28" class="l"><a class="l" href="#28"> 28: </a></span><span id="29" class="l"><a class="l" href="#29"> 29: </a> <span class="php-comment">/** Chemin de base vers les classes controleurs de la partie Controleur de l'application. */</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$base_chemin_controleur" href="#$base_chemin_controleur">$base_chemin_controleur</a></span> = <span class="php-keyword1">null</span>;</span><span id="31" class="l"><a class="l" href="#31"> 31: </a></span><span id="32" class="l"><a class="l" href="#32"> 32: </a> <span class="php-comment">/** Objet URL contant l'url de la base de l'application. */</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$base_url_applicaton" href="#$base_url_applicaton">$base_url_applicaton</a></span> = <span class="php-keyword1">null</span>;</span><span id="34" class="l"><a class="l" href="#34"> 34: </a></span><span id="35" class="l"><a class="l" href="#35"> 35: </a> <span class="php-comment">/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$parametres_obligatoires" href="#$parametres_obligatoires">$parametres_obligatoires</a></span> = <span class="php-keyword1">array</span>(<span class="php-quote">'chemin_modeles'</span>, <span class="php-quote">'chemin_squelettes'</span>, <span class="php-quote">'chemin_controleurs'</span>, <span class="php-quote">'base_url_application'</span>);</span><span id="37" class="l"><a class="l" href="#37"> 37: </a></span><span id="38" class="l"><a class="l" href="#38"> 38: </a> <span class="php-comment">/**</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * Constructeur par défaut</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> */</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>() {</span><span id="42" class="l"><a class="l" href="#42"> 42: </a> Config::verifierPresenceParametres(<span class="php-var">$this</span>->parametres_obligatoires);</span><span id="43" class="l"><a class="l" href="#43"> 43: </a> <span class="php-var">$this</span>->base_chemin_modele = Config::get(<span class="php-quote">'chemin_modeles'</span>);</span><span id="44" class="l"><a class="l" href="#44"> 44: </a> <span class="php-var">$this</span>->base_chemin_squelette = Config::get(<span class="php-quote">'chemin_squelettes'</span>);</span><span id="45" class="l"><a class="l" href="#45"> 45: </a> <span class="php-var">$this</span>->base_chemin_controleur = Config::get(<span class="php-quote">'chemin_controleurs'</span>);</span><span id="46" class="l"><a class="l" href="#46"> 46: </a> <span class="php-var">$this</span>->base_url_application = <span class="php-keyword1">new</span> Url(Config::get(<span class="php-quote">'base_url_application'</span>));</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> }</span><span id="48" class="l"><a class="l" href="#48"> 48: </a></span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-comment">/**</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * Charge un modele donné et le rend disponible sous la forme $this->nom_modele</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> *</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * @param string $nom_modele le nom du modèle à charger</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> *</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment"> * @return boolean false si le chargement a échoué, sinon true.</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> */</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-keyword1">final</span> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_chargerModele" href="#_chargerModele">chargerModele</a>(<span class="php-var">$nom_modele</span>) {</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-var">$sortie</span> = <span class="php-keyword1">true</span>;</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$this</span>-><span class="php-var">$nom_modele</span>)) {</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-var">$modele</span> = <span class="php-var">$this</span>->getModele(<span class="php-var">$nom_modele</span>);</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-keyword1">if</span> (<span class="php-var">$modele</span> !== <span class="php-keyword1">false</span>) {</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-var">$this</span>-><span class="php-var">$nom_modele</span> = <span class="php-var">$modele</span>;</span><span id="62" class="l"><a class="l" href="#62"> 62: </a> } <span class="php-keyword1">else</span> {</span><span id="63" class="l"><a class="l" href="#63"> 63: </a> <span class="php-var">$sortie</span> = <span class="php-keyword1">false</span>;</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> }</span><span id="65" class="l"><a class="l" href="#65"> 65: </a> }</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-keyword1">return</span> <span class="php-var">$sortie</span>;</span><span id="67" class="l"><a class="l" href="#67"> 67: </a> }</span><span id="68" class="l"><a class="l" href="#68"> 68: </a></span><span id="69" class="l"><a class="l" href="#69"> 69: </a> <span class="php-comment">/**</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * Retourne un modele donné</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> *</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * @param string $nom_modele le nom du fichier modèle à charger sans son extension</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * @param String $ext l'extension du fichier du modèel (par défaut : ".php"</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> *</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * @return mixed false si le chargement a échoué, sinon l'objet du modèle demandé.</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> */</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">final</span> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_getModele" href="#_getModele">getModele</a>(<span class="php-var">$nom_modele</span>, <span class="php-var">$ext</span> = <span class="php-quote">'.php'</span>) {</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-var">$sortie</span> = <span class="php-keyword1">false</span>;</span><span id="79" class="l"><a class="l" href="#79"> 79: </a></span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-var">$chemin_modele</span> = <span class="php-var">$this</span>->registre->get(<span class="php-quote">'base_chemin_modele'</span>).<span class="php-var">$nom_modele</span>.<span class="php-var">$ext</span>;</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">file_exists</span>(<span class="php-var">$chemin_modele</span>)) {</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-keyword1">include_once</span> <span class="php-var">$chemin_modele</span>;</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">class_exists</span>(<span class="php-var">$nom_modele</span>)) {</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> <span class="php-var">$sortie</span> = <span class="php-keyword1">new</span> <span class="php-var">$nom_modele</span>;</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> }</span><span id="86" class="l"><a class="l" href="#86"> 86: </a> }</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-keyword1">return</span> <span class="php-var">$sortie</span>;</span><span id="88" class="l"><a class="l" href="#88"> 88: </a> }</span><span id="89" class="l"><a class="l" href="#89"> 89: </a></span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-comment">/**</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * Fonction prenant en paramètre le nom d'un squelette et un tableau associatif de données,</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * en extrait les variables, charge le squelette et retourne le résultat des deux combinés.</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> *</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * @param String $nom_squelette le nom du squelette sans son extension</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * @param Array $donnees un tableau associatif contenant les variables a injecter dans la vue</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * @param String $ext l'extension du fichier du squelette (par défaut : ".tpl.html"</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> *</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * @return boolean false si la vue n'existe pas, sinon la chaine résultat.</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> */</span></span><span id="100" class="l"><a class="l" href="#100">100: </a> <span class="php-keyword1">final</span> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_getVue" href="#_getVue">getVue</a>(<span class="php-var">$nom_squelette</span>, &<span class="php-var">$donnees</span> = <span class="php-keyword1">array</span>(), <span class="php-var">$ext</span> = <span class="php-quote">'.tpl.html'</span>) {</span><span id="101" class="l"><a class="l" href="#101">101: </a> <span class="php-var">$donnees</span> = <span class="php-var">$this</span>->preTraiterDonnees(<span class="php-var">$donnees</span>);</span><span id="102" class="l"><a class="l" href="#102">102: </a></span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-var">$chemin_squelette</span> = <span class="php-var">$this</span>->base_chemin_squelette.<span class="php-var">$nom_squelette</span>.<span class="php-var">$ext</span>;</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-var">$sortie</span> = SquelettePhp::analyser(<span class="php-var">$chemin_squelette</span>, <span class="php-var">$donnees</span>);</span><span id="105" class="l"><a class="l" href="#105">105: </a></span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-keyword1">return</span> <span class="php-var">$sortie</span>;</span><span id="107" class="l"><a class="l" href="#107">107: </a> }</span><span id="108" class="l"><a class="l" href="#108">108: </a></span><span id="109" class="l"><a class="l" href="#109">109: </a> <span class="php-comment">/**</span></span><span id="110" class="l"><a class="l" href="#110">110: </a><span class="php-comment"> * Fonction prenant en paramètre un tableau de données et effectuant un traitement dessus.</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * Cette fonction est à surcharger dans les classes filles pour automatiser un traitement</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> * avant chaque chargement de vue.</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> *</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> * @param Array $donnees Le tableau de données à traiter</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> *</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> * @return Array $donnees Le tableau de données traité</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> */</span></span><span id="118" class="l"><a class="l" href="#118">118: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_preTraiterDonnees" href="#_preTraiterDonnees">preTraiterDonnees</a>(&<span class="php-var">$donnees</span>) {</span><span id="119" class="l"><a class="l" href="#119">119: </a> <span class="php-keyword1">return</span> <span class="php-var">$donnees</span>;</span><span id="120" class="l"><a class="l" href="#120">120: </a> }</span><span id="121" class="l"><a class="l" href="#121">121: </a>}</span><span id="122" class="l"><a class="l" href="#122">122: </a></span><span class="xlang">?></span></code></pre><div id="footer">TBFramework - v0.3 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a></div></div></div></body></html>