New file |
0,0 → 1,435 |
<!DOCTYPE html> |
<html> |
<head> |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
<meta name="generator" content="ApiGen 2.8.0"> |
|
<title>Class Controleur | 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 class="active"> |
<span>Class</span> </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> |
|
<div id="content" class="class"> |
<h1>Class Controleur</h1> |
|
|
<div class="description"> |
|
<p>Classe Controleur, coeur d'une application, c'est normalement la seule classe |
d'une application qui devrait être appelée de l'extérieur. Elle est abstraite |
donc doit obligatoirement être étendue.</p> |
|
</div> |
|
|
|
|
|
|
|
|
|
<div class="info"> |
<b>Abstract</b><br> |
|
|
<b>Package:</b> <a href="package-Framework.html">Framework</a><br> |
|
<b>Category:</b> |
php 5.2<br> |
<b>Copyright:</b> |
Copyright (c) 2009, Tela Botanica (<a |
href="mailto:accueil@tela-botanica.org">accueil@<!-- -->tela-botanica.org</a>)<br> |
<b>License:</b> |
<a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a><br> |
<b>License:</b> |
<a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a><br> |
<b>Author:</b> |
Aurélien PERONNET <<a |
href="mailto:aurelien@tela-botanica.org">aurelien@<!-- -->tela-botanica.org</a>><br> |
<b>Author:</b> |
Jean-Pascal MILCENT <<a |
href="mailto:jpm@tela-botanica.org">jpm@<!-- -->tela-botanica.org</a>><br> |
<b>Version:</b> |
$Id: Controleur.php 332 2011-03-22 16:54:23Z delphine $<br> |
<b>Link:</b> |
/doc/framework/<br> |
<b>Located at</b> <a href="source-class-Controleur.html#3-121" title="Go to source code">Controleur.php</a><br> |
</div> |
|
|
|
<table class="summary" id="methods"> |
<caption>Methods summary</caption> |
<tr data-order="__construct" id="___construct"> |
|
<td class="attributes"><code> |
public |
|
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#___construct">#</a> |
<code><a href="source-class-Controleur.html#38-47" title="Go to source code">__construct</a>( )</code> |
|
<div class="description short"> |
|
<p>Constructeur par défaut</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Constructeur par défaut</p> |
|
|
|
|
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="chargerModele" id="_chargerModele"> |
|
<td class="attributes"><code> |
final public |
boolean |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_chargerModele">#</a> |
<code><a href="source-class-Controleur.html#49-67" title="Go to source code">chargerModele</a>( <span>string <var>$nom_modele</var></span> )</code> |
|
<div class="description short"> |
|
<p>Charge un modele donné et le rend disponible sous la forme |
$this->nom_modele</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Charge un modele donné et le rend disponible sous la forme |
$this->nom_modele</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$nom_modele</var></dt> |
<dd><code>string</code><br>$nom_modele le nom du modèle à charger</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>boolean</code><br>false si le chargement a échoué, sinon true.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getModele" id="_getModele"> |
|
<td class="attributes"><code> |
final protected |
mixed |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getModele">#</a> |
<code><a href="source-class-Controleur.html#69-88" title="Go to source code">getModele</a>( <span>string <var>$nom_modele</var></span>, <span>String <var>$ext</var> = <span class="php-quote">'.php'</span></span> )</code> |
|
<div class="description short"> |
|
<p>Retourne un modele donné</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Retourne un modele donné</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$nom_modele</var></dt> |
<dd><code>string</code><br>$nom_modele le nom du fichier modèle à charger sans son extension</dd> |
<dt><var>$ext</var></dt> |
<dd><code>String</code><br>$ext l'extension du fichier du modèel (par défaut : ".php"</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>mixed</code><br>false si le chargement a échoué, sinon l'objet du modèle demandé.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="getVue" id="_getVue"> |
|
<td class="attributes"><code> |
final protected |
boolean |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_getVue">#</a> |
<code><a href="source-class-Controleur.html#90-107" title="Go to source code">getVue</a>( <span>String <var>$nom_squelette</var></span>, <span>Array <var>& $donnees</var> = <span class="php-keyword1">array</span>()</span>, <span>String <var>$ext</var> = <span class="php-quote">'.tpl.html'</span></span> )</code> |
|
<div class="description short"> |
|
<p>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.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>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.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$nom_squelette</var></dt> |
<dd><code>String</code><br>$nom_squelette le nom du squelette sans son extension</dd> |
<dt><var>$donnees</var></dt> |
<dd><code>Array</code><br>$donnees un tableau associatif contenant les variables a injecter dans la vue</dd> |
<dt><var>$ext</var></dt> |
<dd><code>String</code><br>$ext l'extension du fichier du squelette (par défaut : ".tpl.html"</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>boolean</code><br>false si la vue n'existe pas, sinon la chaine résultat.<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
<tr data-order="preTraiterDonnees" id="_preTraiterDonnees"> |
|
<td class="attributes"><code> |
protected |
Array |
|
</code> |
</td> |
|
<td class="name"><div> |
<a class="anchor" href="#_preTraiterDonnees">#</a> |
<code><a href="source-class-Controleur.html#109-120" title="Go to source code">preTraiterDonnees</a>( <span>Array <var>& $donnees</var></span> )</code> |
|
<div class="description short"> |
|
<p>Fonction prenant en paramètre un tableau de données et effectuant un |
traitement dessus. Cette fonction est à surcharger dans les classes filles pour |
automatiser un traitement avant chaque chargement de vue.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Fonction prenant en paramètre un tableau de données et effectuant un |
traitement dessus. Cette fonction est à surcharger dans les classes filles pour |
automatiser un traitement avant chaque chargement de vue.</p> |
|
|
|
<h4>Parameters</h4> |
<div class="list"><dl> |
<dt><var>$donnees</var></dt> |
<dd><code>Array</code><br>$donnees Le tableau de données à traiter</dd> |
</dl></div> |
|
<h4>Returns</h4> |
<div class="list"> |
<code>Array</code><br>$donnees Le tableau de données traité<br> |
</div> |
|
|
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
|
|
|
|
|
|
<table class="summary" id="properties"> |
<caption>Properties summary</caption> |
<tr data-order="parametres_obligatoires" id="$parametres_obligatoires"> |
<td class="attributes"><code> |
protected |
array |
</code></td> |
|
<td class="name"> |
<a href="source-class-Controleur.html#35-36" title="Go to source code"><var>$parametres_obligatoires</var></a> |
</td> |
<td class="value"><code><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>)</code></td> |
<td class="description"><div> |
<a href="#$parametres_obligatoires" class="anchor">#</a> |
|
<div class="description short"> |
|
<p>Tableau des noms des paramètres à définir dans le fichier de config car |
obligatoirement nécessaire à cette classe.</p> |
|
</div> |
|
<div class="description detailed hidden"> |
|
<p>Tableau des noms des paramètres à définir dans le fichier de config car |
obligatoirement nécessaire à cette classe.</p> |
|
|
</div> |
</div></td> |
</tr> |
</table> |
|
|
|
|
|
|
</div> |
|
<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> |