source: spip-zone/_plugins_/saisies/trunk/inc/saisies_lister.php @ 112309

Last change on this file since 112309 was 112309, checked in by maieul@…, 2 years ago

trailing spaces2

File size: 13.6 KB
Line 
1<?php
2
3/**
4 * Gestion de listes des saisies.
5 *
6 * @return SPIP\Saisies\Listes
7 **/
8
9// Sécurité
10if (!defined('_ECRIRE_INC_VERSION')) {
11        return;
12}
13
14/**
15 * Prend la description complète du contenu d'un formulaire et retourne
16 * les saisies "à plat" classées par identifiant unique.
17 *
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
20 *
21 * @return array Un tableau avec uniquement les saisies
22 */
23function saisies_lister_par_identifiant($contenu, $avec_conteneur = true) {
24        $saisies = array();
25
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;
32                                }
33                                if ($enfants_presents) {
34                                        $saisies = array_merge($saisies, saisies_lister_par_identifiant($ligne['saisies']));
35                                }
36                        }
37                }
38        }
39
40        return $saisies;
41}
42
43/**
44 * Prend la description complète du contenu d'un formulaire et retourne
45 * les saisies "à plat" classées par nom.
46 *
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
49 *
50 * @return array Un tableau avec uniquement les saisies
51 */
52function saisies_lister_par_nom($contenu, $avec_conteneur = true) {
53        $saisies = array();
54
55        if (is_array($contenu)) {
56                foreach ($contenu as $ligne) {
57                        if (is_array($ligne)) {
58                                if (
59                                        array_key_exists('saisie', $ligne)
60                                        and (!isset($ligne['saisies']) or !is_array($ligne['saisies']) or $avec_conteneur)
61                                        and isset($ligne['options'])
62                                ) {
63                                        $saisies[$ligne['options']['nom']] = $ligne;
64                                }
65                                if (isset($ligne['saisies']) and is_array($ligne['saisies'])) {
66                                        $saisies = array_merge($saisies, saisies_lister_par_nom($ligne['saisies']));
67                                }
68                        }
69                }
70        }
71
72        return $saisies;
73}
74
75/**
76 * Liste les saisies ayant une option X
77 * # saisies_lister_avec_option('sql', $saisies);.
78 *
79 *
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')
83 *
84 * @return liste de ces saisies triees par nom ayant une option X définie
85 */
86function saisies_lister_avec_option($option, $saisies, $tri = 'nom') {
87        $saisies_option = array();
88
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);
94        }
95
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;
99                }
100        }
101
102        return $saisies_option;
103}
104
105/**
106 * Liste les saisies ayant une definition SQL.
107 *
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')
110 *
111 * @return liste de ces saisies triees par nom ayant une option sql définie
112 */
113function saisies_lister_avec_sql($saisies, $tri = 'nom') {
114        return saisies_lister_avec_option('sql', $saisies, $tri);
115}
116
117/**
118 * Liste les saisies d'un certain type.
119 *
120 * @example `$saisies_date = saisies_lister_avec_type($saisies, 'date')`
121 *
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')
125 *
126 * @return liste de ces saisies triees par nom
127 */
128function saisies_lister_avec_type($saisies, $type, $tri = 'nom') {
129        $saisies_type = array();
130
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);
136        }
137
138        foreach ($saisies as $nom_ou_id => $saisie) {
139                if ($saisie['saisie'] == $type) {
140                        $saisies_type[$nom_ou_id] = $saisie;
141                }
142        }
143
144        return $saisies_type;
145}
146
147/**
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.
151 *
152 * @param array $contenu Le contenu d'un formulaire
153 *
154 * @return array Un tableau avec uniquement les saisies
155 */
156function saisies_lister_par_type($contenu) {
157        $saisies = array();
158
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;
164                                }
165                                if (is_array($ligne['saisies'])) {
166                                        $saisies = array_merge_recursive($saisies, saisies_lister_par_type($ligne['saisies']));
167                                }
168                        }
169                }
170        }
171
172        return $saisies;
173}
174
175/**
176 * Prend la description complète du contenu d'un formulaire et retourne
177 * une liste des noms des champs du formulaire.
178 *
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
181 *
182 * @return array Un tableau listant les noms des champs
183 */
184function saisies_lister_champs($contenu, $avec_conteneur = true) {
185        $saisies = saisies_lister_par_nom($contenu, $avec_conteneur);
186
187        return array_keys($saisies);
188}
189
190/**
191 * Prend la description complète du contenu d'un formulaire et retourne
192 * une liste des labels humains des vrais champs du formulaire (par nom)
193 *
194 * @param array $contenu        Le contenu d'un formulaire
195 * @param bool  $avec_conteneur Indique si on renvoie aussi les saisies ayant des enfants, comme les fieldset
196 *
197 * @return array Un tableau listant les labels humains des champs
198 */
199function saisies_lister_labels($contenu, $avec_conteneur = false) {
200        $saisies = saisies_lister_par_nom($contenu, $avec_conteneur);
201
202        $labels = array();
203        foreach ($saisies as $nom => $saisie) {
204                if (isset($saisie['options']['label'])) {
205                        $labels[$nom] = $saisie['options']['label'];
206                }
207        }
208
209        return $labels;
210}
211
212/**
213 * A utiliser dans une fonction charger d'un formulaire CVT,
214 * cette fonction renvoie le tableau de contexte correspondant
215 * de la forme $contexte['nom_champ'] = ''.
216 *
217 * @param array $contenu Le contenu d'un formulaire (un tableau de saisies)
218 *
219 * @return array Un tableau de contexte
220 */
221function saisies_charger_champs($contenu) {
222        if (function_exists('array_fill_keys')) { // php 5.2
223                return array_fill_keys(saisies_lister_champs($contenu, false), null);
224        }
225        $champs = array();
226        foreach (saisies_lister_champs($contenu, false) as $champ) {
227                $champs[$champ] = null;
228        }
229
230        return $champs;
231}
232
233/**
234 * Prend la description complète du contenu d'un formulaire et retourne
235 * une liste des valeurs par défaut des champs du formulaire.
236 *
237 * @param array $contenu Le contenu d'un formulaire
238 *
239 * @return array Un tableau renvoyant la valeur par défaut de chaque champs
240 */
241function saisies_lister_valeurs_defaut($contenu) {
242        $contenu = saisies_lister_par_nom($contenu, false);
243        $defauts = array();
244
245        foreach ($contenu as $nom => $saisie) {
246                // Si le nom du champ est un tableau indexé, il faut parser !
247                if (preg_match('/([\w]+)((\[[\w]+\])+)/', $nom, $separe)) {
248                        $nom = $separe[1];
249                        // Dans ce cas on ne récupère que le nom,
250                        // la valeur par défaut du tableau devra être renseigné autre part
251                        $defauts[$nom] = array();
252                }
253                else {
254                        $defauts[$nom] = isset($saisie['options']['defaut']) ? $saisie['options']['defaut'] : '';
255                }
256        }
257
258        return $defauts;
259}
260
261/**
262 * Compare deux tableaux de saisies pour connaitre les différences.
263 *
264 * @param array  $saisies_anciennes Un tableau décrivant des saisies
265 * @param array  $saisies_nouvelles Un autre tableau décrivant des saisies
266 * @param bool   $avec_conteneur    Indique si on veut prendre en compte dans la comparaison les conteneurs comme les fieldsets
267 * @param string $tri               Comparer selon quel tri ? 'nom' / 'identifiant'
268 *
269 * @return array Retourne le tableau des saisies supprimées, ajoutées et modifiées
270 */
271function saisies_comparer($saisies_anciennes, $saisies_nouvelles, $avec_conteneur = true, $tri = 'nom') {
272        $trier = "saisies_lister_par_$tri";
273        $saisies_anciennes = $trier($saisies_anciennes, $avec_conteneur);
274        $saisies_nouvelles = $trier($saisies_nouvelles, $avec_conteneur);
275
276        // Les saisies supprimées sont celles qui restent dans les anciennes quand on a enlevé toutes les nouvelles
277        $saisies_supprimees = array_diff_key($saisies_anciennes, $saisies_nouvelles);
278        // Les saisies ajoutées, c'est le contraire
279        $saisies_ajoutees = array_diff_key($saisies_nouvelles, $saisies_anciennes);
280        // Il reste alors les saisies qui ont le même nom
281        $saisies_restantes = array_intersect_key($saisies_anciennes, $saisies_nouvelles);
282        // Dans celles-ci, celles qui sont modifiées sont celles dont la valeurs est différentes
283        $saisies_modifiees = array_udiff(array_diff_key($saisies_nouvelles, $saisies_ajoutees), $saisies_restantes, 'saisies_comparer_rappel');
284        #$saisies_modifiees = array_udiff($saisies_nouvelles, $saisies_restantes, 'saisies_comparer_rappel');
285        // Et enfin les saisies qui ont le même nom et la même valeur
286        $saisies_identiques = array_diff_key($saisies_restantes, $saisies_modifiees);
287
288        return array(
289                'supprimees' => $saisies_supprimees,
290                'ajoutees' => $saisies_ajoutees,
291                'modifiees' => $saisies_modifiees,
292                'identiques' => $saisies_identiques,
293        );
294}
295
296/**
297 * Compare deux saisies et indique si elles sont égales ou pas.
298 *
299 * @param array $a Une description de saisie
300 * @param array $b Une autre description de saisie
301 *
302 * @return int Retourne 0 si les saisies sont identiques, 1 sinon.
303 */
304function saisies_comparer_rappel($a, $b) {
305        if ($a === $b) {
306                return 0;
307        } else {
308                return 1;
309        }
310}
311
312/**
313 * Compare deux tableaux de saisies pour connaitre les différences
314 * en s'appuyant sur les identifiants de saisies.
315 *
316 * @see saisies_comparer()
317 *
318 * @param array $saisies_anciennes Un tableau décrivant des saisies
319 * @param array $saisies_nouvelles Un autre tableau décrivant des saisies
320 * @param bool  $avec_conteneur    Indique si on veut prendre en compte dans la comparaison
321 *                                 les conteneurs comme les fieldsets
322 *
323 * @return array Retourne le tableau des saisies supprimées, ajoutées et modifiées
324 */
325function saisies_comparer_par_identifiant($saisies_anciennes, $saisies_nouvelles, $avec_conteneur = true) {
326        return saisies_comparer($saisies_anciennes, $saisies_nouvelles, $avec_conteneur, 'identifiant');
327}
328
329/**
330 * Liste toutes les saisies configurables (ayant une description).
331 *
332 * @return array Un tableau listant des saisies et leurs options
333 */
334function saisies_lister_disponibles($saisies_repertoire = 'saisies') {
335        static $saisies = null;
336
337        if (is_null($saisies)) {
338                $saisies = array();
339                $liste = find_all_in_path("$saisies_repertoire/", '.+[.]yaml$');
340
341                if (count($liste)) {
342                        foreach ($liste as $fichier => $chemin) {
343                                $type_saisie = preg_replace(',[.]yaml$,i', '', $fichier);
344                                $dossier = str_replace($fichier, '', $chemin);
345
346                                // On ne garde que les saisies qui ont bien le HTML avec !
347                                if (
348                                        file_exists("$dossier$type_saisie.html")
349                                        and (
350                                                is_array($saisie = saisies_charger_infos($type_saisie))
351                                        )
352                                ) {
353                                        $saisies[$type_saisie] = $saisie;
354                                }
355                        }
356                }
357        }
358
359        return $saisies;
360}
361
362/**
363 * Liste tous les groupes de saisies configurables (ayant une description).
364 *
365 * @return array Un tableau listant des saisies et leurs options
366 */
367function saisies_groupes_lister_disponibles($saisies_repertoire = 'saisies') {
368        static $saisies = null;
369
370        if (is_null($saisies)) {
371                $saisies = array();
372                $liste = find_all_in_path("$saisies_repertoire/", '.+[.]yaml$');
373
374                if (count($liste)) {
375                        foreach ($liste as $fichier => $chemin) {
376                                $type_saisie = preg_replace(',[.]yaml$,i', '', $fichier);
377                                $dossier = str_replace($fichier, '', $chemin);
378
379                                if (is_array($saisie = saisies_charger_infos($type_saisie, $saisies_repertoire))) {
380                                        $saisies[$type_saisie] = $saisie;
381                                }
382                        }
383                }
384        }
385
386        return $saisies;
387}
388
389/**
390 * Lister les saisies existantes ayant une définition SQL.
391 *
392 * @return array Un tableau listant des saisies et leurs options
393 */
394function saisies_lister_disponibles_sql($saisies_repertoire = 'saisies') {
395        $saisies = array();
396        $saisies_disponibles = saisies_lister_disponibles($saisies_repertoire);
397
398        foreach ($saisies_disponibles as $type => $saisie) {
399                if (isset($saisie['defaut']['options']['sql']) and $saisie['defaut']['options']['sql']) {
400                        $saisies[$type] = $saisie;
401                }
402        }
403
404        return $saisies;
405}
406
407/**
408 * Charger les informations contenues dans le YAML d'une saisie.
409 *
410 * @param string $type_saisie Le type de la saisie
411 *
412 * @return array Un tableau contenant le YAML décodé
413 */
414function saisies_charger_infos($type_saisie, $saisies_repertoire = 'saisies') {
415        if (defined('_DIR_PLUGIN_YAML')) {
416                include_spip('inc/yaml');
417                $fichier = find_in_path("$saisies_repertoire/$type_saisie.yaml");
418                $saisie = yaml_decode_file($fichier);
419
420                if (is_array($saisie)) {
421                        $saisie['titre'] = (isset($saisie['titre']) and $saisie['titre'])
422                                ? _T_ou_typo($saisie['titre']) : $type_saisie;
423                        $saisie['description'] = (isset($saisie['description']) and $saisie['description'])
424                                ? _T_ou_typo($saisie['description']) : '';
425                        $saisie['icone'] = (isset($saisie['icone']) and $saisie['icone'])
426                                ? find_in_path($saisie['icone']) : '';
427                }
428        }
429        else {
430                $saisie = array();
431        }
432
433        return $saisie;
434}
435
436/**
437 * Quelles sont les saisies qui se débrouillent toutes seules, sans le _base commun.
438 *
439 * @return array Retourne un tableau contenant les types de saisies qui ne doivent pas utiliser le _base.html commun
440 */
441function saisies_autonomes() {
442        $saisies_autonomes = pipeline(
443                'saisies_autonomes',
444                array(
445                        'fieldset',
446                        'hidden',
447                        'destinataires',
448                        'explication',
449                )
450        );
451
452        return $saisies_autonomes;
453}
Note: See TracBrowser for help on using the repository browser.