Subversion Repositories Applications.framework

Rev

Rev 302 | Blame | Compare with Previous | Last modification | View Log | RSS feed

<html>
<head>
<title>Docs For Class Controleur</title>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">Framework</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
        
                                    
                                                                                  [ <a href="../classtrees_Framework.html" class="menu">class tree: Framework</a> ]
                  [ <a href="../elementindex_Framework.html" class="menu">index: Framework</a> ]
                            [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
        <div id="todolist">
                        <p><a href="../todolist.html">Todo List</a></p>
        </div>
      <b>Packages:</b><br />
              <a href="../li_Framework.html">Framework</a><br />
              <a href="../li_Utilitaire.html">Utilitaire</a><br />
              <a href="../li_Zend_OpenId.html">Zend_OpenId</a><br />
            <br /><br />
                        <b>Files:</b><br />
          <div class="package">
                        <a href="../Framework/_Bdd.php.html">           Bdd.php
                </a><br>
                        <a href="../Framework/_Cache.php.html">         Cache.php
                </a><br>
                        <a href="../Framework/_CacheFichier.php.html">          CacheFichier.php
                </a><br>
                        <a href="../Framework/_CacheSimple.php.html">           CacheSimple.php
                </a><br>
                        <a href="../Framework/_CacheSqlite.php.html">           CacheSqlite.php
                </a><br>
                        <a href="../Framework/_Chronometre.php.html">           Chronometre.php
                </a><br>
                        <a href="../Framework/_Cli.php.html">           Cli.php
                </a><br>
                        <a href="../Framework/_Config.php.html">                Config.php
                </a><br>
                        <a href="../Framework/_Controleur.php.html">            Controleur.php
                </a><br>
                        <a href="../Framework/_Debug.php.html">         Debug.php
                </a><br>
                        <a href="../Framework/_utilitaires---DiffieHellmanUtil.php.html">               DiffieHellmanUtil.php
                </a><br>
                        <a href="../Framework/_Framework.php.html">             Framework.php
                </a><br>
                        <a href="../Framework/_GestionnaireException.php.html">         GestionnaireException.php
                </a><br>
                        <a href="../Framework/_I18n.php.html">          I18n.php
                </a><br>
                        <a href="../Framework/_Log.php.html">           Log.php
                </a><br>
                        <a href="../Framework/_OpenIdClient.php.html">          OpenIdClient.php
                </a><br>
                        <a href="../Framework/_Registre.php.html">              Registre.php
                </a><br>
                        <a href="../Framework/_RestClient.php.html">            RestClient.php
                </a><br>
                        <a href="../Framework/_RestServeur.php.html">           RestServeur.php
                </a><br>
                        <a href="../Framework/_RestService.php.html">           RestService.php
                </a><br>
                        <a href="../Framework/_Script.php.html">                Script.php
                </a><br>
                        <a href="../Framework/_SquelettePhp.php.html">          SquelettePhp.php
                </a><br>
                        <a href="../Framework/_Url.php.html">           Url.php
                </a><br>
          </div><br />
      
      
            <b>Classes:</b><br />
        <div class="package">
                                <a href="../Framework/Bdd.html">Bdd</a><br />
                        <a href="../Framework/Cache.html">Cache</a><br />
                        <a href="../Framework/CacheFichier.html">CacheFichier</a><br />
                        <a href="../Framework/CacheSimple.html">CacheSimple</a><br />
                        <a href="../Framework/CacheSqlite.html">CacheSqlite</a><br />
                        <a href="../Framework/Chronometre.html">Chronometre</a><br />
                        <a href="../Framework/Cli.html">Cli</a><br />
                        <a href="../Framework/Config.html">Config</a><br />
                        <a href="../Framework/Controleur.html">Controleur</a><br />
                        <a href="../Framework/Debug.html">Debug</a><br />
                        <a href="../Framework/DiffieHellmanUtil.html">DiffieHellmanUtil</a><br />
                        <a href="../Framework/Framework.html">Framework</a><br />
                        <a href="../Framework/GestionnaireException.html">GestionnaireException</a><br />
                        <a href="../Framework/I18n.html">I18n</a><br />
                        <a href="../Framework/Log.html">Log</a><br />
                        <a href="../Framework/OpenIdClient.html">OpenIdClient</a><br />
                        <a href="../Framework/Registre.html">Registre</a><br />
                        <a href="../Framework/RestClient.html">RestClient</a><br />
                        <a href="../Framework/RestServeur.html">RestServeur</a><br />
                        <a href="../Framework/RestService.html">RestService</a><br />
                        <a href="../Framework/Script.html">Script</a><br />
                        <a href="../Framework/SquelettePhp.html">SquelettePhp</a><br />
                        <a href="../Framework/Url.html">Url</a><br />
          </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: Controleur</h1>
Source Location: /Controleur.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">Classe Controleur, coeur d'une application, c'est normalement la seule classe d'une application  qui devrait être appelée de l'extérieur.</div><br /><br />
<h4>Author(s):</h4>
<ul>
          <li>Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</li>
              <li>Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</li>
                                          </ul>




            
          
                  
<h4>Version:</h4>
<ul>
  <li>$Id: Controleur.php 241 2010-12-06 15:19:07Z jpm $</li>
</ul>

<h4>Copyright:</h4>
<ul>
  <li>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</li>
</ul>
        
</td>

<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
    <li><a href="../Framework/Controleur.html#var$parametres_obligatoires">$parametres_obligatoires</a></li>
  </ul>
</td>


<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../Framework/Controleur.html#method__construct">__construct</a></li>
    <li><a href="../Framework/Controleur.html#methodchargerModele">chargerModele</a></li>
    <li><a href="../Framework/Controleur.html#methodgetModele">getModele</a></li>
    <li><a href="../Framework/Controleur.html#methodgetVue">getVue</a></li>
    <li><a href="../Framework/Controleur.html#methodpreTraiterDonnees">preTraiterDonnees</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>






</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a19">19</a>]<br />
Classe Controleur, coeur d'une application, c'est normalement la seule classe d'une application  qui devrait être appelée de l'extérieur.<br /><br /><p>Elle est abstraite donc doit obligatoirement être étendue.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Jean-Pascal MILCENT &lt;<a href="mailto:jpm@tela-botanica.org">jpm@tela-botanica.org</a>&gt;</td>
  </tr>
  <tr>
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Aurélien PERONNET &lt;<a href="mailto:aurelien@tela-botanica.org">aurelien@tela-botanica.org</a>&gt;</td>
  </tr>
  <tr>
    <td><b>version:</b>&nbsp;&nbsp;</td><td>$Id: Controleur.php 241 2010-12-06 15:19:07Z jpm $</td>
  </tr>
  <tr>
    <td><b>copyright:</b>&nbsp;&nbsp;</td><td>Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)</td>
  </tr>
  <tr>
    <td><b>link:</b>&nbsp;&nbsp;</td><td>/doc/framework/</td>
  </tr>
  <tr>
    <td><b>abstract:</b>&nbsp;&nbsp;</td><td></td>
  </tr>
  <tr>
    <td><b>license:</b>&nbsp;&nbsp;</td><td><a href="http://www.gnu.org/licenses/gpl.html">Licence GNU-GPL</a></td>
  </tr>
  <tr>
    <td><b>license:</b>&nbsp;&nbsp;</td><td><a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></td>
  </tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />

