bn8/ldapsaisie
1
0
Fork 0
mirror of https://gitlab.easter-eggs.com/ee/ldapsaisie.git synced 2024-11-23 02:19:07 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse source
This commit is contained in:
Benjamin Renard 2020-08-06 13:48:43 +02:00
parent 626e0d854c
commit 712d18b09f
3 changed files with 79 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

140
doc/conf/globale.docbook
View file

@ -87,74 +87,6 @@ define('CONST2','val2')
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term>cacheLSprofiles</term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term>cacheSubDn</term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term>cacheSearch</term>
<listitem>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term>globalSearch</term>
<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>
</listitem>
</varlistentry>
<varlistentry>
<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> <varlistentry>
<term>ldap_servers</term> <term>ldap_servers</term>
<listitem> <listitem>
@ -165,6 +97,78 @@ define('CONST2','val2')
</variablelist> </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
utilisateurs connectés (&LSprofiles;).</simpara>
<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>
<varlistentry>
<term>cacheSubDn</term>
<listitem>
<simpara>Activation/Désactivation de la mise en cache des niveaux de
connexion (&subDn;) dans l'annuaire.</simpara>
<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>
<varlistentry>
<term>cacheSearch</term>
<listitem>
<simpara>Activation/Désactivation de la mise en cache du résultat des
recherches dans l'annuaire.</simpara>
<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>
<varlistentry>
<term>globalSearch</term>
<listitem>
<simpara>Activation/Désactivation de la recherche globale dans l'annuaire.
</simpara>
<simpara>Valeurs possibles : <literal>True</literal> ou
<literal>False</literal></simpara>
<simpara>Valeur par défaut : <literal>True</literal></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>keepLSsessionActive</term>
<listitem>
<simpara>Activation/Désactivation du maintient de la LSsession active.</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; &conf-srv-ldap;
</sect2> </sect2>

8
doc/conf/srv-ldap.docbook
View file

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

37
src/includes/class/class.LSsession.php
View file

@ -2464,7 +2464,12 @@ class LSsession {
* @retval boolean True si le cache des droits est activé, false sinon. * @retval boolean True si le cache des droits est activé, false sinon.
*/ */
public static function cacheLSprofiles() { 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. * @retval boolean True si le cache des subDn est activé, false sinon.
*/ */
public static function cacheSudDn() { 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. * @retval boolean True si le cache des recherches est activé, false sinon.
*/ */
public static function cacheSearch() { 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 * @retval boolean True if global search is enabled, false instead
*/ */
public static function globalSearch() { 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 * @retval string Le label des niveaux pour le serveur ldap dourant
*/ */
public static function getSubDnLabel() { public static function getSubDnLabel() {
return (self :: $ldapServer['subDnLabel']!='')?__(self :: $ldapServer['subDnLabel']):_('Level'); return __(
LSconfig :: get(
'subDnLabel',
___('Level'), // default value (to translate)
'string',
self :: $ldapServer
)
);
} }
/** /**