Subversion Repositories eFlore/Applications.eflore-consultation

Compare Revisions

Ignore whitespace Rev 1393 → Rev 1394

/tags/v5.9-van-tieghem/controleurs/AppControleur.php
New file
0,0 → 1,339
<?php
// declare(encoding='UTF-8');
/**
* AppControleur est le controlleur principal de l'application.
* Elle repartie les demandes utilisateurs dans les différents modules, executent les actions et redistribue le code
* html dans les différentes fonctions d'affichage.
* C'est une Singleton.
*
* @category PHP 5.2
* @package eflore-consultation
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
* @author Delphine CAUQUIL <delphine@tela-botanica.org>
* @copyright 2011 Tela-Botanica
* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
* @version $Id$
*/
 
class AppControleur extends Controleur {
 
/**
* Instance de la classe pointant sur elle même (pour le pattern singleton)
*/
private static $instance = null;
 
/**
* Paramètres d'AppControleur
*/
private static $parametres = array();
 
/**
* Constructeur vide
*/
public function __construct() {
$sortie = array(
'titre' => '', 'description' => '', 'tags' => '',
'entete' => '', 'tags' => '',
'corps' => '', 'tete' => '', 'pied' => '',
'navigation' => '', 'menu' => '');
 
self::$parametres = array(
'referentiel' => Config::get('referentiel_defaut'),
'module' => Config::get('module_defaut'),
'action' => Config::get('action_defaut'),
'niveau' => Config::get('niveau_defaut'),
'sortie' => $sortie);
parent::__construct();
}
 
/**
* Initialisation du controleur principal en fonction des paramêtres de l'url.
*/
public static function initialiser() {
self::verifierCreationInstance();
self::gererSession();
 
self::nettoyerGet();
self::capturerParametres();
self::initialiserRegistre();
self::chargerConfigReferentiel();
 
spl_autoload_register(array(get_class(), 'chargerClasse'));
 
self::executerModule();
}
 
// "public" pour pouvoir être appelée distinctememnt de "initialiser" lors des tests PHPUnit
public static function verifierCreationInstance() {
if (empty(self::$instance)) {
self::$instance = new AppControleur();
}
}
 
private static function gererSession() {
if (Config::get('session_demarrage')) {
// Attribution d'un nom à la session
session_name(Config::get('session_nom'));
// Démarrage de la session
session_start();
}
}
 
private static function nettoyerGet() {
foreach ($_GET as $cle => $valeur) {
$verifier = array('NULL', "\n", "\r", "\\", "'", '"', "\x00", "\x1a", ';');
$_GET[$cle] = strip_tags(str_replace($verifier, '', $valeur));
}
}
 
private static function capturerParametres() {
if (isset($_GET['referentiel'])) {
self::$parametres['referentiel'] = $_GET['referentiel'];
}
if (isset($_GET['module'])) {
self::$parametres['module'] = $_GET['module'];
}
if (isset($_GET['action'])) {
self::$parametres['action'] = $_GET['action'];
}
if (isset($_GET['niveau'])) {
self::$parametres['niveau'] = $_GET['niveau'];
}
}
 
// "public" pour pouvoir être appelée distinctememnt de "initialiser" lors des tests PHPUnit
public static function initialiserRegistre() {
Registre::set('eFlore.urlBase', new Url(Config::get('base_url_application_index')));
Registre::set('eFlore.urlBaseDossier', new Url(Config::get('base_url_application')));
Registre::set('eFlore.urlCourante', self::getUrlCourante());
Registre::set('eFlore.urlRedirection', self::getUrlRedirection());
Registre::set('eFlore.urlPopUp', new Url(Config::get('base_url_application_popup')));
Registre::set('eFlore.urlMobileTpl', Config::get('base_url_mobile'));
 
Registre::set('parametres.referentiel', self::$parametres['referentiel']);
Registre::set('parametres.module', self::$parametres['module']);
Registre::set('parametres.action', self::$parametres['action']);
Registre::set('parametres.niveau', self::$parametres['niveau']);
}
 
private static function chargerConfigReferentiel() {
$chemin = Config::get('chemin_configurations').strtolower(self::$parametres['referentiel']).'.ini';
Config::charger($chemin);
}
 
private static function getUrlCourante() {
$url = false;
if (isset($_SERVER['REQUEST_URI'])) {
$url = $_SERVER['REQUEST_URI'];
}
return ($url) ? new Url($url) : $url;
}
 
private static function getUrlRedirection() {
$url = false;
if (isset($_SERVER['REDIRECT_URL']) && !empty($_SERVER['REDIRECT_URL'])) {
if (isset($_SERVER['REDIRECT_QUERY_STRING']) && !empty($_SERVER['REDIRECT_QUERY_STRING'])) {
$url = $_SERVER['REDIRECT_URL'].'?'.$_SERVER['REDIRECT_QUERY_STRING'];
} else {
$url = $_SERVER['REDIRECT_URL'];
}
}
return ($url) ? new Url($url) : $url;
}
 
private static function chargerClasse($nom_classe) {
$dossiers_classes = array(
Config::get('chemin_modules').self::getNomDossierModuleCourrant().DS,
Config::get('chemin_modules').self::getNomDossierDepuisClasse($nom_classe).DS,
Config::get('chemin_modeles').'api_0.1'.DS);
 
foreach ($dossiers_classes as $chemin) {
$fichier_a_tester = $chemin.$nom_classe.'.php';
if (file_exists($fichier_a_tester)) {
include_once $fichier_a_tester;
return null;
}
}
}
 
public static function getNomDossierDepuisParametre($parametre) {
$dossier = str_replace('-', '_', strtolower($parametre));
return $dossier;
}
 
public static function getNomDossierDepuisClasse($nomClasse) {
$dossier = str_replace(' ', '_', strtolower(preg_replace('/(?<!^)([A-Z])/',' $0', $nomClasse)));
return $dossier;
}
 
private static function getNomDossierModuleCourrant() {
$dossier = self::getNomDossierDepuisParametre(self::$parametres['module']);
return $dossier;
}
 
private static function getNomClasseModule() {
$dossier = str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower(self::$parametres['module']))));
return $dossier;
}
 
