Subversion Repositories Applications.framework

Rev

Rev 414 | Rev 485 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
5 aurelien 1
<?php
105 aurelien 2
// declare(encoding='UTF-8');
5 aurelien 3
/**
151 jpm 4
 * Classe Controleur, coeur d'une application, c'est normalement la seule classe d'une application
129 aurelien 5
 * qui devrait être appelée de l'extérieur.
151 jpm 6
 * Elle est abstraite donc doit obligatoirement être étendue.
129 aurelien 7
 *
239 jpm 8
 * @category	php 5.2
9
 * @package	Framework
151 jpm 10
 * @author		Aurélien PERONNET <aurelien@tela-botanica.org>
11
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
239 jpm 12
 * @copyright	Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
13
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
14
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
15
 * @version	$Id: Controleur.php 415 2012-04-04 09:05:55Z jpm $
151 jpm 16
 * @link		/doc/framework/
129 aurelien 17
 *
18
 */
80 jpm 19
abstract class Controleur {
192 jpm 20
	/** Variable statique indiquant que les tableaux _GET et _POST ont déjà été encodé au format de l'appli. */
21
	private static $encodage = false;
196 aurelien 22
 
239 jpm 23
	/** Chemin de base vers les classes métiers de la partie Modèle de l'application. */
24
	private $base_chemin_modele = null;
414 jpm 25
 
239 jpm 26
	/** Chemin de base vers les fichiers squelette de la partie Vue de l'application. */
27
	private $base_chemin_squelette = null;
414 jpm 28
 
239 jpm 29
	/** Chemin de base vers les classes controleurs de la partie Controleur de l'application. */
30
	private $base_chemin_controleur = null;
414 jpm 31
 
241 jpm 32
	/** Objet URL contant l'url de la base de l'application. */
239 jpm 33
	private $base_url_applicaton = null;
120 aurelien 34
 
241 jpm 35
	/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/
36
	protected $parametres_obligatoires = array('chemin_modeles', 'chemin_squelettes', 'chemin_controleurs', 'base_url_application');
414 jpm 37
 
120 aurelien 38
	/**
39
	 * Constructeur par défaut
40
	 */
141 jpm 41
	public function __construct() {
241 jpm 42
		Config::verifierPresenceParametres($this->parametres_obligatoires);
414 jpm 43
 
241 jpm 44
		$this->base_chemin_modele = Config::get('chemin_modeles');
356 jpm 45
		if (Registre::existe('tbf.chemin_modeles')) {
46
			$this->base_chemin_modele = Registre::get('tbf.chemin_modeles');
47
		}
414 jpm 48
 
241 jpm 49
		$this->base_chemin_squelette = Config::get('chemin_squelettes');
356 jpm 50
		if (Registre::existe('tbf.chemin_squelettes')) {
414 jpm 51
			$this->base_chemin_squelette = Registre::get('tbf.chemin_squelettes');
356 jpm 52
		}
414 jpm 53
 
241 jpm 54
		$this->base_chemin_controleur = Config::get('chemin_controleurs');
356 jpm 55
		if (Registre::existe('tbf.chemin_controleurs')) {
414 jpm 56
			$this->base_chemin_squelette = Registre::get('tbf.chemin_controleurs');
356 jpm 57
		}
414 jpm 58
 
241 jpm 59
		$this->base_url_application = new Url(Config::get('base_url_application'));
120 aurelien 60
	}
414 jpm 61
 
364 jpm 62
	/**
63
	 * Permet de récupérer le chemin vers les squelettes.
414 jpm 64
	 *
364 jpm 65
	 * @return String $chemin chemin vers les squelettes
66
	 */
67
	protected function getCheminSquelette() {
68
		return $this->base_chemin_squelette;
69
	}
120 aurelien 70
 
71
	/**
364 jpm 72
	 * Permet de définir dynamiquement le chemin vers les squelettes.
414 jpm 73
	 *
364 jpm 74
	 * @param String $chemin chemin vers les squelettes
75
	 */
76
	protected function setCheminSquelette($chemin) {
77
		$this->base_chemin_squelette = $chemin;
78
	}
414 jpm 79
 
364 jpm 80
	/**
120 aurelien 81
	* Charge un modele donné et le rend disponible sous la forme $this->nom_modele
82
	*
165 aurelien 83
	* @param string $nom_modele le nom du modèle à  charger
120 aurelien 84
	*
165 aurelien 85
	* @return boolean false si le chargement a échoué, sinon true.
120 aurelien 86
	*/
414 jpm 87
	public function chargerModele($nom_modele) {
165 aurelien 88
		$sortie = true;
215 jpm 89
		if (!isset($this->$nom_modele)) {
90
			$modele = $this->getModele($nom_modele);
91
			if ($modele !== false) {
92
				$this->$nom_modele = new $nom_modele;
93
			} else {
94
				$sortie = false;
95
			}
120 aurelien 96
		}
165 aurelien 97
		return $sortie;
98
	}
162 aurelien 99
 
165 aurelien 100
	/**
101
	* Retourne un modele donné
102
	*
215 jpm 103
	* @param string $nom_modele	le nom du fichier modèle à charger sans son extension
356 jpm 104
	* @param String $ext		l'extension du fichier du modèle (par défaut : ".php")
165 aurelien 105
	*
106
	* @return mixed false si le chargement a échoué, sinon l'objet du modèle demandé.
107
	*/
414 jpm 108
	protected function getModele($nom_modele, $ext = '.php') {
165 aurelien 109
		$sortie = false;
414 jpm 110
 
192 jpm 111
		$chemin_modele = $this->registre->get('base_chemin_modele').$nom_modele.$ext;
165 aurelien 112
		if (file_exists($chemin_modele)) {
113
			include_once $chemin_modele;
114
			if (class_exists($nom_modele)) {
115
				$sortie = new $nom_modele;
116
			}
120 aurelien 117
		}
165 aurelien 118
		return $sortie;
120 aurelien 119
	}
162 aurelien 120
 
120 aurelien 121
	/**
122
	 * Fonction prenant en paramètre le nom d'un squelette et un tableau associatif de données,
151 jpm 123
	 * en extrait les variables, charge le squelette et retourne le résultat des deux combinés.
120 aurelien 124
	 *
414 jpm 125
	 * @param String $nom_squelette	le nom du squelette sans son extension si elle vaut ".tpl.html"
126
	 * @param Array  $donnees		un tableau associatif contenant les variables a injecter dans la vue
127
	 * @since 0.4 suppression du paramètre 'ext' => le mettre directement dans le nom du squelette
120 aurelien 128
	 *
151 jpm 129
	 * @return boolean false si la vue n'existe pas, sinon la chaine résultat.
120 aurelien 130
	 */
414 jpm 131
	protected function getVue($nom_squelette, $donnees = array()) {
172 aurelien 132
		$donnees = $this->preTraiterDonnees($donnees);
414 jpm 133
		$chemin_squelette = $this->base_chemin_squelette.$nom_squelette.'.tpl.html';
415 jpm 134
		if (file_exists($chemin_squelette) === false) {
414 jpm 135
			$chemin_squelette = $this->base_chemin_squelette.$nom_squelette;
136
		}
152 jpm 137
		$sortie = SquelettePhp::analyser($chemin_squelette, $donnees);
162 aurelien 138
 
151 jpm 139
		return $sortie;
140
	}
162 aurelien 141
 
151 jpm 142
	/**
166 aurelien 143
	 * Fonction prenant en paramètre un tableau de données et effectuant un traitement dessus.
165 aurelien 144
	 * Cette fonction est à surcharger dans les classes filles pour automatiser un traitement
145
	 * avant chaque chargement de vue.
146
	 *
147
	 * @param Array $donnees Le tableau de données à traiter
148
	 *
149
	 * @return Array $donnees Le tableau de données traité
150
	 */
212 jpm 151
	protected function preTraiterDonnees(&$donnees) {
162 aurelien 152
		return $donnees;
153
	}
5 aurelien 154
}
155
?>