From 712d18b09fa99d5f2602973c90cfc34637fb759e Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Thu, 6 Aug 2020 13:48:43 +0200 Subject: [PATCH] LSsession: fix/improve methods & doc about global preference parameters --- doc/conf/globale.docbook | 74 ++++++++++++++------------ doc/conf/srv-ldap.docbook | 8 +++ src/includes/class/class.LSsession.php | 37 +++++++++++-- 3 files changed, 79 insertions(+), 40 deletions(-) diff --git a/doc/conf/globale.docbook b/doc/conf/globale.docbook index efaf96be..d5b10914 100644 --- a/doc/conf/globale.docbook +++ b/doc/conf/globale.docbook @@ -2,10 +2,10 @@ Configuration globale - La plus grande partie de la configuration globale se trouve dans le fichier + La plus grande partie de la configuration globale se trouve dans le fichier config.inc.php. - + Structure + + ldap_servers + + Configuration des serveurs LDAP. + Voir section concernée. + + + + + + +Préférences globales + +Les variables globales suivantes ont une action globale, mais +non-prioritaire sur le comportement de l'application. Il peux être redéfini pour +chacun des serveurs LDAP. + + cacheLSprofiles - Activation/Désactivation de la mise en cache des profils des + Activation/Désactivation de la mise en cache des profils des utilisateurs connectés (&LSprofiles;). Valeurs possibles : True ou False Valeur recommandée : True - Ce paramètre a une action globale mais non prioritaire - sur le comportement de l'application. + Valeur par défaut : False @@ -104,13 +121,11 @@ define('CONST2','val2') cacheSubDn - Activation/Désactivation de la mise en cache des niveaux de + Activation/Désactivation de la mise en cache des niveaux de connexion (&subDn;) dans l'annuaire. - Valeurs possibles : True ou False - Valeur recommandée : True - - Ce paramètre a une action globale mais non prioritaire - sur le comportement de l'application. + Valeurs possibles : True ou False + Valeur recommandée : True + Valeur par défaut : False @@ -118,14 +133,12 @@ define('CONST2','val2') cacheSearch - Activation/Désactivation de la mise en cache du résultat des + Activation/Désactivation de la mise en cache du résultat des recherches dans l'annuaire. - Valeurs possibles : True ou - False - Valeur recommandée : True - - Ce paramètre a une action globale mais non prioritaire - sur le comportement de l'application. + Valeurs possibles : True ou + False + Valeur recommandée : True + Valeur par défaut : False @@ -135,9 +148,9 @@ define('CONST2','val2') Activation/Désactivation de la recherche globale dans l'annuaire. - Valeurs possibles : True ou - False - Valeur par défaut : True + Valeurs possibles : True ou + False + Valeur par défaut : True @@ -146,25 +159,16 @@ define('CONST2','val2') keepLSsessionActive Activation/Désactivation du maintient de la LSsession active. - Valeurs possibles : True ou - False - - Ce paramètre a une action globale mais non prioritaire - sur le comportement de l'application. - - - - - - ldap_servers - - Configuration des serveurs LDAP. - Voir section concernée. + Valeurs possibles : True ou + False + Valeur par défaut : False + + &conf-srv-ldap; diff --git a/doc/conf/srv-ldap.docbook b/doc/conf/srv-ldap.docbook index 34721f96..130c3a9e 100644 --- a/doc/conf/srv-ldap.docbook +++ b/doc/conf/srv-ldap.docbook @@ -180,6 +180,8 @@ serveur LDAP. Activation/Désactivation de la mise en cache des &LSprofiles; des utilisateurs connectés à ce serveur. + Valeur par défaut : valeur de la variable globale + du même nom @@ -189,6 +191,8 @@ serveur LDAP. Activation/Désactivation de la mise en cache du résultat des recherches sur ce serveur. + Valeur par défaut : valeur de la variable globale + du même nom @@ -199,6 +203,8 @@ serveur LDAP. Activation/Désactivation de la recherche globale sur ce serveur en particulier. Par defaut, la valeur du paramètre global globalSearch est utilisée. + Valeur par défaut : valeur de la variable globale + du même nom @@ -284,6 +290,8 @@ serveur LDAP. Activation/Désactivation du maintient de la LSsession active. Valeurs possibles : True ou False + Valeur par défaut : valeur de la variable globale + du même nom diff --git a/src/includes/class/class.LSsession.php b/src/includes/class/class.LSsession.php index bf34a46c..9eb879fe 100644 --- a/src/includes/class/class.LSsession.php +++ b/src/includes/class/class.LSsession.php @@ -2464,7 +2464,12 @@ class LSsession { * @retval boolean True si le cache des droits est activé, false sinon. */ public static function cacheLSprofiles() { - return ( (LSconfig :: get('cacheLSprofiles')) || (self :: $ldapServer['cacheLSprofiles']) ); + return LSconfig :: get( + 'cacheLSprofiles', + LSconfig :: get('cacheLSprofiles', false, 'bool'), // Default + 'bool', + self :: $ldapServer + ); } /** @@ -2475,7 +2480,12 @@ class LSsession { * @retval boolean True si le cache des subDn est activé, false sinon. */ public static function cacheSudDn() { - return ( (LSconfig :: get('cacheSubDn')) || (self :: $ldapServer['cacheSubDn'])); + return LSconfig :: get( + 'cacheSubDn', + LSconfig :: get('cacheSubDn', false, 'bool'), // Default + 'bool', + self :: $ldapServer + ); } /** @@ -2486,7 +2496,12 @@ class LSsession { * @retval boolean True si le cache des recherches est activé, false sinon. */ public static function cacheSearch() { - return ( (LSconfig :: get('cacheSearch')) || (self :: $ldapServer['cacheSearch'])); + return LSconfig :: get( + 'cacheSearch', + LSconfig :: get('cacheSearch', false, 'bool'), // Default + 'bool', + self :: $ldapServer + ); } /** @@ -2497,7 +2512,12 @@ class LSsession { * @retval boolean True if global search is enabled, false instead */ public static function globalSearch() { - return LSconfig :: get('globalSearch', LSconfig :: get('globalSearch', true, 'bool'), 'bool', self :: $ldapServer); + return LSconfig :: get( + 'globalSearch', + LSconfig :: get('globalSearch', true, 'bool'), // Default + 'bool', + self :: $ldapServer + ); } /** @@ -2508,7 +2528,14 @@ class LSsession { * @retval string Le label des niveaux pour le serveur ldap dourant */ public static function getSubDnLabel() { - return (self :: $ldapServer['subDnLabel']!='')?__(self :: $ldapServer['subDnLabel']):_('Level'); + return __( + LSconfig :: get( + 'subDnLabel', + ___('Level'), // default value (to translate) + 'string', + self :: $ldapServer + ) + ); } /**