private static function getNomMethodeAction() {
$methode = 'executer'.
str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower(self::$parametres['action']))));
return $methode;
}
 
private static function executerModule() {
$classeModule = self::getNomClasseModule();
$action = self::getNomMethodeAction();
// Nous vérifions que le module existe
if (class_exists($classeModule)) {
$module = new $classeModule();
 
// Chargement Entete et Pied de page par défaut
$module->chargerEnteteGeneral();
$module->chargerMenuGeneral();
$module->chargerPiedGeneral();
 
// Initialisation du module demandé
if (method_exists($module, 'initialiser')) {
$module->initialiser();
}
// Lancement de l'action demandé du module chargé
if (method_exists($module, $action)) {
$module->$action();
} else {
$m = "La méthode '$action' du controleur '$classeModule' est introuvable.";
trigger_error($m, E_USER_ERROR);
}
 
self::fusionnerSortie($module->getSortie());
} else {
$m = "La classe du controleur '$classeModule' est introuvable.";
trigger_error($m, E_USER_ERROR);
}
}
 
/**
* Fusionne un tableau de sortie par défaut avec le tableau renvoyé par l'action du module.
* @param array le tableau à fusionner
*/
private static function fusionnerSortie($sortie) {
self::$parametres['sortie'] = array_merge(self::$parametres['sortie'], $sortie);
}
 
/**
* Retourne le titre du contenu de l'application.
*/
public static function getMetaTitre() {
$contenu = self::$parametres['sortie']['titre'];
$sortie = self::convertirEncodage($contenu);
return $sortie;
}
 
/**
* Retourne la description du contenu de l'application.
*/
public static function getMetaDescription() {
$contenu = self::$parametres['sortie']['description'];
$sortie = self::convertirEncodage($contenu);
return $sortie;
}
 
/**
* Retourne les mots-clés (tags) du contenu de l'application.
*/
public static function getMetaTags() {
$contenu = self::$parametres['sortie']['tags'];
$sortie = self::convertirEncodage($contenu);
return $sortie;
}
 
