Subversion Repositories Applications.referentiel

<?php

// declare(encoding='UTF-8');

/**

 * Classe Controleur générale partagée par les différents modules de l'application.

 *

 * @package		Referentiel

 * @category	Php5.2

 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>

 * @copyright	2010 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$

 */

abstract class AppliControleur extends Controleur {

	const RENDU_TETE = 'tete';

	const RENDU_CORPS = 'corps';

	const RENDU_PIED = 'pied';

	const RENDU_NAVIGATION = 'navigation';

	const RENDU_MENU = 'menu';

	// FIXME : voir s'il est plus intéressant d'utiliser une méthode dans les classes filles

	protected $url = null;

	private $parametres = array();

	private $sortie = array();

	private $messages = null;

	//+----------------------------------------------------------------------------------------------------------------+

	// Constructeur

	public function __construct()  {

		$registre = Registre::getInstance();

		$this->parametres = $registre->get('parametres');

		$this->url = $this->parametres['url'];

		parent::__construct();

	}

	//+----------------------------------------------------------------------------------------------------------------+

	// Accesseurs

	/**

	 * Retourne le tableau de sortie à utiliser dans le controleur principal de l'application.

	 */

	public function getSortie() {

		return $this->sortie;

	}

	/**

	 * Attribue à la bonne position de sortie un contenu.

	 */

	protected function setSortie($position, $contenu, $fusionner = false) {

		if ($this->verifierExistencePosition($position)) {

			if ($fusionner) {

				$this->sortie[$position] .= $contenu;

			} else {

				$this->sortie[$position] = $contenu;

			}

		}

	}

	/**

	 * Retourne le tableau des messages

	 */

	protected function getMessages() {

		return $this->messages;

	}

	/**

	 * Ajoute un message

	 */

	protected function addMessage($message) {

		if ('' != $message) {

			$this->messages[] = $message;

		}

	}

	//+----------------------------------------------------------------------------------------------------------------+

	// Méthodes

	/**

	 * Vérifie l'existence de la position indiquée pour son utilisation dans le tableau de sortie.

	 * @param string la position à tester.

	 * @return bool true si la position est valide, sinon false.

	 */

	private function verifierExistencePosition($position) {

		$existe = true;

		if ($position != self::RENDU_TETE &&

			$position != self::RENDU_CORPS &&

			$position != self::RENDU_PIED &&

			$position != self::RENDU_NAVIGATION &&

			$position != self::RENDU_MENU) {

			trigger_error("La position '$position' n'est pas une valeur prédéfinie.", E_USER_WARNING);

			$existe = false;

		}

		return $existe;

	}

	/**

	 * Execute l'action d'un module donnée et fusionne le résultat avec le tableau de sortie.

	 */

	protected function executerAction($ClasseModule, $action) {

		$module = new $ClasseModule();

		$module->$action();

		$this->fusionnerSortie($module->getSortie());

	}

	/**

	 * Fusionne un tableau de sortie par défaut avec le tableau passé en paramêtre.

	 * @param array le tableau à fusionner

	 */

	private function fusionnerSortie($sortie) {

		$this->sortie = array_merge($this->sortie, $sortie);

	}

	protected function postraiterDonnees(&$tableau) {

		if (count($tableau) > 0) {

			foreach ($tableau as $cle => &$valeur) {

				if ($valeur == '') {

					$valeur = ' ';

				} else if (is_string($valeur)) {

					$valeur = $this->remplacerEsperluette($valeur);

				} else if (is_array($valeur)) {

					$this->postraiterDonnees($valeur);

				}

			}

		}

	}

	protected function traiterEsperluette(&$tableau) {

		if (count($tableau) > 0) {

			foreach ($tableau as $cle => &$valeur) {

				if (is_string($valeur)) {

					$valeur = $this->remplacerEsperluette($valeur);

				} else if (is_array($valeur)) {

					$this->traiterEsperluette($valeur);

				}

			}

		}

	}

	private function remplacerEsperluette($txt) {

		$txt = preg_replace('/&(?!([a-z]+|#[0-9]+|#x[0-9a-f]+);)/i', '&', $txt, -1);

		return $txt;

	}

	/**

	 * Construction du menu et stockage dans le conteneur de sortie RENDU_MENU.

	 *

	 * @param string $referentiel code du référentiel.

	 */

