bn8/ldapsaisie
1
0
Fork 0
mirror of https://gitlab.easter-eggs.com/ee/ldapsaisie.git synced 2024-11-18 00:09:06 +01:00
Code Issues Projects Releases Wiki Activity
ldapsaisie/doc/conf/globale.docbook
Benjamin Renard d8975aff0b - functions : 
-> Ajout de la fonction __() : fonction de traduction utilisant à la fois le tableau globale LSlang
     et gettext pour traduire les messages qu'on lui passe.
  -> Ajout de la fonction tr() : fonction utilisable depuis les templates pour traduire une variable
     smarty.
- LSexample :
  -> Utilisation de la traduction via __() plutôt que gettext
- LSdefault :
  -> Creation d'un template pour la gestion des outils apporté par LSdefaut (LSerror, LSdebug, ...)
  -> Ajout de méthode de gestion de LSlang
- LSsession :
  - Login/RecoverPassword : Utilisation du template LSdefault
  - Gestion de la traduction :
    -> Ajout de la méthode setLocale() définissant la langue de l'interface.
      -> Ajout des méthodes getLangList() et localeExist()
    -> Le session_start() se fait dans l'initialize désormais (pour gérer la langue même déconnecté)
    -> Méthode setLdapServer() : rédifinition de la locale avec setLocale()
    -> Ajout de LSlang : outil JS permetant dans l'interface de choisir sa langue
- Config :
  -> De manière général, il ne doit plus y avoir d'appel de la fonction _() dans les fichiers de config, les
     chaînes sont données non traduite, et la traduction se fera lors de leur utilisation.
    -> Tout les labels et messages déclarer dans la config, est maintenant traduit du coté code PHP avec la
       fonction __()
  -> L'enconding et la langue sont désormais géré indépendament
- ViewList : Les noms des boutons (New,Refresh,...) ne sont plus traduit du côté PHP mais dans le template à
  cause de leur mise en cache.
- Documentation :
  -> Mise à jour relative en changement de paramètres de configuration
  -> Ajout des informations sur les variables et constantes indépendantes du fichier de configuration config.inc.php
  -> Mise à jour du fichier INSTALL avec les informations de la documentation
2009-03-19 17:42:51 +00:00

323 lines
9.1 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8" ?>
<sect1 id='config-globale'>
<title>Configuration globale</title>
<para>
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
$GLOBALS['LSconfig'] = array(
// Variables globales
);
// Variables et constantes indépendantes
$var1 = 'val1'
$var2 = 'val2'
...
define('CONST1','val1')
define('CONST2','val2')
...
?>]]>
</programlisting>
<sect2>
<title>Variables globales</title>
<!-- Début Variables globales -->
<variablelist>
<varlistentry>
<term>NetLDAP2</term>
<listitem>
<simpara>Chemin vers la librairie PEAR &netldap;.</simpara>
<informalexample>
<programlisting><![CDATA[/usr/share/php/Net/LDAP2.php]]></programlisting>
</informalexample>
</listitem>
</varlistentry>
<varlistentry>
<term>Smarty</term>
<listitem>
<simpara>Chemin vers le moteur de template &smarty;.</simpara>
<informalexample>
<programlisting><![CDATA[/usr/share/php/smarty/libs/Smarty.class.php]]></programlisting>
</informalexample>
</listitem>
</varlistentry>
<varlistentry>
<term>lang</term>
<listitem>
<simpara>Paramètre utilisé pour l'internationalisation : code de la langue.</simpara>
<informalexample>
<programlisting><![CDATA[fr_FR]]></programlisting>
<programlisting><![CDATA[en_US]]></programlisting>
</informalexample>
</listitem>
</varlistentry>
<varlistentry>
<term>encoding</term>
<listitem>
<simpara>Encodage de caractère.</simpara>
<informalexample>
<programlisting><![CDATA[UTF8]]></programlisting>
</informalexample>
</listitem>
</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>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>
</listitem>
</varlistentry>
</variablelist>
&conf-srv-ldap;
</sect2>
<sect2>
<title>Variables et constantes indépendantes</title>
<!-- Début Variables globales -->
<variablelist>
<varlistentry>
<term>LS_THEME</term>
<listitem>
<simpara>Constante déterminant le nom du theme utilisé.</simpara>
<simpara>Valeur par défaut : <emphasis>default</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_TEMPLATES_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier des templates.</simpara>
<simpara>Valeur par défaut : <emphasis>templates/LS_THEME</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_IMAGES_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier des images.</simpara>
<simpara>Valeur par défaut : <emphasis>images/LS_THEME</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_CSS_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier des CSS.</simpara>
<simpara>Valeur par défaut : <emphasis>css/LS_THEME</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>$GLOBALS['LSdebug']['active']</term>
<listitem>
<simpara>Variable booléenne déterminant si le mode debug est activé.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>$GLOBALS['LSlog']['enable']</term>
<listitem>
<simpara>Variable booléenne déterminant si les logs sont activés.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>$GLOBALS['LSlog']['filename']</term>
<listitem>
<simpara>Variable déterminant le chemin du fichier de log.</simpara>
<simpara>Valeur par défaut : <emphasis>/tmp/LS.log</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>NB_LSOBJECT_LIST</term>
<listitem>
<simpara>Constante déterminant le nombre d'objet affichés par page de résultat
de recherche.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>NB_LSOBJECT_LIST_SELECT</term>
<listitem>
<simpara>Constante déterminant le nombre d'objet affichés par page de résultat
de recherche dans une fenêtre &LSselect;.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>MAX_SEND_FILE_SIZE</term>
<listitem>
<simpara>Constante déterminant la taille maximale d'un fichier envoyé à travers
les formulaires.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_CONF_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier de configuration.</simpara>
<simpara>Valeur par défaut : <emphasis>conf/</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_OBJECTS_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier de configuration.</simpara>
<simpara>Valeur par défaut : <emphasis>LS_CONF_DIR/LSobjects/</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_INCLUDE_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier d'inclusion.</simpara>
<simpara>Valeur par défaut : <emphasis>includes/</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_CLASS_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier d'inclusion des classes.</simpara>
<simpara>Valeur par défaut : <emphasis>LS_INCLUDE_DIR/class/</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_LIB_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier d'inclusion des librairies.</simpara>
<simpara>Valeur par défaut : <emphasis>LS_INCLUDE_DIR/libs/</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_ADDONS_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier d'inclusion des addons.</simpara>
<simpara>Valeur par défaut : <emphasis>LS_INCLUDE_DIR/addons/</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_JS_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier d'inclusion du JavaScript.</simpara>
<simpara>Valeur par défaut : <emphasis>LS_INCLUDE_DIR/js/</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_TMP_DIR</term>
<listitem>
<simpara>Constante déterminant le chemin du dossier des fichiers temporaires.</simpara>
<simpara>Valeur par défaut : <emphasis>tmp/</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>$GLOBALS['defaultJSscipts']</term>
<listitem>
<simpara>Tableau déterminant les fichiers CSS à charger sur toute les pages.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_TEXT_DOMAIN</term>
<listitem>
<simpara>Constante déterminant le domaine gettext utilisé par le projet.</simpara>
<simpara>Valeur par défaut : <emphasis>ldapsaisie</emphasis></simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>LS_I18N_DIR</term>
<listitem>
<simpara>Constante déterminant chemin du dossier d'internationalisation.</simpara>
<simpara>Valeur par défaut : <emphasis>lang</emphasis></simpara>
</listitem>
</varlistentry>
</variablelist>
</sect2>
&conf-LSformat;
&conf-LDAP_search_params;
</sect1>
Reference in a new issue View git blame Copy permalink