/**
* Retourne les informations à placer dans la balise HEAD du HTML.
*/
public static function getEntete() {
$contenu = self::$parametres['sortie']['entete'];
$sortie = self::convertirEncodage($contenu);
return $sortie;
}
 
/**
* Retourne le contenu du corps de l'application.
*/
public static function getContenuCorps() {
$contenu = self::$parametres['sortie']['corps'];
$sortie = self::convertirEncodage($contenu);
return $sortie;
}
 
/**
* Retourne le contenu de la tête de l'application.
*/
public static function getContenuTete() {
$contenu = self::$parametres['sortie']['tete'];
$sortie = self::convertirEncodage($contenu);
return $sortie;
}
 
/**
* Retourne le contenu du pied de l'application.
*/
public static function getContenuPied() {
$contenu = self::$parametres['sortie']['pied'];
$sortie = self::convertirEncodage($contenu);
return $sortie;
}
 
/**
* Retourne les éléments de navigation (onglet, fils d'ariane) de l'application.
*/
public static function getContenuNavigation() {
$contenu = self::$parametres['sortie']['navigation'];
$sortie = self::convertirEncodage($contenu);
return $sortie;
}
 
/**
* Retourne les éléments du menu de l'application.
*/
public static function getContenuMenu() {
$contenu = self::$parametres['sortie']['menu'];
$sortie = self::convertirEncodage($contenu);
return $sortie;
}
 
/**
* Retourne les chronos pris dans l'appli
*/
public static function getChrono() {
$sortie = '';
if (Config::get('benchmark_chrono')) {
$chrono = Chronometre::afficherChrono();
$sortie = self::convertirEncodage($chrono);
}
return $sortie;
}
 
/**
* Retourne les messages d'exceptions et d'erreurs.
*/
public static function getExceptions() {
$contenu = (Config::get('debogage')) ? GestionnaireException::getExceptions() : '';
$sortie = self::convertirEncodage($contenu);
return $sortie;
}
 
