From 0de62c218d856a80bcdac1c40447696669fe1e2f Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Wed, 26 Aug 2020 17:06:24 +0200 Subject: [PATCH] doc: fix info about LSobject and LSattribute event triggers configuration --- doc/conf/LSattribute.docbook | 28 ++++++++++--------- doc/conf/LSobject.docbook | 52 ++++++++++++++++++------------------ 2 files changed, 41 insertions(+), 39 deletions(-) diff --git a/doc/conf/LSattribute.docbook b/doc/conf/LSattribute.docbook index e80211b7..84022dcc 100644 --- a/doc/conf/LSattribute.docbook +++ b/doc/conf/LSattribute.docbook @@ -5,12 +5,12 @@ attrs de la configuration des &LSobjects;. Dans ce tableau, les clé les noms des attributs et les valeurs liés sont la configuration des attributs. - + Contrairement à ce qui existe dans le standard LDAP, les noms des attributs sont sensibles à la casse. Il faut que le nom des attributs dans &LdapSaisie; soient scrupuleusement les mêmes que ceux retourné par &netldap; - + Structure... array ( @@ -55,7 +55,7 @@ // Attributs en dépendance ), 'onDisplay' => 'fonction2' - + 'before_modify' => 'function1', 'after_modify' => 'function2' ), @@ -63,9 +63,9 @@ ... );]]> ... - - - + + + Paramètres de configuration @@ -166,7 +166,7 @@ generate_function Nom de la fonction permettant de générer la valeur de l'attribut. - Cette fonction sera éxecutée, en passant en premier paramètre, l'objet + Cette fonction sera éxecutée, en passant en premier paramètre, l'objet &LSobject; courant. @@ -243,7 +243,7 @@ dependAttrs - Tableau associatif listant les attributs dépendants de celui-ci. + Tableau associatif listant les attributs dépendants de celui-ci. Les attributs listés ici seront regénérés lors de chaque modification de l'attribut courant. Cette génération sera effectué avec la fonction définie dans le paramètre generate_function de @@ -264,7 +264,8 @@ before_modify - Nom de la fonction qui sera exécutée avant toutes modifications de + Chaîne de caractères (ou tableau de chaine de caractères) correspondant + au nom d'une ou plusieurs fonctions qui seront exécutées avant toutes modifications de la valeur de l'attribut.Voir la section concernée @@ -273,18 +274,19 @@ after_modify - Nom de la fonction qui sera exécutée après toutes modifications de + Chaîne de caractères (ou tableau de chaine de caractères) correspondant + au nom d'une ou plusieurs fonctions qui seront exécutées après toutes modifications de la valeur de l'attribut.Voir la section concernée - + &conf-LSattribute-LSattr_ldap; &conf-LSattribute-LSattr_html; - + &conf-LSattribute-check-data; &conf-LSattribute-validation; &conf-LSattribute-triggers; - + diff --git a/doc/conf/LSobject.docbook b/doc/conf/LSobject.docbook index 4081f4de..76550380 100644 --- a/doc/conf/LSobject.docbook +++ b/doc/conf/LSobject.docbook @@ -5,17 +5,17 @@ Cette partie décrit la manière de configurer les différents types de LSobjets manipulés par &LdapSaisie;. - + La configuration des &LSobjects; est stockée dans le dossier - /conf/LSobjects. Dans ce dossier, on retrouve un fichier par type + /conf/LSobjects. Dans ce dossier, on retrouve un fichier par type d'&LSobject;, nommé de la manière suivante : config.LSobjects.[nom du type d'LSobject].php - + Ce fichier contient la déclaration de la configuration du type d'&LSobject; - qui est stocké dans la variable globale + qui est stocké dans la variable globale $GLOBALS['LSobjects']['[nom du type d'LSobject]']. - + Structure... 'attr1', 'LSaddons' => [LSaddon(s)], - + 'container_dn' => 'ou=people', 'generate_container_dn' => '[callable]', 'container_auto_create' => array( @@ -38,13 +38,13 @@ ), 'disable_creation' => [boolean]', - + 'before_modify' => 'function1', 'after_modify' => 'function2', 'after_create' => 'function3', 'after_delete' => 'function4', - - 'label' => 'objet1', + + 'label' => 'objet1', 'display_name_format' => '[format]', 'displayAttrName' => '[booleen]', @@ -52,17 +52,17 @@ 'customActions' => array ( // Configuration des customActions pour ce type d'objet ), - + // LSrelation 'LSrelation' => array( // Configuration des LSrelations entre ce type d'objet et les autres ), - + // LSform 'LSform' => array ( // Configuration des formulaires de l'objet ), // fin LSform - + // LSsearch 'LSsearch' => array ( // Configuration des recherches de l'objet @@ -74,7 +74,7 @@ 'ioFormat' => array ( // Configuration des formats d'import/export de l'objet ), - + // Attributs 'attrs' => array ( // Configuration des attributs du type d'LSobjet @@ -82,7 +82,7 @@ );]]> ... - + Paramètres de configuration @@ -123,14 +123,14 @@ container_dn Elément pour construire le basedn de stockage - de ce type d'objet. Par exemple, si le basedn de + de ce type d'objet. Par exemple, si le basedn de l'annuaire est o=ls et que les objets utilisateurs sont stockés dans la branche de l'annuaire ou=people,o=ls, alors container_dn devra valoir ou=people. Lorsque l'annuaire possède des &subDn;, les objets seront cherchés dans le basedn résultant de la concaténation du paramètre - container_dn, d'une virgule et du + container_dn, d'une virgule et du basedn correspondant au &subDn; courant. @@ -150,7 +150,7 @@ Tableau associatif contenant les paramètres de configuration nécessaires à la création des container_dn dans les - nouveaux objets utilisés comme &subDn;. + nouveaux objets utilisés comme &subDn;. Voir la section concernée. @@ -167,8 +167,8 @@ before_modify - Chaîne de caractères correspondant au nom d'une fonction qui sera - exécutée avant la modification d'un objet. + Chaîne de caractères (ou tableau de chaine de caractères) correspondant + au nom d'une ou plusieurs fonctions qui seront exécutées avant la modification d'un objet. Voir la section concernée. @@ -177,8 +177,8 @@ after_modify - Chaîne de caractères correspondant au nom d'une fonction qui sera - exécutée après la modification d'un objet. + Chaîne de caractères (ou tableau de chaine de caractères) correspondant + au nom d'une ou plusieurs fonctions qui seront exécutées après la modification d'un objet. Voir la section concernée. @@ -187,8 +187,8 @@ after_create - Chaîne de caractères correspondant au nom d'une fonction qui sera - exécutée après la création d'un objet. + Chaîne de caractères (ou tableau de chaine de caractères) correspondant + au nom d'une ou plusieurs fonctions qui seront exécutées après la création d'un objet. Voir la section concernée. @@ -197,8 +197,8 @@ after_delete - Chaîne de caractères correspondant au nom d'une fonction qui sera - exécutée après la suppression d'un objet. + Chaîne de caractères (ou tableau de chaine de caractères) correspondant + au nom d'une ou plusieurs fonctions qui seront exécutées après la suppression d'un objet. Voir la section concernée. @@ -207,7 +207,7 @@ label - Nom générique au pluriel qualifiant le type d'objet. Exemple : + Nom générique au pluriel qualifiant le type d'objet. Exemple : Utilisateurs.