4 * Gestion de l'affichage des saisies
6 * @return SPIP\Saisies\Afficher
10 if (!defined('_ECRIRE_INC_VERSION')) return;
13 * Indique si une saisie peut être affichée.
15 * On s'appuie sur l'éventuelle clé "editable" du $champ.
17 * - absent : le champ est éditable
18 * - 1, le champ est éditable
19 * - 0, le champ n'est pas éditable
20 * - -1, le champ est éditable s'il y a du contenu dans le champ (l'environnement)
21 * ou dans un de ses enfants (fieldsets)
24 * Tableau de description de la saisie
26 * Environnement transmis à la saisie, certainement l'environnement du formulaire
27 * @param bool $utiliser_editable
28 * - false pour juste tester le cas -1
31 * Retourne un booléen indiquant l'état éditable ou pas :
32 * - true si la saisie est éditable (peut être affichée)
35 function saisie_editable($champ, $env, $utiliser_editable=true) {
36 if ($utiliser_editable) {
37 // si le champ n'est pas éditable, on sort.
38 if (!isset($champ['editable'])) {
41 $editable = $champ['editable'];
53 if (isset($champ['options']['nom'])) {
54 // si on a le name dans l'environnement, on le teste
55 $nom = $champ['options']['nom'];
56 if (isset($env[$nom])) {
57 return $env[$nom] ?
true : false ;
60 // sinon, si on a des sous saisies
61 if (isset($champ['saisies']) and is_array($champ['saisies'])) {
62 foreach($champ['saisies'] as $saisie) {
63 if (saisie_editable($saisie, $env, false)) {
69 // aucun des paramètres demandés n'avait de contenu
74 * Génère une saisie à partir d'un tableau la décrivant et de l'environnement
77 * Description de la saisie.
78 * Le tableau doit être de la forme suivante :
80 * 'saisie' => 'input',
83 * 'label' => 'Un titre plus joli',
84 * 'obligatoire' => 'oui',
85 * 'explication' => 'Remplissez ce champ en utilisant votre clavier.'
89 * Environnement du formulaire
90 * Permet de savoir les valeurs actuelles des contenus des saisies,
91 * les erreurs eventuelles présentes...
93 * Code HTML des saisies de formulaire
95 function saisies_generer_html($champ, $env=array()){
96 // Si le parametre n'est pas bon, on genere du vide
97 if (!is_array($champ))
100 // Si la saisie n'est pas editable, on sort aussi.
101 if (!saisie_editable($champ, $env)) {
107 // On sélectionne le type de saisie
108 $contexte['type_saisie'] = $champ['saisie'];
109 // Identifiant unique de saisie, si present
110 if (isset($champ['identifiant'])) {
111 $contexte['id_saisie'] = $champ['identifiant'];
114 // Peut-être des transformations à faire sur les options textuelles
115 $options = $champ['options'];
116 foreach ($options as $option => $valeur){
117 if ($option == 'datas') {
118 // exploser une chaine datas en tableau (applique _T_ou_typo sur chaque valeur)
119 $options[$option] = saisies_chaine2tableau($valeur);
121 $options[$option] = _T_ou_typo($valeur, 'multi');
125 // On ajoute les options propres à la saisie
126 $contexte = array_merge($contexte, $options);
128 // Si env est définie dans les options ou qu'il y a des enfants, on ajoute tout l'environnement
129 if (isset($contexte['env']) or (isset($champ['saisies']) AND is_array($champ['saisies']))) {
130 unset($contexte['env']);
132 // on sauve l'ancien environnement
133 // car les sous-saisies ne doivent pas être affectees
134 // par les modification sur l'environnement servant à generer la saisie mère
135 $contexte['_env'] = $env;
137 // À partir du moment où on passe tout l'environnement, il faut enlever certains éléments qui ne doivent absolument provenir que des options
138 unset($env['inserer_debut']);
139 unset($env['inserer_fin']);
140 $saisies_disponibles = saisies_lister_disponibles();
141 if (isset($saisies_disponibles[$contexte['type_saisie']]) and is_array($saisies_disponibles[$contexte['type_saisie']]['options'])) {
142 $options_a_supprimer = saisies_lister_champs($saisies_disponibles[$contexte['type_saisie']]['options']);
143 foreach ($options_a_supprimer as $option_a_supprimer){
144 unset($env[$option_a_supprimer]);
148 $contexte = array_merge($env, $contexte);
150 // Sinon on ne sélectionne que quelques éléments importants
152 // On récupère la liste des erreurs
153 $contexte['erreurs'] = $env['erreurs'];
154 // On ajoute toujours le bon self
155 $contexte['self'] = self();
158 // Dans tous les cas on récupère de l'environnement la valeur actuelle du champ
159 // Si le nom du champ est un tableau indexé, il faut parser !
160 if (preg_match('/([\w]+)((\[[\w]+\])+)/', $contexte['nom'], $separe)){
161 $contexte['valeur'] = $env[$separe[1]];
162 preg_match_all('/\[([\w]+)\]/', $separe[2], $index);
163 // On va chercher au fond du tableau
164 foreach($index[1] as $cle){
165 $contexte['valeur'] = isset($contexte['valeur'][$cle]) ?
$contexte['valeur'][$cle] : null;
168 // Sinon la valeur est juste celle du nom
170 $contexte['valeur'] = (isset($env[$contexte['nom']]) ?
$env[$contexte['nom']] : null);
173 // Si ya des enfants on les remonte dans le contexte
174 if (isset($champ['saisies']) and is_array($champ['saisies']))
175 $contexte['saisies'] = $champ['saisies'];
177 // On génère la saisie
178 return recuperer_fond(
185 * Génère une vue d'une saisie à partir d'un tableau la décrivant
187 * @see saisies_generer_html()
188 * @param array $saisie
189 * Tableau de description d'une saisie
191 * L'environnement, contenant normalement la réponse à la saisie
192 * @param array $env_obligatoire
195 * Code HTML de la vue de la saisie
197 function saisies_generer_vue($saisie, $env=array(), $env_obligatoire=array()){
198 // Si le paramètre n'est pas bon, on génère du vide
199 if (!is_array($saisie))
204 // On sélectionne le type de saisie
205 $contexte['type_saisie'] = $saisie['saisie'];
207 // Peut-être des transformations à faire sur les options textuelles
208 $options = $saisie['options'];
209 foreach ($options as $option => $valeur){
210 if ($option == 'datas') {
211 // exploser une chaine datas en tableau (applique _T_ou_typo sur chaque valeur)
212 $options[$option] = saisies_chaine2tableau($valeur);
214 $options[$option] = _T_ou_typo($valeur, 'multi');
218 // On ajoute les options propres à la saisie
219 $contexte = array_merge($contexte, $options);
221 // Si env est définie dans les options ou qu'il y a des enfants, on ajoute tout l'environnement
222 if (isset($contexte['env']) or (isset($saisie['saisies']) AND is_array($saisie['saisies']))){
223 unset($contexte['env']);
225 // on sauve l'ancien environnement
226 // car les sous-saisies ne doivent pas être affectees
227 // par les modification sur l'environnement servant à generer la saisie mère
228 $contexte['_env'] = $env;
230 // À partir du moment où on passe tout l'environnement, il faut enlever
231 // certains éléments qui ne doivent absolument provenir que des options
232 $saisies_disponibles = saisies_lister_disponibles();
233 if (is_array($saisies_disponibles[$contexte['type_saisie']]['options'])){
234 $options_a_supprimer = saisies_lister_champs($saisies_disponibles[$contexte['type_saisie']]['options']);
235 foreach ($options_a_supprimer as $option_a_supprimer){
236 unset($env[$option_a_supprimer]);
240 $contexte = array_merge($env, $contexte);
243 // Dans tous les cas on récupère de l'environnement la valeur actuelle du champ
245 // On regarde en priorité s'il y a un tableau listant toutes les valeurs
246 if ($env['valeurs'] and is_array($env['valeurs']) and isset($env['valeurs'][$contexte['nom']])){
247 $contexte['valeur'] = $env['valeurs'][$contexte['nom']];
249 // Si le nom du champ est un tableau indexé, il faut parser !
250 elseif (preg_match('/([\w]+)((\[[\w]+\])+)/', $contexte['nom'], $separe)){
251 $contexte['valeur'] = $env[$separe[1]];
252 preg_match_all('/\[([\w]+)\]/', $separe[2], $index);
253 // On va chercher au fond du tableau
254 foreach($index[1] as $cle){
255 $contexte['valeur'] = $contexte['valeur'][$cle];
258 // Sinon la valeur est juste celle du nom
260 // certains n'ont pas de nom (fieldset)
261 $contexte['valeur'] = isset($env[$contexte['nom']]) ?
$env[$contexte['nom']] : '';
264 // Si ya des enfants on les remonte dans le contexte
265 if (isset($saisie['saisies']) AND is_array($saisie['saisies']))
266 $contexte['saisies'] = $saisie['saisies'];
268 if (is_array($env_obligatoire)) {
269 $contexte = array_merge($contexte, $env_obligatoire);
272 // On génère la saisie
273 return recuperer_fond(
274 'saisies-vues/_base',
280 * Génère, à partir d'un tableau de saisie le code javascript ajouté à la fin de #GENERER_SAISIES
281 * pour produire un affichage conditionnel des saisies ayant une option afficher_si ou afficher_si_remplissage.
283 * @param array $saisies
284 * Tableau de descriptions des saisies
285 * @param string $id_form
286 * Identifiant unique pour le formulaire
290 function saisies_generer_js_afficher_si($saisies,$id_form){
292 $saisies = saisies_lister_par_nom($saisies,true);
294 $code .= '(function($){';
295 $code .= '$(document).ready(function(){chargement=true;';
296 $code .= 'verifier_saisies_'.$id_form.' = function(form){';
297 foreach ($saisies as $saisie) {
298 // on utilise comme selecteur l'identifiant de saisie en priorite s'il est connu
299 // parce que li_class = 'tableau[nom][option]' ne fonctionne evidement pas
300 // lorsque le name est un tableau
301 if (isset($saisie['options']['afficher_si']) or isset($saisie['options']['afficher_si_remplissage'])) {
303 // retrouver la classe css probable
304 switch ($saisie['saisie']) {
306 $class_li = 'fieldset_'.$saisie['options']['nom'];
309 $class_li = 'explication_'.$saisie['options']['nom'];
312 $class_li = 'editer_'.$saisie['options']['nom'];
314 $condition = $saisie['options']['afficher_si']."\n".$saisie['options']['afficher_si_remplissage'];
315 // retrouver l'identifiant
317 if (isset($saisie['identifiant']) and $saisie['identifiant']) {
318 $identifiant = $saisie['identifiant'];
320 // On gère le cas @plugin:non_plugin@
321 preg_match_all('#@plugin:(.+)@#U', $condition, $matches);
322 foreach ($matches[1] as $plug) {
323 if (defined('_DIR_PLUGIN_'.strtoupper($plug)))
324 $condition = preg_replace('#@plugin:'.$plug.'@#U', 'true', $condition);
326 $condition = preg_replace('#@plugin:'.$plug.'@#U', 'false', $condition);
328 // On gère le cas @config:plugin:meta@ suivi d'un test
329 preg_match_all('#@config:(.+):(.+)@#U', $condition, $matches);
330 foreach ($matches[1] as $plugin) {
331 $config = lire_config($plugin);
332 $condition = preg_replace('#@config:'.$plugin.':'.$matches[2][0].'@#U', '"'.$config[$matches[2][0]].'"', $condition);
334 // On transforme en une condition valide
335 preg_match_all('#@(.+)@#U', $condition, $matches);
336 foreach ($matches[1] as $nom) {
337 switch($saisies[$nom]['saisie']) {
340 $condition = preg_replace('#@'.preg_quote($nom).'@#U', '$(form).find("[name=\''.$nom.'\']:checked").val()', $condition);
343 $condition = preg_replace('#@'.preg_quote($nom).'@#U', '($(form).find("[name=\''.$nom.'\']").is(":checked") ? $(form).find("[name=\''.$nom.'\']").val() : "")', $condition);
346 $condition = preg_replace('#@'.preg_quote($nom).'@#U', '$(form).find("[name=\''.$nom.'\']").val()', $condition);
350 $sel = "li[data-id='$identifiant']";
352 $sel = "li.$class_li";
354 $code .= 'if ('.$condition.') {$(form).find("'.$sel.'").show(400);} ';
355 $code .= 'else {if (chargement==true) {$(form).find("'.$sel.'").hide(400).css("display","none");} else {$(form).find("'.$sel.'").hide(400);};} ';
359 $code .= '$("li#afficher_si_'.$id_form.'").parents("form").each(function(){verifier_saisies_'.$id_form.'(this);});';
360 $code .= '$("li#afficher_si_'.$id_form.'").parents("form").change(function(){verifier_saisies_'.$id_form.'(this);});';
361 $code .= 'chargement=false;})';
362 $code .= '})(jQuery);';
363 return $i>0 ?
$code : '';
367 * Lorsque l'on affiche les saisies (#VOIR_SAISIES), les saisies ayant une option afficher_si
368 * et dont les conditions ne sont pas remplies doivent être retirées du tableau de saisies.
370 * Cette fonction sert aussi lors de la vérification des saisies avec saisies_verifier().
371 * À ce moment là, les saisies non affichées sont retirées de _request
372 * (on passe leur valeur à NULL).
374 * @param array $saisies
375 * Tableau de descriptions de saisies
376 * @param array|null $env
377 * Tableau d'environnement transmis dans inclure/voi_saisies.html,
378 * NULL si on doit rechercher dans _request (pour saisies_verifier()).
380 * Tableau de descriptions de saisies
382 function saisies_verifier_afficher_si($saisies, $env=NULL) {
383 // eviter une erreur par maladresse d'appel :)
384 if (!is_array($saisies)) {
387 foreach ($saisies as $cle => $saisie) {
388 if (isset($saisie['options']['afficher_si'])) {
389 $condition = $saisie['options']['afficher_si'];
390 // On gère le cas @plugin:non_plugin@
391 preg_match_all('#@plugin:(.+)@#U', $condition, $matches);
392 foreach ($matches[1] as $plug) {
393 if (defined('_DIR_PLUGIN_'.strtoupper($plug)))
394 $condition = preg_replace('#@plugin:'.$plug.'@#U', 'true', $condition);
396 $condition = preg_replace('#@plugin:'.$plug.'@#U', 'false', $condition);
398 // On gère le cas @config:plugin:meta@ suivi d'un test
399 preg_match_all('#@config:(.+):(.+)@#U', $condition, $matches);
400 foreach ($matches[1] as $plugin) {
401 $config = lire_config($plugin);
402 $condition = preg_replace('#@config:'.$plugin.':'.$matches[2][0].'@#U', '"'.$config[$matches[2][0]].'"', $condition);
404 // On transforme en une condition valide
406 $condition = preg_replace('#@(.+)@#U', '_request(\'$1\')', $condition);
408 $condition = preg_replace('#@(.+)@#U', '$env["valeurs"][\'$1\']', $condition);
409 eval('$ok = '.$condition.';');
411 unset($saisies[$cle]);
412 if (is_null($env)) set_request($saisie['options']['nom'],NULL);
415 if (isset($saisies[$cle]['saisies'])) // S'il s'agit d'un fieldset ou equivalent, verifier les sous-saisies
416 $saisies[$cle]['saisies'] = saisies_verifier_afficher_si($saisies[$cle]['saisies'], $env);