Subversion Repositories Applications.framework

<?php
// declare(encoding='UTF-8');
/**
 * Classe Controleur, coeur d'une application, c'est normalement la seule classe d'une application
 * qui devrait être appelée de l'extérieur.
 * Elle est abstraite donc doit obligatoirement être étendue.
 *
 * @category    php5
 * @package             Framework
 * @author              Aurélien PERONNET <aurelien@tela-botanica.org>
 * @author              Jean-Pascal MILCENT <jpm@tela-botanica.org>
 * @copyright   2009 Tela-Botanica
 * @license             http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
 * @license             http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
 * @version             SVN: $Id: Controleur.php 191 2010-04-29 15:34:49Z jpm $
 * @link                /doc/framework/
 *
 */
abstract class Controleur {
        /** Variable statique indiquant que les tableaux _GET et _POST ont déjà été encodé au format de l'appli. */
        private static $encodage = false;
        
        /** Registre global, normalement accessible partout */
        private $registre;

        /**
         * Constructeur par défaut
         */
        public function __construct() {
                $this->registre = Registre::getInstance();
                $this->registre->set('base_chemin_modele', Config::get('chemin_modeles'));
                $this->registre->set('base_chemin_squelette', Config::get('chemin_squelettes'));
                $this->registre->set('base_chemin_controleur', Config::get('chemin_controleurs'));
                $this->registre->set('base_url_application', new Url(Config::get('url_base')));
                $this->verifierEtReencoderTableauRequete();
        }

        /**
        * Charge un modele donné et le rend disponible sous la forme $this->nom_modele
        *
        * @param string $nom_modele le nom du modèle à  charger
        *
        * @return boolean false si le chargement a échoué, sinon true.
        */
        final protected function chargerModele($nom_modele) {
                $sortie = true;
                $modele = $this->getModele($nom_modele);
                if ($modele !== false) {
                        $this->$nom_modele = new $nom_modele;
                } else {
                        $sortie = false;
                }
                return $sortie;
        }

        /**
        * Retourne un modele donné
        *
        * @param string $nom_modele le nom du fichier modèle à charger sans son extension
        * @param String $ext            l'extension du fichier du modèel (par défaut : ".php"
        *
        * @return mixed false si le chargement a échoué, sinon l'objet du modèle demandé.
        */
        final protected function getModele($nom_modele, $ext = '.php') {
                $sortie = false;
                $chemin_modele = $this->registre->get('base_chemin_modele').$nom_modele.$ext;
                if (file_exists($chemin_modele)) {
                        include_once $chemin_modele;
                        if (class_exists($nom_modele)) {
                                $sortie = new $nom_modele;
                        }
                }
                return $sortie;
        }

        /**
         * 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.
         *
         * @param String $nom_squelette le nom du squelette sans son extension
         * @param Array  $donnees               un tableau associatif contenant les variables a injecter dans la vue
         * @param String $ext                   l'extension du fichier du squelette (par défaut : ".tpl.html"
         *
         * @return boolean false si la vue n'existe pas, sinon la chaine résultat.
         */
        final protected function getVue($nom_squelette, $donnees = array(), $ext = '.tpl.html') {
                $donnees = $this->preTraiterDonnees($donnees);
                $chemin_squelette = ($this->registre->get('base_chemin_squelette')).$nom_squelette.$ext;
                $sortie = SquelettePhp::analyser($chemin_squelette, $donnees);

                return $sortie;
        }

        /**
         * Fonction prenant en paramètre un tableau de données et effectuant un traitement dessus.
         * Cette fonction est à surcharger dans les classes filles pour automatiser un traitement
         * avant chaque chargement de vue.
         *
         * @param Array $donnees Le tableau de données à traiter
         *
         * @return Array $donnees Le tableau de données traité
         */
        protected function preTraiterDonnees($donnees) {
                return $donnees;
        }

        /**
         * Procédure vérifiant l'encodage des tableaux $_GET et $_POST et les transcodant dans l'encodage de l'application
         */
        protected function verifierEtReencoderTableauRequete() {
                if (self::$encodage == false && Config::get('sortie_encodage') != Config::get('appli_encodage')) {
                        $_POST = $this->encoderTableau($_POST, Config::get('appli_encodage'), Config::get('sortie_encodage'));
                        $_GET = $this->encoderTableau($_GET, Config::get('appli_encodage'), Config::get('sortie_encodage'));
                        self::$encodage = true;
                }
        }

        /**
         * Fonction récursive transcodant toutes les valeurs d'un tableau de leur encodage d'entrée vers un encodage de sortie donné
         * @param $tableau Array Un tableau de données à encoder
         * @param $encodage_sortie String l'encodage vers lequel on doit transcoder
         * @param $encodage_entree String l'encodage original des chaines du tableau (optionnel)
         * @return Array Le tableau encodé dans l'encodage de sortie
         *
         */
        final protected function encoderTableau($tableau, $encodage_sortie, $encodage_entree = null) {
                if (is_array($tableau)) {
                        foreach ($tableau as $cle => $valeur) {
                                if (is_array($valeur)) {
                                        $tableau[$cle] = $this->encoderTableau($valeur, $encodage_sortie, $encodage_entree);
                                } else {
                                        $tableau[$cle] = mb_convert_encoding($valeur, $encodage_sortie, $encodage_entree);
                                }
                        }
                }
                return $tableau;
        }
}
?>