4 * Gestion de listes des saisies.
6 * @return SPIP\Saisies\Listes
10 if (!defined('_ECRIRE_INC_VERSION')) {
15 * Prend la description complète du contenu d'un formulaire et retourne
16 * les saisies "à plat" classées par identifiant unique.
18 * @param array $contenu Le contenu d'un formulaire
19 * @param bool $avec_conteneur Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldsets
21 * @return array Un tableau avec uniquement les saisies
23 function saisies_lister_par_identifiant($contenu, $avec_conteneur = true) {
26 if (is_array($contenu)) {
27 foreach ($contenu as $ligne) {
28 if (is_array($ligne)) {
29 $enfants_presents = (isset($ligne['saisies']) and is_array($ligne['saisies']));
30 if (array_key_exists('saisie', $ligne) and (!$enfants_presents or $avec_conteneur)) {
31 $saisies[$ligne['identifiant']] = $ligne;
33 if ($enfants_presents) {
34 $saisies = array_merge($saisies, saisies_lister_par_identifiant($ligne['saisies']));
44 * Prend la description complète du contenu d'un formulaire et retourne
45 * les saisies "à plat" classées par nom.
47 * @param array $contenu Le contenu d'un formulaire
48 * @param bool $avec_conteneur Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldset
50 * @return array Un tableau avec uniquement les saisies
52 function saisies_lister_par_nom($contenu, $avec_conteneur = true) {
55 if (is_array($contenu)) {
56 foreach ($contenu as $ligne) {
57 if (is_array($ligne)) {
59 array_key_exists('saisie', $ligne)
60 and (!isset($ligne['saisies']) or !is_array($ligne['saisies']) or $avec_conteneur)
61 and isset($ligne['options'])
63 $saisies[$ligne['options']['nom']] = $ligne;
65 if (isset($ligne['saisies']) and is_array($ligne['saisies'])) {
66 $saisies = array_merge($saisies, saisies_lister_par_nom($ligne['saisies']));
76 * Liste les saisies ayant une option X
77 * # saisies_lister_avec_option('sql', $saisies);.
80 * @param string $option Nom de l'option cherchée
81 * @param array $saisies Liste de saisies
82 * @param string $tri tri par défaut des résultats (s'ils ne sont pas deja triés) ('nom', 'identifiant')
84 * @return liste de ces saisies triees par nom ayant une option X définie
86 function saisies_lister_avec_option($option, $saisies, $tri = 'nom') {
87 $saisies_option = array();
89 // tri par nom si ce n'est pas le cas
90 $s = array_keys($saisies);
91 if (is_int(array_shift($s))) {
92 $trier = 'saisies_lister_par_'.$tri;
93 $saisies = $trier($saisies);
96 foreach ($saisies as $nom_ou_id => $saisie) {
97 if (isset($saisie['options'][$option]) and $saisie['options'][$option]) {
98 $saisies_option[$nom_ou_id] = $saisie;
102 return $saisies_option;
106 * Liste les saisies ayant une definition SQL.
108 * @param array $saisies liste de saisies
109 * @param string $tri tri par défaut des résultats (s'ils ne sont pas deja triés) ('nom', 'identifiant')
111 * @return liste de ces saisies triees par nom ayant une option sql définie
113 function saisies_lister_avec_sql($saisies, $tri = 'nom') {
114 return saisies_lister_avec_option('sql', $saisies, $tri);
118 * Liste les saisies d'un certain type.
120 * @example `$saisies_date = saisies_lister_avec_type($saisies, 'date')`
122 * @param array $saisies liste de saisies
123 * @param string $type Type de la saisie
124 * @param string $tri tri par défaut des résultats (s'ils ne sont pas deja triés) ('nom')
126 * @return liste de ces saisies triees par nom
128 function saisies_lister_avec_type($saisies, $type, $tri = 'nom') {
129 $saisies_type = array();
131 // tri par nom si ce n'est pas le cas
132 $s = array_keys($saisies);
133 if (is_int(array_shift($s))) {
134 $trier = 'saisies_lister_par_'.$tri;
135 $saisies = $trier($saisies);
138 foreach ($saisies as $nom_ou_id => $saisie) {
139 if ($saisie['saisie'] == $type) {
140 $saisies_type[$nom_ou_id] = $saisie;
144 return $saisies_type;
148 * Prend la description complète du contenu d'un formulaire et retourne
149 * les saisies "à plat" classées par type de saisie.
150 * $saisie['input']['input_1'] = $saisie.
152 * @param array $contenu Le contenu d'un formulaire
154 * @return array Un tableau avec uniquement les saisies
156 function saisies_lister_par_type($contenu) {
159 if (is_array($contenu)) {
160 foreach ($contenu as $ligne) {
161 if (is_array($ligne)) {
162 if (array_key_exists('saisie', $ligne) and (!is_array($ligne['saisies']))) {
163 $saisies[ $ligne['saisie'] ][ $ligne['options']['nom'] ] = $ligne;
165 if (is_array($ligne['saisies'])) {
166 $saisies = array_merge_recursive($saisies, saisies_lister_par_type($ligne['saisies']));
176 * Prend la description complète du contenu d'un formulaire et retourne
177 * une liste des noms des champs du formulaire.
179 * @param array $contenu Le contenu d'un formulaire
180 * @param bool $avec_conteneur Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldset
182 * @return array Un tableau listant les noms des champs
184 function saisies_lister_champs($contenu, $avec_conteneur = true) {
185 $saisies = saisies_lister_par_nom($contenu, $avec_conteneur);
187 return array_keys($saisies);
191 * A utiliser dans une fonction charger d'un formulaire CVT,
192 * cette fonction renvoie le tableau de contexte correspondant
193 * de la forme $contexte['nom_champ'] = ''.
195 * @param array $contenu Le contenu d'un formulaire (un tableau de saisies)
197 * @return array Un tableau de contexte
199 function saisies_charger_champs($contenu) {
200 // array_fill_keys est disponible uniquement avec PHP >= 5.2.0
201 // return array_fill_keys(saisies_lister_champs($contenu, false), '');
203 foreach (saisies_lister_champs($contenu, false) as $champ) {
204 $champs[$champ] = '';
211 * Prend la description complète du contenu d'un formulaire et retourne
212 * une liste des valeurs par défaut des champs du formulaire.
214 * @param array $contenu Le contenu d'un formulaire
216 * @return array Un tableau renvoyant la valeur par défaut de chaque champs
218 function saisies_lister_valeurs_defaut($contenu) {
219 $contenu = saisies_lister_par_nom($contenu, false);
222 foreach ($contenu as $nom => $saisie) {
223 // Si le nom du champ est un tableau indexé, il faut parser !
224 if (preg_match('/([\w]+)((\[[\w]+\])+)/', $nom, $separe)) {
226 // Dans ce cas on ne récupère que le nom,
227 // la valeur par défaut du tableau devra être renseigné autre part
228 $defauts[$nom] = array();
231 $defauts[$nom] = isset($saisie['options']['defaut']) ?
$saisie['options']['defaut'] : '';
239 * Compare deux tableaux de saisies pour connaitre les différences.
241 * @param array $saisies_anciennes Un tableau décrivant des saisies
242 * @param array $saisies_nouvelles Un autre tableau décrivant des saisies
243 * @param bool $avec_conteneur Indique si on veut prendre en compte dans la comparaison les conteneurs comme les fieldsets
244 * @param string $tri Comparer selon quel tri ? 'nom' / 'identifiant'
246 * @return array Retourne le tableau des saisies supprimées, ajoutées et modifiées
248 function saisies_comparer($saisies_anciennes, $saisies_nouvelles, $avec_conteneur = true, $tri = 'nom') {
249 $trier = "saisies_lister_par_$tri";
250 $saisies_anciennes = $trier($saisies_anciennes, $avec_conteneur);
251 $saisies_nouvelles = $trier($saisies_nouvelles, $avec_conteneur);
253 // Les saisies supprimées sont celles qui restent dans les anciennes quand on a enlevé toutes les nouvelles
254 $saisies_supprimees = array_diff_key($saisies_anciennes, $saisies_nouvelles);
255 // Les saisies ajoutées, c'est le contraire
256 $saisies_ajoutees = array_diff_key($saisies_nouvelles, $saisies_anciennes);
257 // Il reste alors les saisies qui ont le même nom
258 $saisies_restantes = array_intersect_key($saisies_anciennes, $saisies_nouvelles);
259 // Dans celles-ci, celles qui sont modifiées sont celles dont la valeurs est différentes
260 $saisies_modifiees = array_udiff(array_diff_key($saisies_nouvelles, $saisies_ajoutees), $saisies_restantes, 'saisies_comparer_rappel');
261 #$saisies_modifiees = array_udiff($saisies_nouvelles, $saisies_restantes, 'saisies_comparer_rappel');
262 // Et enfin les saisies qui ont le même nom et la même valeur
263 $saisies_identiques = array_diff_key($saisies_restantes, $saisies_modifiees);
266 'supprimees' => $saisies_supprimees,
267 'ajoutees' => $saisies_ajoutees,
268 'modifiees' => $saisies_modifiees,
269 'identiques' => $saisies_identiques,
274 * Compare deux saisies et indique si elles sont égales ou pas.
276 * @param array $a Une description de saisie
277 * @param array $b Une autre description de saisie
279 * @return int Retourne 0 si les saisies sont identiques, 1 sinon.
281 function saisies_comparer_rappel($a, $b) {
290 * Compare deux tableaux de saisies pour connaitre les différences
291 * en s'appuyant sur les identifiants de saisies.
293 * @see saisies_comparer()
295 * @param array $saisies_anciennes Un tableau décrivant des saisies
296 * @param array $saisies_nouvelles Un autre tableau décrivant des saisies
297 * @param bool $avec_conteneur Indique si on veut prendre en compte dans la comparaison
298 * les conteneurs comme les fieldsets
300 * @return array Retourne le tableau des saisies supprimées, ajoutées et modifiées
302 function saisies_comparer_par_identifiant($saisies_anciennes, $saisies_nouvelles, $avec_conteneur = true) {
303 return saisies_comparer($saisies_anciennes, $saisies_nouvelles, $avec_conteneur, 'identifiant');
307 * Liste toutes les saisies configurables (ayant une description).
309 * @return array Un tableau listant des saisies et leurs options
311 function saisies_lister_disponibles($saisies_repertoire = 'saisies') {
312 static $saisies = null;
314 if (is_null($saisies)) {
316 $liste = find_all_in_path("$saisies_repertoire/", '.+[.]yaml$');
319 foreach ($liste as $fichier => $chemin) {
320 $type_saisie = preg_replace(',[.]yaml$,i', '', $fichier);
321 $dossier = str_replace($fichier, '', $chemin);
323 // On ne garde que les saisies qui ont bien le HTML avec !
325 file_exists("$dossier$type_saisie.html")
327 is_array($saisie = saisies_charger_infos($type_saisie))
330 $saisies[$type_saisie] = $saisie;
340 * Liste tous les groupes de saisies configurables (ayant une description).
342 * @return array Un tableau listant des saisies et leurs options
344 function saisies_groupes_lister_disponibles($saisies_repertoire = 'saisies') {
345 static $saisies = null;
347 if (is_null($saisies)) {
349 $liste = find_all_in_path("$saisies_repertoire/", '.+[.]yaml$');
352 foreach ($liste as $fichier => $chemin) {
353 $type_saisie = preg_replace(',[.]yaml$,i', '', $fichier);
354 $dossier = str_replace($fichier, '', $chemin);
356 if (is_array($saisie = saisies_charger_infos($type_saisie, $saisies_repertoire))) {
357 $saisies[$type_saisie] = $saisie;
367 * Lister les saisies existantes ayant une définition SQL.
369 * @return array Un tableau listant des saisies et leurs options
371 function saisies_lister_disponibles_sql($saisies_repertoire = 'saisies') {
373 $saisies_disponibles = saisies_lister_disponibles($saisies_repertoire);
375 foreach ($saisies_disponibles as $type => $saisie) {
376 if (isset($saisie['defaut']['options']['sql']) and $saisie['defaut']['options']['sql']) {
377 $saisies[$type] = $saisie;
385 * Charger les informations contenues dans le YAML d'une saisie.
387 * @param string $type_saisie Le type de la saisie
389 * @return array Un tableau contenant le YAML décodé
391 function saisies_charger_infos($type_saisie, $saisies_repertoire = 'saisies') {
392 if (defined('_DIR_PLUGIN_YAML')) {
393 include_spip('inc/yaml');
394 $fichier = find_in_path("$saisies_repertoire/$type_saisie.yaml");
395 $saisie = yaml_decode_file($fichier);
397 if (is_array($saisie)) {
398 $saisie['titre'] = (isset($saisie['titre']) and $saisie['titre'])
399 ?
_T_ou_typo($saisie['titre']) : $type_saisie;
400 $saisie['description'] = (isset($saisie['description']) and $saisie['description'])
401 ?
_T_ou_typo($saisie['description']) : '';
402 $saisie['icone'] = (isset($saisie['icone']) and $saisie['icone'])
403 ?
find_in_path($saisie['icone']) : '';
414 * Quelles sont les saisies qui se débrouillent toutes seules, sans le _base commun.
416 * @return array Retourne un tableau contenant les types de saisies qui ne doivent pas utiliser le _base.html commun
418 function saisies_autonomes() {
419 $saisies_autonomes = pipeline(
429 return $saisies_autonomes;