<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
        <a name="var$parametres_obligatoires"></a>
        <p></p>
        <h4>$parametres_obligatoires = <span class="value">array('chemin_modeles',&nbsp;'chemin_squelettes',&nbsp;'chemin_controleurs',&nbsp;'base_url_application')</span></h4>
        <p>[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a36">36</a>]</p>
  Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>

  <br />
        <div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>mixed</td>
    </tr>
      </table>
        </div><br /><br />
        <div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />

<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">

  <hr />
        <a name="method__construct"></a>
        <h3>constructor __construct <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a41">41</a>]</span></h3>
        <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
                <code>Controleur __construct(
)</code>
    </td></tr></table>
    </td></tr></table><br />
        
                Constructeur par défaut<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

        
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
        <a name="methodchargerModele"></a>
        <h3>method chargerModele <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a56">56</a>]</span></h3>
        <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
                <code>boolean chargerModele(
string
$nom_modele)</code>
    </td></tr></table>
    </td></tr></table><br />
        
                Charge un modele donné et le rend disponible sous la forme $this-&gt;nom_modele<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>false si le chargement a échoué, sinon true.</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

        
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$nom_modele</b>&nbsp;&nbsp;</td>
        <td>le nom du modèle à  charger</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
        <a name="methodgetModele"></a>
        <h3>method getModele <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a77">77</a>]</span></h3>
        <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
                <code>mixed getModele(
string
$nom_modele, [String
$ext = '.php'])</code>
    </td></tr></table>
    </td></tr></table><br />
        
                Retourne un modele donné<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>false si le chargement a échoué, sinon l'objet du modèle demandé.</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

        
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$nom_modele</b>&nbsp;&nbsp;</td>
        <td>le nom du fichier modèle à charger sans son extension</td>
      </tr>
          <tr>
        <td class="type">String&nbsp;&nbsp;</td>
        <td><b>$ext</b>&nbsp;&nbsp;</td>
        <td>l'extension du fichier du modèel (par défaut : &quot;.php&quot;</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
        <a name="methodgetVue"></a>
        <h3>method getVue <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a100">100</a>]</span></h3>
        <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
                <code>boolean getVue(
String
$nom_squelette, [
&$donnees = array()], [String
$ext = '.tpl.html'], Array
$donnees)</code>
    </td></tr></table>
    </td></tr></table><br />
        
                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.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>false si la vue n'existe pas, sinon la chaine résultat.</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

        
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">String&nbsp;&nbsp;</td>
        <td><b>$nom_squelette</b>&nbsp;&nbsp;</td>
        <td>le nom du squelette sans son extension</td>
      </tr>
          <tr>
        <td class="type">Array&nbsp;&nbsp;</td>
        <td><b>$donnees</b>&nbsp;&nbsp;</td>
        <td>un tableau associatif contenant les variables a injecter dans la vue</td>
      </tr>
          <tr>
        <td class="type">String&nbsp;&nbsp;</td>
        <td><b>$ext</b>&nbsp;&nbsp;</td>
        <td>l'extension du fichier du squelette (par défaut : &quot;.tpl.html&quot;</td>
      </tr>
          <tr>
        <td class="type">&nbsp;&nbsp;</td>
        <td><b>&$donnees</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
        <a name="methodpreTraiterDonnees"></a>
        <h3>method preTraiterDonnees <span class="smalllinenumber">[line <a href="../__filesource/fsource_Framework__Controleur.php.html#a118">118</a>]</span></h3>
        <div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
                <code>Array preTraiterDonnees(

&$donnees, Array
$donnees)</code>
    </td></tr></table>
    </td></tr></table><br />
        
                Fonction prenant en paramètre un tableau de données et effectuant un traitement dessus.<br /><br /><p>Cette fonction est à surcharger dans les classes filles pour automatiser un traitement  avant chaque chargement de vue.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>Le tableau de données traité</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
</div>
<br /><br />

        
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">Array&nbsp;&nbsp;</td>
        <td><b>$donnees</b>&nbsp;&nbsp;</td>
        <td>Le tableau de données à traiter</td>
      </tr>
          <tr>
        <td class="type">&nbsp;&nbsp;</td>
        <td><b>&$donnees</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
                    <hr />
                    Documentation generated on Tue, 18 Jan 2011 15:31:15 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
              </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>