Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 466 → Rev 467

/branches/v0.2-buhl/doc/ApiGen/class-Controleur.html
New file
0,0 → 1,478
<!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.2</title>
 
<script type="text/javascript" src="resources/combined.js?4205936287"></script>
<script type="text/javascript" src="elementlist.js?117657638"></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-PHP.html">PHP</a>
</li>
</ul>
</div>
 
<hr>
 
 
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Application.html">Application</a></li>
<li><a href="class-Chronometre.html">Chronometre</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-GestionnaireException.html">GestionnaireException</a></li>
<li><a href="class-Log.html">Log</a></li>
<li><a href="class-Modele.html">Modele</a></li>
<li><a href="class-Registre.html">Registre</a></li>
<li><a href="class-SquelettePhp.html">SquelettePhp</a></li>
<li><a href="class-Url.html">Url</a></li>
</ul>
 
 
 
 
 
<h3>Functions</h3>
<ul>
<li><a href="function-autoloadAppliDefaut.html">autoloadAppliDefaut</a></li>
<li><a href="function-autoloadFw.html">autoloadFw</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>
php5<br>
<b>Copyright:</b>
2009 Tela-Botanica<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 &lt;<a
href="mailto:aurelien&#64;tela-botanica.org">aurelien&#64;<!-- -->tela-botanica.org</a>&gt;<br>
<b>Author:</b>
Jean-Pascal MILCENT &lt;<a
href="mailto:jpm&#64;tela-botanica.org">jpm&#64;<!-- -->tela-botanica.org</a>&gt;<br>
<b>Version:</b>
SVN: $Id: Controleur.php 191 2010-04-29 15:34:49Z jpm $<br>
<b>Link:</b>
/doc/framework/<br>
<b>Located at</b> <a href="source-class-Controleur.html#3-138" 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#26-36" 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 protected
boolean
</code>
</td>
 
<td class="name"><div>
<a class="anchor" href="#_chargerModele">#</a>
<code><a href="source-class-Controleur.html#38-54" 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-&gt;nom_modele</p>
 
</div>
 
<div class="description detailed hidden">
<p>Charge un modele donné et le rend disponible sous la forme
$this-&gt;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#56-74" 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#76-92" 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#94-105" 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>
<tr data-order="verifierEtReencoderTableauRequete" id="_verifierEtReencoderTableauRequete">
 
<td class="attributes"><code>
protected
</code>
</td>
 
<td class="name"><div>
<a class="anchor" href="#_verifierEtReencoderTableauRequete">#</a>
<code><a href="source-class-Controleur.html#107-116" title="Go to source code">verifierEtReencoderTableauRequete</a>( )</code>
 
<div class="description short">
<p>Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les
transcodant dans l'encodage de l'application</p>
 
</div>
 
<div class="description detailed hidden">
<p>Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les
transcodant dans l'encodage de l'application</p>
 
 
 
 
 
 
 
 
</div>
</div></td>
</tr>
<tr data-order="encoderTableau" id="_encoderTableau">
 
<td class="attributes"><code>
final protected
Array
</code>
</td>
 
<td class="name"><div>
<a class="anchor" href="#_encoderTableau">#</a>
<code><a href="source-class-Controleur.html#118-137" title="Go to source code">encoderTableau</a>( <span>mixed <var>$tableau</var></span>, <span>mixed <var>$encodage_sortie</var></span>, <span>mixed <var>$encodage_entree</var> = <span class="php-keyword1">null</span></span> )</code>
 
<div class="description short">
<p>Fonction récursive transcodant toutes les valeurs d'un tableau de leur
encodage d'entrée vers un encodage de sortie donné</p>
 
</div>
 
<div class="description detailed hidden">
<p>Fonction récursive transcodant toutes les valeurs d'un tableau de leur
encodage d'entrée vers un encodage de sortie donné</p>
 
 
 
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$tableau</var></dt>
<dd><code>mixed</code><br>$tableau Array Un tableau de données à encoder</dd>
<dt><var>$encodage_sortie</var></dt>
<dd><code>mixed</code><br>$encodage_sortie String l'encodage vers lequel on doit transcoder</dd>
<dt><var>$encodage_entree</var></dt>
<dd><code>mixed</code><br>$encodage_entree String l'encodage original des chaines du tableau (optionnel)</dd>
</dl></div>
 
<h4>Returns</h4>
<div class="list">
<code>Array</code><br>Le tableau encodé dans l'encodage de sortie<br>
</div>
 
 
 
 
</div>
</div></td>
</tr>
</table>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
</div>
 
<div id="footer">
TBFramework - v0.2 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>