Subversion Repositories eFlore/Applications.coel-consultation

<?php

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

/**

 * Classe Controleur générale de l'application Collection.

 *

 * @category	php5.2

 * @package		Collection

 * @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: ColControleur.php 17 2010-03-22 17:04:04Z jpm $

 */

abstract class ColControleur extends Controleur {

	const RENDU_TETE = 'tete';

	const RENDU_CORPS = 'corps';

	const RENDU_PIED = 'pied';

	const TYPE_AUTRE = 'AUTRE';

	const TYPE_TOTAL = 'TOTAL';

	const SEPARATEUR_TYPE_VALEUR = '##';

	const SEPARATEUR_VALEURS = ';;';

	const SEPARATEUR_DONNEES = '||';

	const VALEUR_NULL = 'NC';

	private $sortie = array();

	private $parametres = array();

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

	protected $url = null;

	public function __construct()  {

		$registre = Registre::getInstance();

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

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

		parent::__construct();

	}

	/**

	 * 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;

			}

		}

	}

	/**

	 * 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) {

			trigger_error("La position '$position' 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;

	}

	/**

	 * 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 construireTxtTruckSimple($chaine_a_analyser) {

		return $this->construireTxtTruck($chaine_a_analyser, false, false);

	}

	protected function construireTxtTruckSansMajuscule($chaine_a_analyser) {

		return $this->construireTxtTruck($chaine_a_analyser, false);

	}

	protected function construireTxtTruckSansPointFinal($chaine_a_analyser) {

		return $this->construireTxtTruck($chaine_a_analyser, true, false);

	}

	protected function construireTxtTruck($chaine_a_analyser, $majuscule = true, $point_final = true) {

		$termes = array();

		if ((!is_null($chaine_a_analyser)) && (trim($chaine_a_analyser) != ''))	{

			$valeurs = explode(self::SEPARATEUR_VALEURS, $chaine_a_analyser);

			$nbre_valeurs = count($valeurs);

			if ($nbre_valeurs > 0) {

				for ($i = 0; $i < $nbre_valeurs; $i++)	{

					$valeur = trim($valeurs[$i]);

					if ($valeur != '') {

						$valeur_formatee = $this->formaterValeurTruck($valeur);

						$termes[] = $valeur_formatee;

					}

				}

			}

		}

		$chaine_a_retourner = $this->formaterTableauDeTxt($termes, $majuscule, $point_final);

		return $chaine_a_retourner;

	}

	private function formaterValeurTruck($valeur) {

		$chaine_a_retourner = '';

		if (preg_match('/^[^#]+##[^$]+$/', $valeur))	{

			$cle_valeur = explode(self::SEPARATEUR_TYPE_VALEUR, $valeur);

			$chaine_a_retourner = (($cle_valeur[1] == '' || $cle_valeur[1] == 'null') ? self::VALEUR_NULL : $cle_valeur[1]);

			$chaine_a_retourner .= ' '.$this->formaterParenthese($cle_valeur[0]);

		} else if ($valeur != '')	{

			$chaine_a_retourner = $valeur;

		} else {

			trigger_error("Valeur truck posant problème :$valeur", E_USER_NOTICE);

		}

		return $chaine_a_retourner;

	}

	protected function formaterParenthese($chaine_a_afficher) {

		if ($chaine_a_afficher != '') {

			$chaine_a_afficher = '('.$chaine_a_afficher.')';

		}

		return $chaine_a_afficher;

	}

	protected function formaterSautDeLigne($chaine_a_formater) {

		$txt_a_retourner = preg_replace('/\n/', '<br />', $chaine_a_formater);

		return $txt_a_retourner;

	}

	protected function formaterTableauDeTxt($tableau_de_txt, $majuscule = true, $point_final = true) {

		$chaine_a_afficher = '';

		$taille_du_tableau = count($tableau_de_txt);

		if ($taille_du_tableau > 0) {

			$index_avt_dernier = $taille_du_tableau - 1;

			for ($i = 0; $i < $taille_du_tableau; $i++)	{

				$mot = $tableau_de_txt[$i];

				if ($i != $index_avt_dernier) {

					$chaine_a_afficher .= $mot.', ';

				} else {

					$chaine_a_afficher .= $this->nettoyerPointFinal($mot);

					if ($point_final) {

						$chaine_a_afficher .= '.';

					}

				}

			}

		}

		if ($majuscule) {

			$chaine_a_afficher = ucfirst($chaine_a_afficher);

		}

		return $chaine_a_afficher;

	}

	protected function formaterAutre($chaine_a_afficher) {

		if ($chaine_a_afficher != '') {

			$chaine_a_afficher = ' [Autre : '.$chaine_a_afficher.']';

		}

		return $chaine_a_afficher;

	}

	protected function formaterOuiNon($chaine_a_formater) {

		$txt_a_retourner = '';

		if ($chaine_a_formater == '0') {

			$txt_a_retourner = 'non';

		} else if ($chaine_a_formater == '1') {

			$txt_a_retourner = 'oui';

		}

		return $txt_a_retourner;

	}

	protected function formaterDate($date) {

		if ($date == '' || $date == '0000-00-00' || $date == '0000-00-00 00:00:00') {

			$date = 'Inconnue';

		}

		return $date;

	}

	protected function nettoyerPointFinal($mot) {

		$mot = preg_replace('/[.]$/', '', $mot);

		return $mot;

	}

	public function construireTxtListeOntologie($chaineAAnalyser, $valeurEstOntologie = true, $typeEstOntologie = true, $donneeEstOntologie = false) {

		$termes = array();

		$autres = array();

		$chaineAAnalyser = trim($chaineAAnalyser);

		if ($chaineAAnalyser != '') {

			$valeurs = explode(self::SEPARATEUR_VALEURS, $chaineAAnalyser);

			$nbreValeurs = count($valeurs);

			if ($nbreValeurs > 0)	{

				for ($i = 0; $i < $nbreValeurs; $i++)	{

					$valeur = $valeurs[$i];

					// VALEUR SANS TYPE

					// La valeur sans type est une entrée de l'ontologie

					if ($valeurEstOntologie && preg_match('/^[0-9]+$/', $valeur)) {

						if ($valeur == '0') {

							$valeur = '';

						} else {

							$valeurOntologie = Ontologie::getValeur($valeur);

							if ($valeurOntologie != '') {

								$valeur = $valeurOntologie['nom'];

							}

						}

					}

					// VALEUR AVEC TYPE

					// Type : AUTRE

					$valeurTypeAutre = self::TYPE_AUTRE.self::SEPARATEUR_TYPE_VALEUR;

					if (preg_match('/^'.$valeurTypeAutre.'.+$/', $valeur)) {

						$txtAutre = preg_replace('/^'.$valeurTypeAutre.'/', '', $valeur);

						if ($txtAutre != '') {

							$autres[] = $txtAutre;

						}

						$valeur = '';

					}

					// Type correspondant à une entrée de l'ontologie

					if ($typeEstOntologie) {

						$valeurTypeOntologie = '[0-9]+'.self::SEPARATEUR_TYPE_VALEUR;

						if (preg_match('/^'.$valeurTypeOntologie.'.+$/', $valeur)) {

							$type = substr($valeur, 0, strripos($valeur, self::SEPARATEUR_TYPE_VALEUR));

							$valeurOntologie = Ontologie::getValeur($type);

							if ($valeurOntologie != '') {

								$valeurOntologieNom = $valeurOntologie['nom'];

								$valeur = preg_replace('/^'.$type.'/', $valeurOntologieNom.': ', $valeur);

							}

						}

					}

					// Donnée correspondant à une entrée de l'ontologie

					if ($donneeEstOntologie) {

						$donneeOntologie = self::SEPARATEUR_TYPE_VALEUR.'([0-9]+)';

						if (preg_match('/^.+'.$donneeOntologie.'$/', $valeur, $match)) {

							$donnee = $match[1];

							$donnee = str_replace(self::SEPARATEUR_TYPE_VALEUR, '', $donnee);

							$valeurOntologie = Ontologie::getValeur($donnee);

							if ($valeurOntologie != '') {

								$valeurOntologieNom = $valeurOntologie['nom'];

								$valeur = preg_replace('/'.$donnee.'$/', $valeurOntologieNom, $valeur);

							}

						}

					}

					// Nettoyage final

					$valeur = preg_replace('/'.self::SEPARATEUR_TYPE_VALEUR.'/', '', $valeur);

					if ($valeur != '') {

						$termes[] = $valeur;

					}

				}

			}

		}

		$chaineTermes = $this->formaterTableauDeTxt($termes);

		$chaineAutres = $this->formaterTableauDeTxt($autres);

		$chaineARetourner = $chaineTermes.$this->formaterAutre($chaineAutres);

		return $chaineARetourner;

	}

}