Le fichier de paramétrage

Publié le : 26-01-2019 14:33

Le fichier global.xml regroupe les différents éléments du paramètrage sur différents niveaux (générique, applicatif, module, méthode).

Le bloc project_status suivant permet de définir si l'application est en développement ou en maintenance.

  l'attribut status définit l'état (valeurs attendues 1 ou 0)

<project_status>
	<add key="DEV" status="0"/>
	<add key="MAINTENANCE" status="0"/>
</project_status>

Le bloc dictionnary permet de définir des couples clé/valeur ainsi que des niveaux d'accessibilité à ces informations.

L'attribut is_locked précise qu'une fois initialisée la valeur ne peut être modifiée (valeurs attendues 1 ou 0)

L'attribut is_security précise que la donnée ne sera pas remonté dans la fonction Get_XML() de l'objet Configuration mais le sera dans la fonction Get_Unsafe_XML()

L'attribut is_master_security précise que la donnée ne sera pas remonté dans la fonction Get_XML() de l'objet Configuration ni dans la fonction Get_Unsafe_XML()

<dictionnary>
    <add key="MACLE_TECHNIQUE" value="Ma valeur" is_locked="1" is_security="1" is_master_security="1"/>
</dictionnary>

Le bloc applications permet de définir les applications hébergées par le serveur.

L'attribut default_use précise l'application à utiliser nativement lors de l'initialisation de l'objet Configuration (valeur attendue la valeur de l'attribut name d'un noeud application)

<applications default_use="Default">

     <application name="Default">
     </application>

     <application name="Interfaces">
     </application>

</applications>

Le bloc application permet de définir les modules que l'application peut utiliser ainsi que les droits d'accès, l'emplacement dans les différents menus, l'emplacement dans l'arborescence du site.

Le noeud application peut recevoir des attributs :

 (optionel) interface définit si l'application est une plateforme d'échange avec l'extérieur qui ne passe pas par un utilisateur (typiquement une page de déversement ou de récupération pour un système de cloud)

Une application contient des modules qui contiennent eux mêmes des méthodes (getters ou setters).

Détails d'un noeud de type module :

 module définit le nom unique du module.

 (optionel) url définit si le menu doit restituer le lien en utilisant l'appel asynchrone ou un lien classique. Pour un lien classique, il suffit d'y ajouter le nom de l'url (sans le nom de domaine)

 (optionel) log définit si il faut exclure le module du système de journalisation (valeur attendu 0 pour exclure toute autre valeur l'inclut)

(optionel) disabled définit si le module ne doit pas être utilisé (présent juste via l'écran d'administration)

 min_level_access définit le niveau des droits d'accès minimums obligatoire (de -2 à 5 pour visibilité dans le menu et pour accès).

 max_level_access définit le niveau des droits d'accès maximum (de -2 à 5 pour visibilité dans le menu et pour accès).

 path désigne l'emplacement du fichier de la Vue du module.

 Le noeud settings englobe les couples clé/valeur de paramétrages niveau module.

 Le noeud getters englobe les méthodes quoi doivent être présente dans le fichier Module_V.php  (restitution visuel, export, etc.)

Le noeud setters englobe les méthodes qui doivent êtres présentes dans le fichier Module_M.php (altération d'objet, de données, etc.)

Détails d'un noeud de type get :

method définit le nom unique de la méthode

target_menu définit l'emplacement dans le menu

(optionel) label le libellé à afficher dans le menu

(optionel) min_level_access  surcharge les droits natif du module

(optionel) max_level_access  surcharge les droits natif du module

(optionel) Le noeud settings englobe les couples clé/valeur de paramétrages niveau méthode. Si une clé est déja présente niveau module, elle est surchargée par la valeur de la méthode.

Détails d'un noeud de type set :

(optionel) min_level_access  surcharge les droits natif du module

(optionel) max_level_access  surcharge les droits natif du module

(optionel) Le noeud settings englobe les couples clé/valeur de paramétrages niveau méthode. Si une clé est déja présente niveau module, elle est surchargée par la valeur de la méthode.

<application name="Default" comment="Application par défaut à destination d'un client web">
   <modules>
     <module id="1" module="Accueil" min_level_access="-1" max_level_access="5" path="Mod_Accueil/Accueil_V.php">
        <settings>
          <setting key="path_module_css" value="Modules/Mod_Accueil/CSS/Accueil.css" /> 
        </settings>   
        <getters>
           <get method="Accueil" target_menu="HIDDEN" comment="Page d'accueil type vitrine">
              <settings>
                 <setting key="path_method_css" value="Modules/Mod_Accueil/CSS/Mod_Accueil.css" /> 
                 <setting key="template" value="Accueil.xslt" comment="Fichier xslt à utiliser pour la restitution" />
              </settings>             
           </get>
        </getters>
        <setters>
           <set method="Contact" />
        </setteers>
     </module>
   </modules>
</application>