Xml files

From Openflyers

Introduction

the goal of this page is to list all xml files present in OF and to describe their content.

Xml files should be locate in the xml directory.

action.xml

This file groups all rights and commands (=actions).

<list>

<parameterList>
<parameter name="QUALIF"/>
</parameterList>

parameterList element lists all club parameters available in the parameter table.

<rightList>
<right name="bookAnytime" bit="0"/>
</rightList>

rightList element lists all rights that may be set in profiles.

right element contents the right name (name attribut) and the bit number (bit attribut) that corresponds PERMITS field of the profiles table.

<stateList>
<state name="member"/>
<state name="instructor"/>
</stateList>

L'élément stateList liste les différents statuts possibles pour une personne connectée (vide, membre, instructeur).

Si la personne est membre c'est qu'elle a une entrée dans la table members.

Si elle est instructeur c'est qu'elle a une entrée dans la table instructors.

Ces statuts peuvent être utilisés au même titre que les droits (right) ou paramètres (parameter) ci-dessous dans l'attribut needs de l'élément action.

<actionList>
<action name="day_book_aircrafts_instructors" file="includes/navigation.php"/>
<action name="admin_home" needs="|(manageUsers)(manageClub)(manageAircraft)" file="admin/manage_.php"/>
</actionList>

L'élément actionList liste les différentes commandes que connait OpenFlyers.

L'élément action décrit l'utilisation de la commande par le moteur d'OF :

• le fichier a appelé est contenu dans l'attribut file
• les droits, statuts et/ou paramètres requis sont contenus dans l'attribut needs

Le contenu de l'attribut need est renseigné suivant la notation préfixe (ou notation polonaise).

l'opérateur ET est représenté par le caractère '*', et l'opérateur OU par le caractère '|'

Chaque nom de droit, de statut ou de paramètre est encadré par des parenthèses.

Exemple du contenu de l'attribut needs :

*(toto)(titi)(|(tutu)(tata))

Ce qui correspond à :

toto * titi * (tutu | tata)

Les statuts permis sont : member, instructor.

On peut également imbriquer les expressions. C'est à dire qu'à la place d'un droit on peut mettre une expression.

Exemple pour :

A et (B ou C)

B ou C s'écrit :

|(B)(C)

A et expr s'écrit :

&(A)(expr)

donc le résultat est :

 &(A)(|(B)(C))

</list>