/**
* Convertion du contenu de l'application (voir fichier config.ini : appli_encodage),
* dans le format de sortie désiré (voir fichier config.ini : sortie_encodage).
* Cette convertion a lieu seulement si les formats sont différents.
*/
private static function convertirEncodage($contenu) {
if (Config::get('sortie_encodage') != Config::get('appli_encodage')) {
$contenu = mb_convert_encoding($contenu, Config::get('sortie_encodage'), Config::get('appli_encodage'));
}
return $contenu;
}
}
?>
/tags/v5.9-van-tieghem/controleurs/aControleur.php
New file
0,0 → 1,296
<?php
// declare(encoding='UTF-8');
/**
* Classe abstraite dont chaque controleur de l'application doit hériter.
*
* @category PHP 5.2
* @package eflore-consultation
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
* @author Delphine CAUQUIL <delphine@tela-botanica.org>
* @copyright 2011 Tela-Botanica
* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
* @version $Id$
*/
abstract class aControleur extends Controleur {
 
const META_TITRE = 'titre';
const META_DESCRIPTION = 'description';
const META_TAGS = 'tags';
const ENTETE = 'entete';
const RENDU_TETE = 'tete';
const RENDU_CORPS = 'corps';
const RENDU_PIED = 'pied';
const RENDU_NAVIGATION = 'navigation';
const RENDU_MENU = 'menu';
 
private $sortie = array();
protected $urlBase = null;
protected $urlCourante = null;
protected $urls = null;
public function __construct(AppUrls $urls = null) {
$chemin = Config::get('chemin_modules').
AppControleur::getNomDossierDepuisClasse(get_class($this)).DS.
Config::get('dossier_squelettes').DS;
Registre::set('tbf.chemin_squelettes', $chemin);
 
$this->urlBase = Registre::get('eFlore.urlBase');
$this->urlCourante = Registre::get('eFlore.urlCourante');
$this->urlRedirection = Registre::get('eFlore.urlRedirection');
$this->urls = (is_null($urls)) ? new AppUrls() : $urls;
parent::__construct();
}
 
//+------------------------------------------------------------------------------------------------------+
// GESTION de l'AFFICHAGE en SORTIE
 
/**
* Attribue une position de sortie à un contenu.
*/
protected function setSortie($position, $contenu, $fusionner = false) {
if ($this->verifierExistenceTypeSortie($position)) {
if ($fusionner) {
if (isset($this->sortie[$position])) {
$this->sortie[$position] .= $contenu;
} else {
$this->sortie[$position] = $contenu;
}
} else {
$this->sortie[$position] = $contenu;
}
}
}
 
/**
* Vérifie l'existence du type de sortie indiqué pour son utilisation dans le tableau de sortie.
* @param string le type de sortie à tester.
* @return bool true si le type de sortie est valide, sinon false.
*/
private function verifierExistenceTypeSortie($type) {
$existe = true;
if ($type != self::RENDU_TETE &&
$type != self::RENDU_CORPS &&
$type != self::RENDU_PIED &&
$type != self::RENDU_NAVIGATION &&
$type != self::RENDU_MENU &&
$type != self::ENTETE &&
$type != self::META_TITRE &&
$type != self::META_DESCRIPTION &&
$type != self::META_TAGS) {
trigger_error("Le type de sortie '$type' n'est pas une valeur prédéfinie.", E_USER_WARNING);
$existe = false;
}
return $existe;
}
 
/**
* Retourne le tableau de sortie à utiliser dans le controleur principal de l'application.
*/
public function getSortie() {
return $this->sortie;
}
 
/**
* Fusionne un tableau de sortie par défaut avec le tableau passé en paramêtre.
* @param array le tableau à fusionner
*/
private function fusionnerSortie($nouvelleSortie) {
$sortieActuelle = $this->getSortie();
foreach ($nouvelleSortie as $position => $nouveauContenu) {
if ($nouveauContenu != '') {
$contenuPrecedent = isset($sortieActuelle[$position]) ? $sortieActuelle[$position] : null;
if ($nouveauContenu != $contenuPrecedent) {
$this->setSortie($position, $nouveauContenu, true);
}
}
}
}
/**
* Vide toutes les sorties (utile en cas de classe statique et de module ajax)
*/
protected function viderSorties() {
$this->setSortie(self::RENDU_TETE, '');
$this->setSortie(self::RENDU_CORPS, '');
$this->setSortie(self::RENDU_PIED, '');
$this->setSortie(self::RENDU_NAVIGATION, '');
$this->setSortie(self::RENDU_MENU, '');
}
 
/**
* Execute l'action d'un module donnée et fusionne le résultat avec le tableau de sortie.
* Permet à une action d'un module donnée de charger le résultat d'une autre action de module.
*/
protected function executerAction($ClasseModule, $action, $parametres = array()) {
$module = new $ClasseModule();
$sortiePrecedente = $this->getSortie();
// Initialisation du module demandé
if (method_exists($module, 'initialiser')) {
$module->initialiser();
}
// Lancement de l'action demandé du module chargé
if (method_exists($module, $action)) {
if (isset($parametres)) {
$module->$action($parametres);
} else {
$module->$action();
}
$nouvelleSortie = $module->getSortie();
$this->fusionnerSortie($nouvelleSortie);
} else {
$m = "La méthode '$action' du controleur '$ClasseModule' est introuvable.";
trigger_error($m, E_USER_ERROR);
}
}
//+------------------------------------------------------------------------------------------------------+
// GESTION du VUES COMMUNES
/**
* Charge un squelette de vue depuis l'emplacement commune.
* @param String $tpl le nom du squelette à charger sans l'extenssion de fichier.
* @param Array $donnees les données à passer au squelette PHP.
*/
private function getVueCommune($tpl, $donnees) {
$cheminOrigine = $this->getCheminSquelette();
$this->setCheminSquelette(Config::get('chemin_squelettes'));
$vue = $this->getVue($tpl, $donnees);
$this->setCheminSquelette($cheminOrigine);
return $vue;
}
 
/**
* Pour mutualiser la création du pied de page de l'application, sa gestion est gérée dans cette classe.
*/
public function chargerEnteteGeneral() {
$donnees['appli'] = Framework::getInfoAppli();
$donnees['i18n'] = array_merge(I18n::get('Entete'), I18n::get('General'));
$donnees['referentiel_titre'] = I18n::get('Referentiels-titres.'.Registre::get('parametres.referentiel'));
 
$this->setSortie(self::RENDU_TETE, $this->getVueCommune('entete_page', $donnees));
}
 
/**
* Pour mutualiser la création du menu de l'application, sa gestion est gérée dans cette classe.
*/
public function chargerMenuGeneral() {
$donnees['appli'] = Framework::getInfoAppli();
$donnees['i18n'] = array_merge(I18n::get('Pied'), I18n::get('General'));
$donnees['courrielContact'] = Config::get('courriel_contact');
 
$this->setSortie(self::RENDU_MENU, $this->getVueCommune('menu', $donnees));
}
 
/**
* Pour mutualiser la création du pied de page de l'application, sa gestion est gérée dans cette classe.
*/
public function chargerPiedGeneral() {
$donnees['appli'] = Framework::getInfoAppli();
$donnees['i18n'] = array_merge(I18n::get('Pied'), I18n::get('General'));
$donnees['courrielContact'] = Config::get('courriel_contact');
$donnees['url_widget_remarques'] = Config::get('url_widget_remarques');
 
$this->setSortie(self::RENDU_PIED, $this->getVueCommune('pied_page', $donnees));
}
 
//+------------------------------------------------------------------------------------------------------+
// GESTION du CHARGEMENT des CLASSES MÉTIERS
protected function getEfloreNoms() {
if (! isset($this->EfloreNoms)) {
$this->EfloreNoms = new Noms();
}
return $this->EfloreNoms;
}
 
protected function getEfloreTaxons() {
if (! isset($this->EfloreTaxons)) {
$this->EfloreTaxons = new Taxons();
}
return $this->EfloreTaxons;
}
 
public function obtenirUrlBase() {
$url = $this->urlBase->getURL();
return $url;
}
 
public function redirigerVers($url) {
$url = str_replace('&amp;', '&', $url);
header("Location: $url");
}
 
public function getParametresUrlListe() {
$parametres = array(
'referentiel' => Registre::get('parametres.referentiel'),
'module' => 'liste',
'action' => 'liste',
'rang' => $this->rang,
'lettre' => $this->lettre
);
return $parametres;
}
 
public function obtenirUrlListeFamille() {
$parametres = $this->getParametresUrlListe();
$parametres['rang'] = 'F';
$this->urlBase->setRequete($parametres);
$url = $this->urlBase->getURL();
return $url;
}
 
public function obtenirUrlListeGenre() {
$parametres = $this->getParametresUrlListe();
$parametres['rang'] = 'G';
$this->urlBase->setRequete($parametres);
$url = $this->urlBase->getURL();
return $url;
}
 
 
 
public function getParametresUrlResultat() {
$parametres = array(
'referentiel' => Registre::get('parametres.referentiel'),
'module' => 'recherche',
'action' => Registre::get('parametres.action'),
'submit' => 'Rechercher',
'type_nom' => isset($_GET['type_nom']) ? $_GET['type_nom'] : 'nom_scientifique',
'nom' => isset($_GET['nom']) ? $_GET['nom'] : ''
);
return $parametres;
}
 
public function obtenirUrlResultatDetermination() {
$parametres = $this->getParametresUrlResultat();
$parametres['resultat'] = 'determination';
$this->urlBase->setRequete($parametres);
$url = $this->urlBase->getURL();
return $url;
}
 
public function obtenirUrlResultatAlphab() {
$parametres = $this->getParametresUrlResultat();
$parametres['resultat'] = 'alphab';
$this->urlBase->setRequete($parametres);
$url = $this->urlBase->getURL();
return $url;
}
 
public function obtenirUrlResultatRetenu() {
$parametres = $this->getParametresUrlResultat();
$parametres['resultat'] = 'retenu';
$this->urlBase->setRequete($parametres);
$url = $this->urlBase->getURL();
return $url;
}
 
public function obtenirUrlResultatDecompo() {
$parametres = $this->getParametresUrlResultat();
$parametres['resultat'] = 'decompo';
$this->urlBase->setRequete($parametres);
$url = $this->urlBase->getURL();
return $url;
}
}
?>