SPIP-Contrib

SPIP-Contrib

عربي | Deutsch | English | Español | français | italiano | Nederlands

290 Plugins, 198 contribs sur SPIP-Zone, 66 visiteurs en ce moment

Accueil > Outils pour plugins > Config (CFG) > API CFG : Paramètres des formulaires

API CFG : Paramètres des formulaires

30 mars 2008 – par Matthieu Marcillaud – commentaires

3 votes

CFG offre de nombreuses options pour paramétrer les formulaires CFG.

Ces paramètres interprétés après compilation par CFG du formulaire. Ils se déclarent en utilisant la syntaxe suivante :

Accès rapide


Descriptions : autoriser, boite, casier, colonne, depot, descriptif, head, liens, liens_multi, nom, onglet, refus, table, titre

Exemples : casier,onglets,liens

Aperçu des paramètres

Propriété Description
autoriser Type d’autorisation pour l’accès au formulaire
boite Titre de la boite du formulaire
casier Faire une arborescence dans le stockage
colonne Colonne de stockage
depot Choix du lieu de depot : meta, metapack, php, table, tablepack
descriptif Descriptif affiché
head Ajoute du contenu dans le head de l’espace privé
liens* Liens vers d’autres CFG
liens_multi* Liens vers des CFG « multi »
nom Nom du stockage
onglet Cacher/afficher l’onglet du formulaire CFG
refus Message de refus en cas de non autorisation
table Table de stockage
titre Titre du formulaire

Les paramètres en détail


autoriser
Permet de déclarer le type d’autorisation nécessaire pour l’accès à la page de configuration


boite
Le titre de la boite formulaire, défaut titre si présent, ’Configuration quelque_chose" sinon


casier
Elle permet optionnellement de stocker les champs de formulaire dans un tableau.

Si nom=monsquelette et casier=chose, alors on récupère les valeurs par #CONFIG{monsquelette/chose/nom_du_champ}

Note sur casier :
Il est possible d’indiquer des sous tableau dans casier :
<!-- casier=option/navigation -->. On récupère alors les valeurs du formulaire par #CONFIG{squelette/option/navigation/champ_du_formulaire}


colonne
Selectionne une colonne particulière avec le storage ’tablepack’ (par défaut ’extra’ qui évoluera peut être)


depot
Permet de stocker les valeurs ailleurs que dans spip_meta (metapack). Stockage possible :

  • meta : comme le fait SPIP avec le stockage des metas,
  • metapack : dans une entrée de la table spip_meta
  • php : dans un fichier php dans le repertoire /local/cfg,
  • table : dans une ligne d’une table sql (nécessite un champs cfg_id)
  • tablepack : colonne que l’on choisit dans une table (défaut ’extra’)


descriptif
Le descriptif affiché en haut de colonne gauche


head
(v1.3.7) Ajoute du contenu dans le head (html) de l’espace privé.
Attention, ce contenu ne sera pas présent en passant par #FORMULAIRE_CFG


liens*
Les liens sur autre cfg affichés dans cette colonne

  • exemple : <!-- liens*=prefixe:quelque_chose -->
  • ’prefixe :’ permet de selectionner la chaine de langue
    <:prefixe:quelque_chose :> comme titre du lien.
  • Ce paramètre nécessite une * [1]


liens_multi*
(v1.3) Liens vers un fond cfg qui utilise des identifiants multiples : ce lien ajoute un formulaire


nom
Le nom du meta où sera stockée la configuration, par défaut c’est le nom du formulaire, xxx dans fonds/cfg_xxx


onglet
Elle permet d’afficher (par défaut) ou non un onglet dans la page ecrire/?exec=cfg. Cet onglet prend le nom du fichier fond (toto, si le fichier s’appelle cfg_toto.html).

Ainsi, si un plugin/squelette possède plusieurs fonds, cela permet de limiter le nombre d’onglets sur la page. Il est possible d’indiquer quel est l’onglet "parent" dans un fond CFG en mettant <!-- onglet=nom_du_parent -->


refus
Permet de définir un message spécifique en cas de non autorisation à la page de configuration


table
Permet de définir la table de stockage (dans les cas avec storage=tablepack ou table)


titre
Un des 2 titres, fera le gros titre si boite est aussi présent

