Subversion Repositories Applications.framework

Compare Revisions

Ignore whitespace Rev 302 → Rev 303

/tags/v0.3-aleaume/doc/HTMLframesConverter/Framework/Controleur.html
New file
0,0 → 1,411
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Controleur</title>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'/>
<link rel="stylesheet" href="../media/stylesheet.css" />
<script src="../media/lib/classTree.js"></script>
<script language="javascript" type="text/javascript">
var imgPlus = new Image();
var imgMinus = new Image();
imgPlus.src = "../media/images/plus.png";
imgMinus.src = "../media/images/minus.png";
function showNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgMinus.src;
oTable.style.display = "block";
}
function hideNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgPlus.src;
oTable.style.display = "none";
}
function nodeIsVisible(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
break;
}
return (oTable && oTable.style.display == "block");
}
function toggleNodeVisibility(Node){
if (nodeIsVisible(Node)){
hideNode(Node);
}else{
showNode(Node);
}
}
</script>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Controleur</h2>
 
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<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">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-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.</p>
<p class="description"><p>Elle est abstraite donc doit obligatoirement être étendue.</p></p>
<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> $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>
<li><span class="field">license:</span> <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt">Licence CECILL</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_Controleur.php.html">/Controleur.php</a> (line <span class="field"><a href="../__filesource/fsource_Framework__Controleur.php.html#a19">19</a></span>)
</p>
<pre></pre>
</div>
</div>
 
 
 
<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">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</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">
<div class="method-definition">
<span class="method-result">Controleur</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#chargerModele" title="details" class="method-name">chargerModele</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</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">$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"></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-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="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#a41">41</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructeur par défaut</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Controleur</span>
<span class="method-name">
__construct
</span>
()
</div>
</div>
<a name="methodchargerModele" id="chargerModele"><!-- --></a>
<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#a56">56</a></span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
chargerModele
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$nom_modele</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>
</ul>
</div>
<a name="methodgetModele" id="getModele"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<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">Retourne un modele donné</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">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
getModele
</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">$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="methodgetVue" id="getVue"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<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">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 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">boolean</span>
<span class="method-name">
getVue
</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_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="methodpreTraiterDonnees" id="preTraiterDonnees"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<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 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> Le tableau de données traité</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">Array</span>
<span class="method-name">
preTraiterDonnees
</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">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"></span>
<span class="var-name">&$donnees</span> </li>
</ul>
</div>
</div>
</div>
 
 
<p class="notes" id="credit">
Documentation generated on Tue, 18 Jan 2011 15:30:47 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>