	protected function construireMenu($referentiel) {

		$menu['nom'] = 'Accueil';

		$menu['url'] = $this->obtenirUrlMenuAccueil();

		$donnees['menus'][] = $menu;

		$menu['nom'] = 'Tests';

		$menu['url'] = $this->obtenirUrlMenuTest($referentiel);

		$donnees['menus'][] = $menu;

		$menu['nom'] = 'Versionnage';

		$menu['url'] = $this->obtenirUrlMenuVersionnage($referentiel);

		$donnees['menus'][] = $menu;

		$menu['nom'] = 'Consultation';

		$menu['url'] = $this->obtenirUrlMenuConsultation($referentiel);

		$donnees['menus'][] = $menu;

		$this->setSortie(self::RENDU_MENU, $this->getVue('menu', $donnees), false);

	}

	/**

	 * Construction du fil d'ariane et stockage dans le conteneur de sortie RENDU_NAVIGATION.

	 *

	 * @param $referentiel code du référentiel

	 * @param $id_traitement id du traitement

	 * @param $id_resultat id du résultat

	 */

	protected function construireFilAriane($referentiel = null, $id_traitement = null, $id_resultat = null) {

		$entree['nom'] = 'Accueil';

		$entree['url'] = $this->obtenirUrlMenuAccueil();

		$donnees['entrees'][] = $entree;

		if (isset($referentiel)) {

			$entree['nom'] = strtoupper($referentiel);

			$entree['url'] = $this->obtenirUrlDetailReferentiel($referentiel);

			$donnees['entrees'][] = $entree;

			$module = Referentiel::getModule();

			if ($module != 'Accueil') {

				$entree['nom'] = $module;

				$entree['url'] = $this->obtenirUrlMenu($module, $referentiel);

				$donnees['entrees'][] = $entree;

			}

			if (isset($id_traitement)) {

				$entree['nom'] = "Traitement #$id_traitement";

				$entree['url'] = $this->obtenirUrlFicheTraitement($referentiel, $id_traitement);

				$donnees['entrees'][] = $entree;

			}

			if (isset($id_resultat)) {

				$entree['nom'] = "Résultat #$id_resultat";

				$entree['url'] = $this->obtenirUrlFicheResultat($referentiel, $id_resultat);

				$donnees['entrees'][] = $entree;

			}

		}

		$this->setSortie(self::RENDU_NAVIGATION, $this->getVue('fil_ariane', $donnees), false);

	}

	protected function obtenirUrlDetailReferentiel($referentiel) {

		$this->url->setRequete(false);

		$this->url->setVariableRequete('module', 'Accueil');

		$this->url->setVariableRequete('action', 'afficherDetail');

		$this->url->setVariableRequete('ref', $referentiel);

		$url = $this->url->getURL();

		$this->url->unsetVariablesRequete(array('module', 'action', 'ref'));

		return $url;

	}

	protected function obtenirUrlMenuAccueil() {

		return $this->obtenirUrlMenu('Accueil');

	}

	protected function obtenirUrlMenuTest($referentiel) {

		return $this->obtenirUrlMenu('Test', $referentiel);

	}

	protected function obtenirUrlMenuVersionnage($referentiel) {

		return $this->obtenirUrlMenu('Versionnage', $referentiel);

	}

	protected function obtenirUrlMenuConsultation($referentiel) {

		return $this->obtenirUrlMenu('Consultation', $referentiel);

	}

	private function obtenirUrlMenu($menu, $referentiel = null) {

		$this->url->setRequete(false);

		$this->url->setVariableRequete('module', $menu);

		if (isset($referentiel)) {

			$this->url->setVariableRequete('ref', $referentiel);

		}

		$url = $this->url->getURL();

		$this->url->unsetVariablesRequete(array('module', 'ref'));

		return $url;

	}

	protected function obtenirUrlFicheTraitement($referentiel, $id_traitement) {

		$this->url->setRequete(false);

		$this->url->setVariableRequete('module', 'Traitement');

		$this->url->setVariableRequete('id-t', $id_traitement);

		$this->url->setVariableRequete('ref', $referentiel);

		$url = $this->url->getURL();

		$this->url->unsetVariablesRequete(array('module', 'id-t', 'ref'));

		return $url;

	}

	protected function obtenirUrlFicheResultat($referentiel, $id_resultat) {

		$this->url->setRequete(false);

		$this->url->setVariableRequete('module', 'Resultat');

		$this->url->setVariableRequete('id-r', $id_resultat);

		$this->url->setVariableRequete('ref', $referentiel);

		$url = $this->url->getURL();

		$this->url->unsetVariablesRequete(array('module', 'id-r', 'ref'));

		return $url;

	}

}