<?php
// declare(encoding='UTF-8');
/**
 * Classe fournissant des méthodes statiques de manipulation des tableaux (Array).
 *
 * @category	PHP 5.2
 * @package	Utilitaire
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
 * @copyright	Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
 * @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: Tableau.php 400 2011-11-25 16:26:26Z jpm $
 * @link		/doc/framework/
 */
// TODO : réaliser une seule méthode pour trierMD et trierMDType
class Tableau {
	const TRI_NATUREL = 'nat';
	const TRI_CASSE_SENSIBLE = 'ci';
	const TRI_CASSE_INSENSIBLE = 'ci';

	private static $triMultiDimension = null;
	private static $triType = null;

	/**
	 * Etend le tableau à étendre avec les données du tableau à copier. Si des clés sont identiques entre les deux tableaux
	 * une erreur est déclenchée et la valeur du tableau à étendre est gardée. Si les deux tableaux ont des clés numériques
	 * leurs valeurs sont gardées (à la différence de array_merge).
	 * Les tableaux sont passés par références et le tableau à copier est progressivement détruit pour éviter la consomation
	 * de mémoire.
	 *
	 * @param array $tableau_a_etendre
	 * @param array $tableau_a_copier
	 * @return void
	 */
	public static function etendre(Array &$tableau_a_etendre, Array &$tableau_a_copier) {
		$cles_existantes = null;
		foreach($tableau_a_copier as $cle => $val) {
			if (!isset($tableau_a_etendre[$cle])) {
				$tableau_a_etendre[$cle] = $val;
				unset($tableau_a_copier[$cle]);
			} else {
				$cles_existantes[] = $cle;
			}
		}
		if (is_array($cles_existantes)) {
			$e = "Le tableau a étendre contenait déjà les clés suivantes : ".implode(', ', $cles_existantes);
			trigger_error($e, E_USER_WARNING);
		}
	}

	/**
	 * @deprecated Utiliser la méthode trierMD()
	 * @see  trierMD()
	 */
	public static function trierTableauMd($array, $cols) {
		return self::trierMD($array, $cols);
	}

	/**
	 * Permet de trier un tableau multi-dimenssionnel en gardant l'ordre des clés.
	 *
	 * @param Array $array le tableau à trier
	 * @param Array $cols tableau indiquant en clé la colonne à trier et en valeur l'ordre avec SORT_ASC ou SORT_DESC
	 * @return Array le tableau trié.
	 * @author cagret at gmail dot com
	 * @see  http://fr.php.net/manual/fr/function.array-multisort.php Post du 21-Jun-2009 12:38
	 */
	public static function trierMD($array, $cols) {
		$colarr = array();
		foreach ($cols as $col => $order) {
			$colarr[$col] = array();
			foreach ($array as $k => $row) {
				$colarr[$col]['_'.$k] = strtolower($row[$col]);
			}
		}
		$params = array();
		foreach ($cols as $col => $order) {
			$params[] =& $colarr[$col];
			$orders = (array) $order;
			foreach($orders as $orderElement) {
				$params[] =& $orderElement;
			}
		}
		call_user_func_array('array_multisort', $params);
		$ret = array();
		$keys = array();
		$first = true;
		foreach ($colarr as $col => $arr) {
			foreach ($arr as $k => $v) {
				if ($first) {
					$keys[$k] = substr($k, 1);
				}
				$k = $keys[$k];
				if (!isset($ret[$k])) {
					$ret[$k] = $array[$k];
				}
				$ret[$k][$col] = $array[$k][$col];
			}
			$first = false;
		}
		return $ret;
	}

	/**
	* Méthode réalisant un tri d'un tableau multidimension. Attention les clés du tableau ne sont pas modifiées.
	* A utiliser de cette façon:
	* EfloreTriage::trieMultiple( $tableau_multidimension, array('ma_cle1' => SORT_ASC, 'ma_cle2' => SORT_DESC), $type_de_tri);
	* Utiliser les constantes php SORT_DESC ou SORT_ASC pour l'odre de tri.
	* Pour le type de tri : utiliser :
	*  - Tableau::TRI_NATUREL pour un trie naturel,
	*  - Tableau::TRI_CASSE_SENSIBLE pour un tri sensible à la casse,
	*  - Tableau::TRI_CASSE_INSENSIBLE pour un tri insensible à la casse.
	* @param array le tableau à trier
	* @param array le talbeau des colonnes à trier constituer de nom de clé en clé et d'ordres de tri en valeur.
	* @param string le type de tri à appliquer.
	* @return array le tableau trié.
	*/
	public static function trierMDType(&$tableau, $cols, $type = self::TRI_CASSE_INSENSIBLE) {
		self::$triMultiDimension = $cols;
		self::$triType = $type;
		uasort($tableau, array('self', 'comparer'));
		return $tableau;
	}

	private static function comparer($a, $b) {
		$resultat = 0;
		foreach (self::$triMultiDimension as $champ => $ordre) {
			if ($resultat == 0) {
				$mot_01 = Chaine::supprimerAccents($b[$champ]);
				$mot_02 = Chaine::supprimerAccents($a[$champ]);
				switch (self::$triType) {
					case self::TRI_NATUREL :
						$resultat = ($ordre == SORT_DESC) ? strnatcmp($mot_01, $mot_02) : strnatcmp($mot_02, $mot_01);
						break;
					case self::TRI_CASSE_SENSIBLE :
						$resultat = ($ordre == SORT_DESC) ? strcmp($mot_01, $mot_02) : strcmp($mot_02, $mot_01);
						break;
					case self::TRI_CASSE_INSENSIBLE :
						$resultat = ($ordre == SORT_DESC) ? strcasecmp($mot_01, $mot_02) : strcasecmp($mot_02, $mot_01);
						break;
					default:
						$resultat = ($ordre == SORT_DESC) ? strcasecmp($mot_01, $mot_02) : strcasecmp($mot_02, $mot_01);
						break;
				}

			}
		}
		return $resultat;
	}
}
?>