Skip to content

Configuration des modules

etienne edited this page Sep 12, 2010 · 4 revisions

Chaque module peut contenir des réglages qui toucheront son installation et son affichage. Ils sont contenus dans le fichier config/config.ini, à l’intérieur du dossier du module.

Réglages possibles

Les réglages qui ne sont pas spécifiés auront une valeur nulle, ce qui équivaut à false pour les réglages booléens.

Types de réglages

  • Booléen : valeur binaire; true, yes et 1 sont équivalents, ainsi que no, false et 0.
  • Liste : sous la forme <item1, item2, …>.
  • Texte : Chaîne de caractères. Doit être encadré par des guillemets si le texte contient des espaces.
  • Rôle : Soit admin, webmaster, guest ou user.

Réglages primaires

  • adminExportFields : Liste. Noms des champs qui seront exportés en CSV dans l’interface d’administration. La présence de ce réglage active l’affichage du lien “Exporter”.
  • adminListFields : Liste. Noms des champs qui seront affichés dans la liste des items dans l’interface d’administration.
  • adminListSortBy : Texte. Nom du champ qui sera utilisé comme ordre de classement par défaut dans l’interface d’administration.
  • allowSort : Booléen. Permet de classer les items dans un ordre arbitraire.
  • autoPaths : Booléen. Signifie que les items associés à ce module se feront assigner un path déterminé automatiquement. Pour contrôler le path, utiliser la méthode Module→GetPath().
  • canInsert : Rôle. Niveau de privilège requis pour insérer des nouveaux items.
  • canUpdate : Rôle. Niveau de privilège requis pour mettre à jour des items existants.
  • canDelete : Rôle. Niveau de privilège requis pour effacer des items.
  • hideFromAdmin : Booléen. Désactive l’affichage du module dans le menu d’administration.
  • keyField : Texte. Le nom du champ-clé, c’est-à-dire celui qui sera sollicité par Jag lorsqu’on veut obtenir une représentation courte d’un item (en général, son titre).
  • singleItem : Booléen. Signifie que le module ne comporte qu’un seul item, et donc que ses données seront stockées dans le système de fichier (dans app/data) plutôt que dans la base de données.

Réglages secondaires

Les réglages secondaires sont des groupes de réglages et doivent obligatoirement apparaître après les réglages primaires. Les titres des groupes doivent apparaître sur leur ligne encadrés de crochets.

Clone this wiki locally