source: spip-zone/_plugins_/saisies/inc/saisies_manipuler.php @ 65731

Last change on this file since 65731 was 65731, checked in by marcimat@…, 8 years ago

Du phpdoc

File size: 9.9 KB
Line 
1<?php
2
3/**
4 * Gestion de l'affichage des saisies
5 *
6 * @return SPIP\Saisies\Manipuler
7**/
8
9// Sécurité
10if (!defined('_ECRIRE_INC_VERSION')) return;
11
12/**
13 * Supprimer une saisie dont on donne l'identifiant, le nom ou le chemin
14 *
15 * @param array $saisies
16 *     Tableau des descriptions de saisies
17 * @param string|array $id_ou_nom_ou_chemin
18 *     L'identifiant unique
19 *     ou le nom de la saisie à supprimer
20 *     ou son chemin sous forme d'une liste de clés
21 * @return array
22 *     Tableau modifié décrivant les saisies
23 */
24function saisies_supprimer($saisies, $id_ou_nom_ou_chemin){
25        // Si la saisie n'existe pas, on ne fait rien
26        if ($chemin = saisies_chercher($saisies, $id_ou_nom_ou_chemin, true)){
27                // La position finale de la saisie
28                $position = array_pop($chemin);
29       
30                // On va chercher le parent par référence pour pouvoir le modifier
31                $parent =& $saisies;
32                foreach($chemin as $cle){
33                        $parent =& $parent[$cle];
34                }
35               
36                // On supprime et réordonne
37                unset($parent[$position]);
38                $parent = array_values($parent);
39        }
40       
41        return $saisies;
42}
43
44/**
45 * Insère une saisie à une position donnée
46 *
47 * @param array $saisies
48 *     Tableau des descriptions de saisies
49 * @param array $saisie
50 *     Description de la saisie à insérer
51 * @param array $chemin
52 *     Position complète où insérer la saisie.
53 *     En absence, insère la saisie à la fin.
54 * @return array
55 *     Tableau des saisies complété de la saisie insérée
56 */
57function saisies_inserer($saisies, $saisie, $chemin=array()){
58        // On vérifie quand même que ce qu'on veut insérer est correct
59        if ($saisie['saisie'] and $saisie['options']['nom']){
60                // ajouter un identifiant
61                $saisie = saisie_identifier($saisie);
62               
63                // Par défaut le parent c'est la racine
64                $parent =& $saisies;
65                // S'il n'y a pas de position, on va insérer à la fin du formulaire
66                if (!$chemin){
67                        $position = count($parent);
68                }
69                elseif (is_array($chemin)){
70                        $position = array_pop($chemin);
71                        foreach ($chemin as $cle){
72                                // Si la clé est un conteneur de saisies "saisies" et qu'elle n'existe pas encore, on la crée
73                                if ($cle == 'saisies' and !isset($parent[$cle]))
74                                        $parent[$cle] = array();
75                                $parent =& $parent[$cle];
76                        }
77                        // On vérifie maintenant que la position est cohérente avec le parent
78                        if ($position < 0) $position = 0;
79                        elseif ($position > count($parent)) $position = count($parent);
80                }
81                // Et enfin on insère
82                array_splice($parent, $position, 0, array($saisie));
83        }
84       
85        return $saisies;
86}
87
88/*
89 * Duplique une saisie (ou groupe de saisies)
90 * en placant la copie à la suite de la saisie d'origine.
91 * Modifie automatiquement les identifiants des saisies
92 *
93 * @param array $saisies Un tableau décrivant les saisies
94 * @param unknown_type $id_ou_nom_ou_chemin L'identifiant unique ou le nom ou le chemin de la saisie a dupliquer
95 * @return array Retourne le tableau modifié des saisies
96 */
97function saisies_dupliquer($saisies, $id_ou_nom_ou_chemin){
98        // On récupère le contenu de la saisie à déplacer
99        $saisie = saisies_chercher($saisies, $id_ou_nom_ou_chemin);
100        if ($saisie) {
101                list($clone) = saisies_transformer_noms_auto($saisies, array($saisie));
102                // insertion apres quoi ?
103                $chemin_validation = saisies_chercher($saisies, $id_ou_nom_ou_chemin, true);
104                // 1 de plus pour mettre APRES le champ trouve
105                $chemin_validation[count($chemin_validation)-1]++;
106                // On ajoute "copie" après le label du champs
107                $clone['options']['label'] .= ' '._T('saisies:construire_action_dupliquer_copie');
108
109                // Création de nouveau identifiants pour le clone
110                $clone = saisie_identifier($clone, true);
111               
112                $saisies = saisies_inserer($saisies, $clone, $chemin_validation);
113        }
114
115        return $saisies;
116}
117
118/*
119 * Déplace une saisie existante autre part
120 *
121 * @param array $saisies Un tableau décrivant les saisies
122 * @param unknown_type $id_ou_nom_ou_chemin L'identifiant unique ou le nom ou le chemin de la saisie à déplacer
123 * @param string $ou Le nom de la saisie devant laquelle on déplacera OU le nom d'un conteneur entre crochets [conteneur]
124 * @return array Retourne le tableau modifié des saisies
125 */
126function saisies_deplacer($saisies, $id_ou_nom_ou_chemin, $ou){
127        // On récupère le contenu de la saisie à déplacer
128        $saisie = saisies_chercher($saisies, $id_ou_nom_ou_chemin);
129
130        // Si on l'a bien trouvé
131        if ($saisie){
132                // On cherche l'endroit où la déplacer
133                // Si $ou est vide, c'est à la fin de la racine
134                if (!$ou){
135                        $saisies = saisies_supprimer($saisies, $id_ou_nom_ou_chemin);
136                        $chemin = array(count($saisies));
137                }
138                // Si l'endroit est entre crochet, c'est un conteneur
139                elseif (preg_match('/^\[(@?[\w]*)\]$/', $ou, $match)){
140                        $parent = $match[1];
141                        // Si dans les crochets il n'y a rien, on met à la fin du formulaire
142                        if (!$parent){
143                                $saisies = saisies_supprimer($saisies, $id_ou_nom_ou_chemin);
144                                $chemin = array(count($saisies));
145                        }
146                        // Sinon on vérifie que ce conteneur existe
147                        elseif (saisies_chercher($saisies, $parent, true)){
148                                // S'il existe on supprime la saisie et on recherche la nouvelle position
149                                $saisies = saisies_supprimer($saisies, $id_ou_nom_ou_chemin);
150                                $parent = saisies_chercher($saisies, $parent, true);
151                                $chemin = array_merge($parent, array('saisies', 1000000));
152                        }
153                        else
154                                $chemin = false;
155                }
156                // Sinon ça sera devant un champ
157                else{
158                        // On vérifie que le champ existe
159                        if (saisies_chercher($saisies, $ou, true)){
160                                // S'il existe on supprime la saisie
161                                $saisies = saisies_supprimer($saisies, $id_ou_nom_ou_chemin);
162                                // Et on recherche la nouvelle position qui n'est plus forcément la même maintenant qu'on a supprimé une saisie
163                                $chemin = saisies_chercher($saisies, $ou, true);
164                        }
165                        else
166                                $chemin = false;
167                }
168               
169                // Si seulement on a bien trouvé un nouvel endroit où la placer, alors on déplace
170                if ($chemin)
171                        $saisies = saisies_inserer($saisies, $saisie, $chemin);
172        }
173       
174        return $saisies;
175}
176
177/*
178 * Modifie une saisie
179 *
180 * @param array $saisies Un tableau décrivant les saisies
181 * @param unknown_type $id_ou_nom_ou_chemin L'identifiant unique ou le nom ou le chemin de la saisie à modifier
182 * @param array $modifs Le tableau des modifications à apporter à la saisie
183 * @return Retourne le tableau décrivant les saisies, mais modifié
184 */
185function saisies_modifier($saisies, $id_ou_nom_ou_chemin, $modifs){
186        $chemin = saisies_chercher($saisies, $id_ou_nom_ou_chemin, true);
187        $position = array_pop($chemin);
188        $parent =& $saisies;
189        foreach ($chemin as $cle){
190                $parent =& $parent[$cle];
191        }
192       
193        // On récupère le type tel quel
194        $modifs['saisie'] = $parent[$position]['saisie'];
195        // On récupère le nom s'il n'y est pas
196        if (!isset($modifs['options']['nom'])){
197                $modifs['options']['nom'] = $parent[$position]['options']['nom'];
198        }
199        // On récupère les enfants tels quels s'il n'y a pas des enfants dans la modif
200        if (
201                !isset($modifs['saisies'])
202                and isset($parent[$position]['saisies'])
203                and is_array($parent[$position]['saisies'])
204        ){
205                $modifs['saisies'] = $parent[$position]['saisies'];
206        }
207
208        // Si une option 'nouveau_type_saisie' est donnee, c'est que l'on souhaite
209        // peut être changer le type de saisie !
210        if (isset($modifs['options']['nouveau_type_saisie']) and $type = $modifs['options']['nouveau_type_saisie']) {
211                $modifs['saisie'] = $type;
212                unset($modifs['options']['nouveau_type_saisie']);
213        }
214                       
215        // On remplace tout
216        $parent[$position] = $modifs;
217       
218        // Cette méthode ne marche pas trop
219        //$parent[$position] = array_replace_recursive($parent[$position], $modifs);
220       
221        return $saisies;
222}
223
224/**
225 * Transforme tous les noms du formulaire avec un preg_replace
226 *
227 * @param array $saisies
228 *     Un tableau décrivant les saisies
229 * @param string $masque
230 *     Ce que l'on doit chercher dans le nom
231 * @param string $remplacement
232 *     Ce par quoi on doit remplacer
233 * @return array
234 *     Retourne le tableau modifié des saisies
235 */
236function saisies_transformer_noms($saisies, $masque, $remplacement){
237        if (is_array($saisies)){
238                foreach ($saisies as $cle => $saisie){
239                        $saisies[$cle]['options']['nom'] = preg_replace($masque, $remplacement, $saisie['options']['nom']);
240                        if (isset($saisie['saisies']) and is_array($saisie['saisies'])) {
241                                $saisies[$cle]['saisies'] = saisies_transformer_noms($saisie['saisies'], $masque, $remplacement);
242                        }
243                }
244        }
245       
246        return $saisies;
247}
248
249/**
250 * Transforme les noms d'une liste de saisies pour qu'ils soient
251 * uniques dans le formulaire donné.
252 *
253 * @param array $formulaire
254 *     Le formulaire à analyser
255 * @param array $saisies
256 *     Un tableau décrivant les saisies.
257 * @return array
258 *     Retourne le tableau modifié des saisies
259 */
260function saisies_transformer_noms_auto($formulaire, $saisies){
261
262        if (is_array($saisies)){
263                foreach ($saisies as $cle => $saisie){
264                        $saisies[$cle]['options']['nom'] = saisies_generer_nom($formulaire, $saisie['saisie']);
265                        // il faut prendre en compte dans $formulaire les saisies modifiees
266                        // sinon on aurait potentiellement 2 champs successifs avec le meme nom.
267                        // on n'ajoute pas les saisies dont les noms ne sont pas encore calculees.
268                        $new = $saisies[$cle];
269                        unset($new['saisies']);
270                        $formulaire[] = $new;
271                       
272                        if (is_array($saisie['saisies']))
273                                $saisies[$cle]['saisies'] = saisies_transformer_noms_auto($formulaire, $saisie['saisies']);
274                }
275        }
276
277        return $saisies;
278}
279
280/*
281 * Insère du HTML au début ou à la fin d'une saisie
282 *
283 * @param array $saisie La description d'une seule saisie
284 * @param string $insertion Du code HTML à insérer dans la saisie
285 * @param string $ou L'endroit où insérer le HTML : "debut" ou "fin"
286 * @return array Retourne la description de la saisie modifiée
287 */
288function saisies_inserer_html($saisie, $insertion, $ou='fin'){
289        if (!in_array($ou, array('debut', 'fin')))
290                $ou = 'fin';
291       
292        if ($ou == 'debut') {
293                $saisie['options']['inserer_debut'] =
294                        $insertion . (isset($saisie['options']['inserer_debut']) ? $saisie['options']['inserer_debut'] : '');
295        } elseif ($ou == 'fin') {
296                $saisie['options']['inserer_fin'] =
297                        (isset($saisie['options']['inserer_fin']) ? $saisie['options']['inserer_fin'] : '') . $insertion;
298        }
299       
300        return $saisie;
301}
302
303?>
Note: See TracBrowser for help on using the repository browser.