Exemple des propriétés onglets, liens et casier

Prenons l’exemple d’un squelette qui utilise 2 fonds distincts (cfg_squelette, cfg_squelette_complement). On peut définir les fichiers comme cela :

  • cfg_squelette
  • cfg_squelette_complement

Les 2 fonds vont s’enregistrer dans la variable de spip_meta ’squelette’. Le fonds/cfg_squelette_complement.html va se stocker dans ’squelette/option’ (casier=option) : on pourra donc faire #CONFIG{squelette/option/champ_du_formulaire}.

Seul un lien vers le premier fond (squelette) sera affiché dans la page /ecrire/?exec=cfg car l’autre fond à la variable onglet définie (et différent de ’oui’).

Notes

[1Lorsque la propriété est un tableau auquel on veut rajouter un élément, il faut faire précéder le = par une astérisque * comme :
<!--  liens*=crayons -->

Dernière modification de cette page le 15 mai 2009

Retour en haut de la page

Vos commentaires

  • Le 20 avril 2011 à 12:37, par fish En réponse à : API CFG : Paramètres des formulaires

    Bonjour,

    Après quelques tests , il apparait qu’il y a une erreur dans la méthode ajouter_erreur($champ, $message) , en effet si on regarde les sources on utilise la variable $champs et $champ pour placer le message d’erreur.

    Résultat le message d’erreur est ajouter avec la chaîne vide.

    Il faudrait donc corriger dans la prochaine release.

    Là ou ça coince :

    1.         /**
    2.          * ajoute une erreur sur un champ donne
    3.          *
    4.          * @param string $champ
    5.          * @param string $message
    6.          */
    7.         function ajouter_erreur({{$champ}}, $message) {
    8.                 $this->messages['erreurs'][{{$champs}}] = isset($this->messages['erreurs'][{{$champs}}])
    9.                         ? $this->messages['erreurs'][{{$champs}}] .= '<br />' . $message
    10.                         : $message;
    11.         }

    Télécharger

    Répondre à ce message

  • Le 18 avril 2008 à 18:30, par chryjs En réponse à : API CFG : Paramètres des formulaires - affichage optionnel

    Si je comprend bien
    liens*=toto donne l’affichage d’un lien vers la page de configuration toto (fond=toto) dans un menu à droite.

    Est-il possible de rendre l’affichage de ce lien optionnel genre :

    [(#CONFIG{monplug/mavariabledeconf}|=={oui}|?{' ',''})
    <!-- lien*=toto -->]

    Répondre à ce message

Répondre à cet article

Qui êtes-vous ?

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici Les choses à faire avant de poser une question (Prolégomènes aux rapports de bugs. )
Ajouter un document

Retour en haut de la page

Ça discute par ici

  • Twitter

    17 juin 2013 – 100 commentaires

    Un plugin qui facilite l’intégration de Twitter dans un site SPIP et permet : d’envoyer facilement des messages avec un ou plusieurs comptes Twitter d’afficher des Widgets standards dans le site public (qui respectent la vie privée des visiteurs) (...)

  • Polyhiérarchie

    14 juillet 2009 – 189 commentaires

    Ce plugin permet de rattacher un article ou une rubrique à plusieurs rubriques parentes.

  • Plugin SPIP-Géoportail

    17 août 2010 – 478 commentaires

    Plugin pour l’intégration d’objets géographiques dans SPIP avec l’API Géoportail. Affichage de cartes Géoportail, OpenStreetMap (OSM), Google Maps, Bing ou Yahoo !... Nouvelle version Suite au changement de version de l’API géoportail et des (...)

  • Plugin Vidéo(s)

    23 novembre 2010 – 703 commentaires

    Interface de gestion et modèle d’insertion des vidéos : Dailymotion Vimeo Youtube Modèle de la balise HTML5 video avec alternative flash html5media : Lecture HTML5/Flash pour tout navigateur des fichiers MP4/H264/Ogg/WebM/Mkv Support mobile, iPad, (...)

  • Ferme à SPIP

    3 janvier 2008 – 152 commentaires

    Un petit article synthétique qui explique en quelques mots et captures d’écrans comment faire une « ferme à SPIP » avec le plugin "Mutualisation" à partir d’un nom de domaine principal.