LSsession: fix/improve methods & doc about global preference parameters

doc/conf/globale.docbook

@@ -2,10 +2,10 @@
 <sect1 id='config-globale'>
   <title>Configuration globale</title>
   <para>
-    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
     <filename>config.inc.php</filename>.
   </para>
-  
+
 <programlisting linenumbering="unnumbered">
 <citetitle>Structure</citetitle>
 <![CDATA[// Variables globales
@@ -87,16 +87,33 @@ define('CONST2','val2')
   </listitem>
 </varlistentry>
 
+<varlistentry>
+  <term>ldap_servers</term>
+  <listitem>
+    <simpara>Configuration des serveurs LDAP.
+    <link linkend="config-srv-ldap">Voir section concernée</link>.</simpara>
+  </listitem>
+</varlistentry>
+
+</variablelist>
+
+<sect3>
+<title>Préférences globales</title>
+
+<important><simpara>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.</simpara></important>
+
+<variablelist>
 
 <varlistentry>
   <term>cacheLSprofiles</term>
   <listitem>
-    <simpara>Activation/Désactivation de la mise en cache des profils des 
+    <simpara>Activation/Désactivation de la mise en cache des profils des
     utilisateurs connectés (&LSprofiles;).</simpara>
     <simpara>Valeurs possibles : <literal>True</literal> ou <literal>False</literal></simpara>
     <simpara>Valeur recommandée : <literal>True</literal></simpara>
-    <important><simpara>Ce paramètre a une action globale mais non prioritaire 
-    sur le comportement de l'application.</simpara></important>
+    <simpara>Valeur par défaut : <literal>False</literal></simpara>
   </listitem>
 </varlistentry>
 
@@ -104,13 +121,11 @@ define('CONST2','val2')
 <varlistentry>
   <term>cacheSubDn</term>
   <listitem>
-    <simpara>Activation/Désactivation de la mise en cache des niveaux de 
+    <simpara>Activation/Désactivation de la mise en cache des niveaux de
     connexion (&subDn;) dans l'annuaire.</simpara>
-    <simpara>Valeurs possibles : <emphasis>True</emphasis> ou <emphasis>False</emphasis></simpara>
-    <simpara>Valeur recommandée : <emphasis>True</emphasis></simpara>
-    
-    <important><simpara>Ce paramètre a une action globale mais non prioritaire 
-    sur le comportement de l'application.</simpara></important>
+    <simpara>Valeurs possibles : <literal>True</literal> ou <literal>False</literal></simpara>
+    <simpara>Valeur recommandée : <literal>True</literal></simpara>
+    <simpara>Valeur par défaut : <literal>False</literal></simpara>
   </listitem>
 </varlistentry>
 
@@ -118,14 +133,12 @@ define('CONST2','val2')
 <varlistentry>
   <term>cacheSearch</term>
   <listitem>
-    <simpara>Activation/Désactivation de la mise en cache du résultat des 
+    <simpara>Activation/Désactivation de la mise en cache du résultat des
     recherches dans l'annuaire.</simpara>
-    <simpara>Valeurs possibles : <emphasis>True</emphasis> ou 
-    <emphasis>False</emphasis></simpara>
-    <simpara>Valeur recommandée : <emphasis>True</emphasis></simpara>
-    
-    <important><simpara>Ce paramètre a une action globale mais non prioritaire 
-    sur le comportement de l'application.</simpara></important>
+    <simpara>Valeurs possibles : <literal>True</literal> ou
+    <literal>False</literal></simpara>
+    <simpara>Valeur recommandée : <literal>True</literal></simpara>
+    <simpara>Valeur par défaut : <literal>False</literal></simpara>
   </listitem>
 </varlistentry>
 
@@ -135,9 +148,9 @@ define('CONST2','val2')
   <listitem>
     <simpara>Activation/Désactivation de la recherche globale dans l'annuaire.
     </simpara>
-    <simpara>Valeurs possibles : <emphasis>True</emphasis> ou
-    <emphasis>False</emphasis></simpara>
-    <simpara>Valeur par défaut : <emphasis>True</emphasis></simpara>
+    <simpara>Valeurs possibles : <literal>True</literal> ou
+    <literal>False</literal></simpara>
+    <simpara>Valeur par défaut : <literal>True</literal></simpara>
   </listitem>
 </varlistentry>
 
@@ -146,25 +159,16 @@ define('CONST2','val2')
   <term>keepLSsessionActive</term>
   <listitem>
     <simpara>Activation/Désactivation du maintient de la LSsession active.</simpara>
-    <simpara>Valeurs possibles : <emphasis>True</emphasis> ou 
-    <emphasis>False</emphasis></simpara>
-    
-    <important><simpara>Ce paramètre a une action globale mais non prioritaire 
-    sur le comportement de l'application.</simpara></important>
-  </listitem>
-</varlistentry>
-
-
-<varlistentry>
-  <term>ldap_servers</term>
-  <listitem>
-    <simpara>Configuration des serveurs LDAP. 
-    <link linkend="config-srv-ldap">Voir section concernée</link>.</simpara>
+    <simpara>Valeurs possibles : <literal>True</literal> ou
+    <literal>False</literal></simpara>
+    <simpara>Valeur par défaut : <literal>False</literal></simpara>
   </listitem>
 </varlistentry>
 
 </variablelist>
 
+</sect3>
+
 &conf-srv-ldap;
 
 </sect2>

doc/conf/srv-ldap.docbook

@@ -180,6 +180,8 @@ serveur LDAP.</para>
   <listitem>
     <simpara>Activation/Désactivation de la mise en cache des &LSprofiles; des
     utilisateurs connectés à ce serveur.</simpara>
+    <simpara>Valeur par défaut : <emphasis>valeur de la variable globale
+    du même nom</emphasis></simpara>
   </listitem>
 </varlistentry>
 
@@ -189,6 +191,8 @@ serveur LDAP.</para>
   <listitem>
     <simpara>Activation/Désactivation de la mise en cache du résultat des
     recherches sur ce serveur.</simpara>
+    <simpara>Valeur par défaut : <emphasis>valeur de la variable globale
+    du même nom</emphasis></simpara>
   </listitem>
 </varlistentry>
 
@@ -199,6 +203,8 @@ serveur LDAP.</para>
     <simpara>Activation/Désactivation de la recherche globale sur ce serveur
     en particulier. Par defaut, la valeur du paramètre global
     <literal>globalSearch</literal> est utilisée.</simpara>
+    <simpara>Valeur par défaut : <emphasis>valeur de la variable globale
+    du même nom</emphasis></simpara>
   </listitem>
 </varlistentry>
 
@@ -284,6 +290,8 @@ serveur LDAP.</para>
     <simpara>Activation/Désactivation du maintient de la LSsession active.</simpara>
     <simpara>Valeurs possibles : <emphasis>True</emphasis> ou
     <emphasis>False</emphasis></simpara>
+    <simpara>Valeur par défaut : <emphasis>valeur de la variable globale
+    du même nom</emphasis></simpara>
   </listitem>
 </varlistentry>
 

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
+      )
+    );
   }
 
   /**