Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 296 → Rev 297

/trunk/doc/HTMLframesConverter/Framework/Controleur.html
93,7 → 93,8
<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>)
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
103,8 → 104,8
<ul class="tags">
<li><span class="field">author:</span> Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
<li><span class="field">author:</span> Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</li>
<li><span class="field">version:</span> SVN: $$Id: Controleur.php 158 2010-03-04 17:14:36Z jpm $$</li>
<li><span class="field">copyright:</span> 2009 Tela-Botanica</li>
<li><span class="field">version:</span> $Id: Controleur.php 241 2010-12-06 15:19:07Z jpm $</li>
<li><span class="field">copyright:</span> Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</li>
<li><span class="field">link:</span> /doc/framework/</li>
<li><span class="field">abstract:</span> </li>
<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></li>
122,6 → 123,25
 
 
 
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$parametres_obligatoires" title="details" class="var-name">$parametres_obligatoires</a>
</div>
</div>
</div>
</div>
 
<a name="sec-method-summary"></a>
<div class="info-box">
128,7 → 148,10
<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>)
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
146,42 → 169,82
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#chargerVue" title="details" class="method-name">chargerVue</a>
(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#getModele" title="details" class="method-name">getModele</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>)
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>, [<span class="var-type">String</span>&nbsp;<span class="var-name">$ext</span> = <span class="var-default">'.php'</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#getVue" title="details" class="method-name">getVue</a>
(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span> = <span class="var-default">array()</span>])
(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$donnees</span> = <span class="var-default">array()</span>], [<span class="var-type">String</span>&nbsp;<span class="var-name">$ext</span> = <span class="var-default">'.tpl.html'</span>], <span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span>)
</div>
<div class="method-definition">
<span class="method-result">Array</span>
<a href="#preTraiterDonnees" title="details" class="method-name">preTraiterDonnees</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">&$donnees</span>, <span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span>)
</div>
</div>
</div>
</div>
 
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$parametres_obligatoires" id="$parametres_obligatoires"><!-- --></A>
<div class="oddrow">
 
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$parametres_obligatoires</span>
= <span class="var-default">array('chemin_modeles', 'chemin_squelettes', 'chemin_controleurs', 'base_url_application')</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a36">36</a></span>)
</span>
</div>
 
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
 
