Subversion Repositories eFlore/Applications.eflore-consultation

Rev

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

Rev Author Line No. Line
10 jpm 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Classe abstraite dont chaque controleur de l'application doit hériter.
5
 *
6
 * @category	PHP 5.2
7
 * @package		eflore-consultation
8
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
9
 * @author		Delphine CAUQUIL <delphine@tela-botanica.org>
10
 * @copyright	2011 Tela-Botanica
11
 * @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
12
 * @license		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
13
 * @version		$Id$
14
 */
15
abstract class aControleur extends Controleur {
11 jpm 16
 
17
	const META_TITRE = 'titre';
18
	const META_DESCRIPTION = 'description';
19
	const META_TAGS = 'tags';
20
	const RENDU_TETE = 'tete';
21
	const RENDU_CORPS = 'corps';
22
	const RENDU_PIED = 'pied';
14 jpm 23
	const RENDU_NAVIGATION = 'navigation';
24
	const RENDU_MENU = 'menu';
11 jpm 25
 
26
	private $sortie = array();
61 jpm 27
	protected $urlBase = null;
28
	protected $urlCourante = null;
11 jpm 29
 
37 jpm 30
	public function __construct()  {
34 jpm 31
		$chemin = Config::get('chemin_modules').
36 jpm 32
			AppControleur::getNomDossierDepuisClasse(get_class($this)).DS.
34 jpm 33
			Config::get('dossier_squelettes').DS;
34
		Registre::set('tbf.chemin_squelettes', $chemin);
61 jpm 35
 
36
		$this->urlBase = Registre::get('eFlore.urlBase');
37
		$this->urlCourante = Registre::get('eFlore.urlCourante');
38
		$this->urlRedirection = Registre::get('eFlore.urlRedirection');
39
 
11 jpm 40
		parent::__construct();
41
	}
42
 
61 jpm 43
	//+------------------------------------------------------------------------------------------------------+
44
	// GESTION de l'AFFICHAGE en SORTIE
45
 
11 jpm 46
	/**
47
 	* Attribue une position de sortie à un contenu.
48
 	*/
49
	protected function setSortie($position, $contenu, $fusionner = false) {
50
		if ($this->verifierExistenceTypeSortie($position)) {
51
			if ($fusionner) {
79 jpm 52
				if (isset($this->sortie[$position])) {
53
					$this->sortie[$position] .= $contenu;
54
				} else {
55
					$this->sortie[$position] = $contenu;
56
				}
11 jpm 57
			} else {
58
				$this->sortie[$position] = $contenu;
59
			}
60
		}
61
	}
62
 
63
	/**
64
	 * Vérifie l'existence du type de sortie indiqué pour son utilisation dans le tableau de sortie.
65
	 * @param string le type de sortie à tester.
66
	 * @return bool true si le type de sortie est valide, sinon false.
67
	 */
68
	private function verifierExistenceTypeSortie($type) {
69
		$existe = true;
70
		if ($type != self::RENDU_TETE &&
71
			$type != self::RENDU_CORPS &&
72
			$type != self::RENDU_PIED &&
14 jpm 73
			$type != self::RENDU_NAVIGATION &&
74
			$type != self::RENDU_MENU &&
11 jpm 75
			$type != self::META_TITRE &&
76
			$type != self::META_DESCRIPTION &&
77
			$type != self::META_TAGS) {
78
			trigger_error("Le type de sortie '$type' n'est pas une valeur prédéfinie.", E_USER_WARNING);
79
			$existe = false;
80
		}
81
		return $existe;
82
	}
83
 
84
	/**
85
	 * Retourne le tableau de sortie à utiliser dans le controleur principal de l'application.
86
	 */
87
	public function getSortie() {
88
		return $this->sortie;
89
	}
10 jpm 90
 
11 jpm 91
	/**
61 jpm 92
	 * Fusionne un tableau de sortie par défaut avec le tableau passé en paramêtre.
93
	 * @param array le tableau à fusionner
94
	 */
79 jpm 95
	private function fusionnerSortie($nouvelleSortie) {
96
		$sortieActuelle = $this->getSortie();
97
		foreach ($nouvelleSortie as $position => $nouveauContenu) {
98
			if ($nouveauContenu != '') {
99
				$contenuPrecedent = isset($sortieActuelle[$position]) ? $sortieActuelle[$position] : null;
100
				if ($nouveauContenu != $contenuPrecedent) {
101
					$this->setSortie($position, $nouveauContenu, true);
102
				}
103
			}
104
		}
61 jpm 105
	}
106
 
107
	/**
11 jpm 108
	 * Execute l'action d'un module donnée et fusionne le résultat avec le tableau de sortie.
41 jpm 109
	 * Permet à une action d'un module donnée de charger le résultat d'une autre action de module.
11 jpm 110
	 */
111
	protected function executerAction($ClasseModule, $action) {
112
		$module = new $ClasseModule();
79 jpm 113
		$sortiePrecedente = $this->getSortie();
83 jpm 114
		// Initialisation du module demandé
115
		if (method_exists($module, 'initialiser')) {
116
			$module->initialiser();
117
		}
118
		// Lancement de l'action demandé du module chargé
119
		if (method_exists($module, $action)) {
120
			$module->$action();
121
			$nouvelleSortie = $module->getSortie();
122
			$this->fusionnerSortie($nouvelleSortie);
123
		} else {
124
			$m = "La méthode '$action' du controleur '$ClasseModule' est introuvable.";
125
			trigger_error($m, E_USER_ERROR);
126
		}
11 jpm 127
	}
128
 
61 jpm 129
	//+------------------------------------------------------------------------------------------------------+
130
	// GESTION du VUES COMMUNES
11 jpm 131
	/**
41 jpm 132
	 * Charge un squelette de vue depuis l'emplacement commune.
133
	 * @param String $tpl le nom du squelette à charger sans l'extenssion de fichier.
134
	 * @param Array $donnees les données à passer au squelette PHP.
135
	 */
136
	private function getVueCommune($tpl, $donnees) {
137
		$cheminOrigine = $this->getCheminSquelette();
138
		$this->setCheminSquelette(Config::get('chemin_squelettes'));
139
		$vue = $this->getVue($tpl, $donnees);
140
		$this->setCheminSquelette($cheminOrigine);
141
		return $vue;
142
	}
143
 
144
	/**
11 jpm 145
	 * Pour mutualiser la création du pied de page de l'application, sa gestion est gérée dans cette classe.
146
	 */
47 jpm 147
	public function chargerEnteteGeneral() {
11 jpm 148
		$donnees['appli'] = Framework::getInfoAppli();
41 jpm 149
		$donnees['i18n'] = array_merge(I18n::get('Entete'), I18n::get('General'));
150
		$donnees['referentiel_titre'] = I18n::get('Referentiels-titres.'.Registre::get('parametres.referentiel'));
151
 
152
		$this->setSortie(self::RENDU_TETE, $this->getVueCommune('entete_page', $donnees));
153
	}
154
 
155
	/**
47 jpm 156
	 * Pour mutualiser la création du menu de l'application, sa gestion est gérée dans cette classe.
157
	 */
158
	public function chargerMenuGeneral() {
159
		$donnees['appli'] = Framework::getInfoAppli();
160
		$donnees['i18n'] = array_merge(I18n::get('Pied'), I18n::get('General'));
161
		$donnees['courrielContact'] = Config::get('courriel_contact');
162
 
163
		$this->setSortie(self::RENDU_MENU, $this->getVueCommune('menu', $donnees));
164
	}
165
 
166
	/**
41 jpm 167
	 * Pour mutualiser la création du pied de page de l'application, sa gestion est gérée dans cette classe.
168
	 */
47 jpm 169
	public function chargerPiedGeneral() {
41 jpm 170
		$donnees['appli'] = Framework::getInfoAppli();
27 jpm 171
		$donnees['i18n'] = array_merge(I18n::get('Pied'), I18n::get('General'));
41 jpm 172
		$donnees['courrielContact'] = Config::get('courriel_contact');
27 jpm 173
 
41 jpm 174
		$this->setSortie(self::RENDU_PIED, $this->getVueCommune('pied_page', $donnees));
11 jpm 175
	}
27 jpm 176
 
61 jpm 177
	//+------------------------------------------------------------------------------------------------------+
178
	// GESTION du CHARGEMENT des CLASSES MÉTIERS
179
	protected function getEfloreNoms() {
180
		if (! isset($this->EfloreNoms)) {
181
			$this->EfloreNoms = new Noms();
27 jpm 182
		}
61 jpm 183
		return $this->EfloreNoms;
184
	}
185
 
186
	protected function getEfloreTaxons() {
187
		if (! isset($this->EfloreTaxons)) {
188
			$this->EfloreTaxons = new Taxons();
189
		}
190
		return $this->EfloreTaxons;
191
	}
192
 
193
	//+------------------------------------------------------------------------------------------------------+
194
	// GESTION des URLs
195
	protected function obtenirUrlBase() {
196
		$url = $this->urlBase->getURL();
27 jpm 197
		return $url;
198
	}
61 jpm 199
 
69 delphine 200
	protected function redirigerVers($url) {
201
		$url = str_replace('&amp;', '&', $url);
202
		header("Location: $url");
203
	}
204
 
61 jpm 205
	private function getParametresUrlListe() {
206
		$parametres = array(
207
			'referentiel' => Registre::get('parametres.referentiel'),
208
			'module' => 'liste',
209
			'action' => 'liste',
210
			'rang' => $this->rang,
211
			'lettre' => $this->lettre
212
		);
213
		return $parametres;
214
	}
215
 
216
	protected function obtenirUrlListeFamille() {
217
		$parametres = $this->getParametresUrlListe();
218
		$parametres['rang'] = 'F';
219
		$this->urlBase->setRequete($parametres);
220
		$url = $this->urlBase->getURL();
221
		return $url;
222
	}
223
 
224
	protected function obtenirUrlListeGenre() {
225
		$parametres = $this->getParametresUrlListe();
226
		$parametres['rang'] = 'G';
227
		$this->urlBase->setRequete($parametres);
228
		$url = $this->urlBase->getURL();
229
		return $url;
230
	}
231
 
69 delphine 232
	private function getParametresUrlRecherche() {
233
		$parametres = array(
234
			'referentiel' => Registre::get('parametres.referentiel'),
76 delphine 235
			'module' => 'recherche',
236
			'action' => 'rechercheSimple',
69 delphine 237
			'submit' => 'Rechercher'
238
		);
239
		return $parametres;
240
	}
61 jpm 241
 
69 delphine 242
	protected function obtenirUrlRechercheSimple($nom = null, $type = 'nom_scientifique') {
243
		$parametres = $this->getParametresUrlRecherche();
244
		$parametres['type_nom'] = $type;
245
		$parametres['nom'] = $nom;
246
		$this->urlBase->setRequete($parametres);
247
		$url = $this->urlBase->getURL();
61 jpm 248
		return $url;
249
	}
69 delphine 250
 
83 jpm 251
	private function getParametresUrlResultat() {
252
		$parametres = array(
253
			'referentiel' => Registre::get('parametres.referentiel'),
254
			'module' => 'recherche',
255
			'action' => Registre::get('parametres.action'),
256
			'submit' => 'Rechercher',
257
			'type_nom' => isset($_GET['type_nom']) ? $_GET['type_nom'] : 'nom_scientifique',
258
			'nom' => isset($_GET['nom']) ? $_GET['nom'] : ''
259
		);
260
		return $parametres;
261
	}
262
 
263
	protected function obtenirUrlResultatClassique() {
264
		$parametres = $this->getParametresUrlResultat();
265
		$parametres['resultat'] = 'classique';
266
		$this->urlBase->setRequete($parametres);
267
		$url = $this->urlBase->getURL();
268
		return $url;
269
	}
270
 
271
	protected function obtenirUrlResultatRetenu() {
272
		$parametres = $this->getParametresUrlResultat();
273
		$parametres['resultat'] = 'retenu';
274
		$this->urlBase->setRequete($parametres);
275
		$url = $this->urlBase->getURL();
276
		return $url;
277
	}
278
 
95 delphine 279
	protected function obtenirUrlResultatDetermination() {
280
		$parametres = $this->getParametresUrlResultat();
281
		$parametres['resultat'] = 'determination';
282
		$this->urlBase->setRequete($parametres);
283
		$url = $this->urlBase->getURL();
284
		return $url;
285
	}
286
 
69 delphine 287
	private function getParametresUrlFiche() {
288
		$parametres = array(
289
			'referentiel' => Registre::get('parametres.referentiel'),
290
			'module' => 'fiche',
291
			'action' => 'fiche'
292
		);
293
		return $parametres;
294
	}
295
 
296
	protected function obtenirUrlFiche($numNom) {
297
		$parametres = $this->getParametresUrlFiche();
298
		$parametres['nn'] = $numNom;
299
		$this->urlBase->setRequete($parametres);
300
		$url = $this->urlBase->getURL();
301
		return $url;
302
	}
10 jpm 303
}
304
?>