</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>)
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a28">28</a></span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a41">41</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
202,10 → 265,10
</div>
<a name="methodchargerModele" id="chargerModele"><!-- --></a>
<div class="evenrow">
<div class="oddrow">
<div class="method-header">
<span class="method-title">chargerModele</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a47">47</a></span>)
<span class="method-title">chargerModele</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a56">56</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
212,7 → 275,7
<p class="short-description">Charge un modele donné et le rend disponible sous la forme $this-&gt;nom_modele</p>
<ul class="tags">
<li><span class="field">return:</span> false si le chargement a échoué, sinon true.</li>
<li><span class="field">access:</span> protected</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
226,103 → 289,113
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$nom_modele</span><span class="var-description">: le nom du modèle à charger</span> </li>
<span class="var-name">$nom_modele</span><span class="var-description">: le nom du modèle à  charger</span> </li>
</ul>
</div>
<a name="methodchargerVue" id="chargerVue"><!-- --></a>
<div class="oddrow">
<a name="methodgetModele" id="getModele"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">chargerVue</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a102">102</a></span>)
<span class="method-title">getModele</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a77">77</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">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 crée une variable de classe portant le nom du squelette contenant les deux combinés.</p>
<p class="short-description">Retourne un modele donné</p>
<ul class="tags">
<li><span class="field">return:</span> false si la vue n'existe pas, sinon true.</li>
<li><span class="field">return:</span> false si le chargement a échoué, sinon l'objet du modèle demandé.</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-result">mixed</span>
<span class="method-name">
chargerVue
getModele
</span>
(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span> = <span class="var-default">array()</span>])
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>, [<span class="var-type">String</span>&nbsp;<span class="var-name">$ext</span> = <span class="var-default">'.php'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$nom_modele</span><span class="var-description">: le nom du fichier modèle à charger sans son extension</span> </li>
<li>
<span class="var-type">String</span>
<span class="var-name">$nom_squelette</span><span class="var-description">: le nom du squelette</span> </li>
<li>
<span class="var-type">Array</span>
<span class="var-name">$donnees</span><span class="var-description">: un tableau associatif contenant les variables a injecter dans la vue</span> </li>
<span class="var-name">$ext</span><span class="var-description">: l'extension du fichier du modèel (par défaut : &quot;.php&quot;</span> </li>
</ul>
</div>
<a name="methodgetModele" id="getModele"><!-- --></a>
<div class="evenrow">
<a name="methodgetVue" id="getVue"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getModele</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a65">65</a></span>)
<span class="method-title">getVue</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a100">100</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retourne un modele donné</p>
<p class="short-description">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>
<ul class="tags">
<li><span class="field">return:</span> false si le chargement a échoué, sinon l'objet du modèle demandé.</li>
<li><span class="field">return:</span> false si la vue n'existe pas, sinon la chaine résultat.</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-result">boolean</span>
<span class="method-name">
getModele
getVue
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</span>)
(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$donnees</span> = <span class="var-default">array()</span>], [<span class="var-type">String</span>&nbsp;<span class="var-name">$ext</span> = <span class="var-default">'.tpl.html'</span>], <span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$nom_modele</span><span class="var-description">: le nom du modèle à charger</span> </li>
<span class="var-type">String</span>
<span class="var-name">$nom_squelette</span><span class="var-description">: le nom du squelette sans son extension</span> </li>
<li>
<span class="var-type">Array</span>
<span class="var-name">$donnees</span><span class="var-description">: un tableau associatif contenant les variables a injecter dans la vue</span> </li>
<li>
<span class="var-type">String</span>
<span class="var-name">$ext</span><span class="var-description">: l'extension du fichier du squelette (par défaut : &quot;.tpl.html&quot;</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$donnees</span> </li>
</ul>
</div>
<a name="methodgetVue" id="getVue"><!-- --></a>
<div class="oddrow">
<a name="methodpreTraiterDonnees" id="preTraiterDonnees"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getVue</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a86">86</a></span>)
<span class="method-title">preTraiterDonnees</span> (line <span class="line-number"><a href="../__filesource/fsource_Framework__Controleur.php.html#a118">118</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">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>
<p class="short-description">Fonction prenant en paramètre un tableau de données et effectuant un traitement dessus.</p>
<p class="description"><p>Cette fonction est à surcharger dans les classes filles pour automatiser un traitement avant chaque chargement de vue.</p></p>
<ul class="tags">
<li><span class="field">return:</span> false si la vue n'existe pas, sinon la chaine résultat.</li>
<li><span class="field">return:</span> Le tableau de données traité</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-result">Array</span>
<span class="method-name">
getVue
preTraiterDonnees
</span>
(<span class="var-type">String</span>&nbsp;<span class="var-name">$nom_squelette</span>, [<span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span> = <span class="var-default">array()</span>])
(<span class="var-type"></span>&nbsp;<span class="var-name">&$donnees</span>, <span class="var-type">Array</span>&nbsp;<span class="var-name">$donnees</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">String</span>
<span class="var-name">$nom_squelette</span><span class="var-description">: le nom du squelette</span> </li>
<span class="var-type">Array</span>
<span class="var-name">$donnees</span><span class="var-description">: Le tableau de données à traiter</span> </li>
<li>
<span class="var-type">Array</span>
<span class="var-name">$donnees</span><span class="var-description">: un tableau associatif contenant les variables a injecter dans la vue</span> </li>
<span class="var-type"></span>
<span class="var-name">&$donnees</span> </li>
</ul>
333,7 → 406,7
 
 
<p class="notes" id="credit">
Documentation generated on Thu, 04 Mar 2010 19:27:20 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Tue, 18 Jan 2011 15:01:30 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>