Widgets

2010-07-30T14:17:11Z

Jeraiz : /* Implémentation */

2010-07-30T10:48:05Z

Jeraiz : /* Implémentation */

Widgets

2010-07-30T10:35:43Z

Jeraiz : /* Widget_CsvImportForm */

2010-07-30T08:28:25Z

Jeraiz :

Widgets

2010-07-30T08:28:14Z

Jeraiz : /* Widget_CsvImportForm */

[[Catégorie:Documentation des librairies]]

Cette librairie facilite la création des interfaces en proposant des objets associés à chaque élément connu d'une page Web : champ de formulaire, tableau, lien avec puce, popup calendrier de sélection d'un jour...

{{Fonctionnalité|path=Widgets|addon=widgets|version=0.1.9}}

=== Initialisation ===

==== Fichier addonini.php ====

Pour accéder aux widgets dans un module d'Ovidentia, il est nécessaire d'installer la librairie Widgets et le module jQuery.

De manière a éviter tout problème ces pré-requis devront être signalés dans le fichier addonini.php du module en y ajoutant quelques lignes :

<source lang="ini">
;<?php/*

[general]
name="my_addon"
.
.
.

[addons]
widgets="0.2.0"

[functionalities]
jquery="Available"

*/?>
</source>

==== Utilisation de la librairie ====

Pour utiliser la librairie dans un code PHP, il est nécessaire d'utiliser la fonction bab_functionality(). Il est conseillé d'inclure les styles utiles à quelques widgets :

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
</source>

=== Les pages ===

La page est le point de départ d'une interface. C'est elle qui contient tous les éléments.

On définit une page grâce à l'objet Widget_BabPage.

La page créée est insérée dans le corps du site Ovidentia : le bandeau et les sections du site apparaîtront autour de la page.

<source lang="php">
$page = $W->BabPage();
</source>

Il est possible de définir le positionnement des éléments à l'intérieur de chaque élément.
Ici, on définit le positionnement pour la page en cours :

# La méthode VBoxLayout() définit une mise en page verticale.
# La méthode HBoxLayout() définit une mise en page horizontale.
# La méthode FlowLayout() définit une mise en page horizontale en 'écoulement' : les éléments reviennent à la ligne automatiquement.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());
</source>

Pour travailler avec des applications en pleine page ou avec des popups, vous pouvez désactiver le mode intégré avec la méthode setEmbedded(). Le bandeau et les sections du site n'apparaîtront pas :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->setEmbedded(false);
</source>

Pour afficher le contenu de la page, on utilise la méthode displayHtml() :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$bonjourLabel = $W->Label('Bonjour');
$page->addItem($bonjourLabel);

$page->displayHtml();
</source>

'''Définir un titre de page :'''

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->setTitle('Configuration');

$page->displayHtml();
</source>

'''Ajouter un message d'erreurs à la page :'''

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->addError("Vous n'avez pas les droits d'accès");

$page->displayHtml();
</source>

=== Insérer des éléments ===

On ajoute des éléments via la méthode addItem() sur un élément conteneur (objet Widget_BabPage par exemple). Dans l'exemple ci-dessous, on ajoute un texte dans notre page.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$bonjourLabel = $W->Label('Bonjour');
$page->addItem($bonjourLabel);

$page->displayHtml();
</source>

=== Navigation horizontale avec les onglets ===

La méthode addItemMenu() sur l'objet Widget_BabPage permet de définir un onglet. La méthode setCurrentItemMenu() permet de définir l'onglet courant.

Dans cet exemple, on affiche 2 onglets : configuration et droits. Droits est l'onglet en cours.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$addon = bab_getAddonInfosInstance('monmodule');
$page->addItemMenu('configuration', 'Configuration', $addon->getUrl().'user&idx=config');
$page->addItemMenu('droits', 'Droits', $addon->getUrl().'user&idx=droits');
$page->setCurrentItemMenu('droits');

$page->displayHtml();
</source>

=== Les textes ===

Les textes sont gérés par les objets Widget_Label et Widget_RichText.

Widget_Label permet d’ajouter un élément texte simple. Si le contenu du texte contient un code javascript, il ne sera pas interprété. Une balise HTML s’affichera à l’écran et ne sera pas interprétée.

<source lang="php">

$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$texte = $W->Label('Qui vivra verra.');
$page->addItem($texte);

$page->displayHtml();
</source>

Widget_RichText permet d’ajouter un élément texte complexe (texte mis en forme comme du HTML). Par défaut le fonctionnement est le même l’objet Widget_Label concernant l’affichage du texte. Cependant il possible d’utiliser la méthode setRenderingOptions() pour indiquer le format d’affichage du texte :

* BAB_HTML_ALL : valeur par défaut : combinaison de toutes les options suivantes

* BAB_HTML_ENTITIES : les caractères spéciaux seront convertis en caractères HTML

* BAB_HTML_AUTO : des balises paragraphes seront ajoutées pour remplacer les retours à la ligne dans le texte

* BAB_HTML_P : des balises paragraphes seront ajoutées pour remplacer les doubles retours à la ligne

* BAB_HTML_BR : des balises BR seront ajoutées pour remplacer les retours à la ligne

* BAB_HTML_LINKS : les URL et les e-mails seront remplacés par des liens

* BAB_HTML_JS : les caractères \ , ' et " seront protégés pour un code javascript, ce format n’est inclut dans BAB_HTML_ALL

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$texte = $W->RichText('<b>Qui vivra verra.</b>');
$texte->setRenderingOptions(BAB_HTML_AUTO);
$page->addItem($texte);

$page->displayHtml();
</source>

=== Code Html libre ===
Vous pouvez insérer du code Html quelconque via l'objet Widget_Html :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$html = $W->Html('<ul>
<li>Choix 1</li>
<li>Choix 2</li>
</ul>');
$page->addItem($html);
$page->displayHtml();
</source>

=== Les formulaires ===

La création d'un formulaire utilise essentiellement les objets Widget_Form et Widget_InputWidget.

Widget_Form permet de définir un formulaire, la cible (attribut action d'une balise form) est automatiquement pré-renseignée au point d'entrée d'Ovidentia (index.php). Pour configurer une cible plus précise, utilisez la méthode setHiddenValue() comme dans l'exemple ci-dessous.

Par défaut, la méthode utilisée pour l'envoi des données est POST. Si vous désirez une méthode GET, appelez la méthode setReadOnly() :

<source lang="php">
$form = $W->Form();
$form->setReadOnly();

$form->setLayout($W->VBoxLayout());

$form->setHiddenValue('tg', $GLOBALS['babAddonTarget'].'/admin');
$form->setHiddenValue('idx', 'configurationsave');
</source>

''' Les champs : '''

Les champs des formulaires sont des objets Widget_InputWidget. Liste des champs utiles :

* Checkbox : case à cocher
* DatePicker : sélection d'une date avec popup de calendrier
* GroupPicker : sélection d'un groupe d'utilisateurs
* LineEdit : case de saisie
* SimpleHtmlEdit : case de saisie avec mise en forme (éditeur wysiwyg simplifié)
* TextEdit : case de saisie multi-lignes
* TimePicker : sélection d'une heure
* Uploader : champ fichier

Après la création d'un champ, il est essentiel de définir son nom (attribut name d'une balise input) par la méthode setName(). Une valeur d'initialisation peut être renseignée via la méthode setValue().

<source lang="php">
$champidentifiant = $W->LineEdit()->setName('identifiant')->setValue('Votre identifiant');
</source>

'''Les boutons :'''

L'objte Widget_SubmitButton permet de définir un bouton de soumission :

<source lang="php">
$form->addItem($W->SubmitButton()->setLabel('Enregistrer'));
</source>

'''Exemple avec l'affichage d'un formulaire contenant 2 cases de saisies Identifiant et Mot de passe :'''

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$form = $W->Form();
$form->setLayout($W->VBoxLayout());
$form->setHiddenValue('tg', $GLOBALS['babAddonTarget'].'/admin');
$form->setHiddenValue('idx', 'configurationsave');

$form->addItem($W->LineEdit()->setName('identifiant')->setValue('Votre identifiant'));
$form->addItem($W->LineEdit()->setName('passe')->setValue('Votre mot de passe'));

$page->addItem($form);
$page->displayHtml();
</source>

'''Exemple de création d'une liste déroulante sélectionnée sur le 3ème choix :'''

<source lang="php">
$select = $W->Select()->setName('notation');
$select->addOption(1, 'mauvais');
$select->addOption(2, 'bon');
$select->addOption(3, 'parfait');
$select->setValue(3);
</source>

''' La réception des données saisies : '''

La réception des données saisies dans un formulaire dépend des conteneurs utilisés avec le formulaire. Explication :

Dans notre exemple, l'objet Widget_Form n'a pas de nom et ne contient aucun conteneur (un conteneur est un objet Widget qui contient d'autres objets : une frame est un conteneur). Nos 2 champs identifiant et passe seront récupérés normalement par PHP :

<source lang="php">
$identifiantsaisit = bab_pp('identifiant', '');
$motdepassesaisit = bab_pp('identifiant', '');
</source>

Cependant dès l'instant que vous définissez des noms aux conteneurs présents dans le formulaire, les données envoyées seront envoyées sous forme de tableaux.

Si on définit un nom à l'objet Widget_Form :
<source lang="php">
$form = $W->Form()->setName('formulaire_identification');
</source>

Les données seront reçues dans un tableau :

<source lang="php">
$donneesformulaire = bab_rp('formulaire_identification', array());
$identifiantsaisit = '';
$motdepassesaisit = '';
if (isset($donneesformulaire['identifiant'])) {
$identifiantsaisit = $donneesformulaire['identifiant'];
}
if (isset($donneesformulaire['passe'])) {
$motdepassesaisit = $donneesformulaire['passe'];
}
</source>

=== Styliser les éléments ===

Vous pouvez styliser les éléments Widgets en appelant une feuille de styles CSS dans la page. Vous définissez alors des styles sur les classes générées par les widgets.

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->addStyleSheet('styles.css');
</source>

Pour être plus précis, vous pouvez ajouter une classe sur tous les éléments widgets :

<source lang="php">
$field = $W->LineEdit()->setName('identifiant')->addClass('field-description');
</source>

=== Exemples ===

==== Hello world ! ====

Commençons par un exemple simple qui se contentera d'afficher le texte "Hello world !" sur une page. L'exemple contient un certain nombre d'opérations qui seront nécessaires pour toutes les pages utilisant les widgets.

<source lang="php">
// Ici on récupère l'objet Func_Widgets qui servira notamment à créer tous les widgets et layouts
$W = bab_functionality::get('Widgets');

// On crée une page, qui sera le container principal.
$page = $W->BabPage();

// On associe à la page une mise en page (layout) verticale : les éléments qu'on y ajoutera seront disposés les uns sous les autres.
$page->setLayout($W->VBoxLayout());

// Création d'un simple texte (Label)
$helloLabel = $W->Label('Hello world !');

// On ajoute ce texte à la page.
$page->addItem($helloLabel);

// C'est fini, on affiche la page.
$page->displayHtml();
</source>

=== Diagramme d'héritage des classes ===

Voici un diagramme court montrant l'héritage et les relations entre les classes objets :

[[Image:Diagramme.png|center|thumb|350px|Diagramme]]

Un peu d'explications :

Sur la gauche de l'image, on aperçoit les classes Widget_ContainerWidget, Widget_Widget et Widget_Item. Tous les objets de la librairie héritent de la classe Widget_Item.

On a pris comme exemple la classe Widget_Form qui gère la construction d'un formulaire de saisie. On remarque que la classe Widget_Form hérite de Widget_ContainerWidget. En effet, dans le cas des objets qui peuvent contenir d'autres objets, on passe par la classe Widget_ContainerWidget pour gérer les sous-éléments.

Un second avantage est la relation de la classe Widget_ContainerWidget avec Widget_Layout. Widget_Layout gère la disposition des éléments dans un Widget_ContainerWidget. Ainsi, le choix d'une disposition VBoxLayout permettra d'afficher automatiquement les éléments à la verticale les uns en dessous des autres sans gérer nous-mêmes de retours à la ligne.

Sur la droite, on aperçoit les classes Canvas. Elles sont destinées à afficher ou exporter les données au format désiré. Toutes les méthodes display() des objets de la librairie prennent en paramètre un Canvas. Le Canvas le plus utilisé est Widgets_HtmlCanvas : il affiche les objets (Form, InputSelect, DatePicker, Page...) pour une page Web donc au format HTML, javascript, css...

===Comprendre les Widgets un par un===

====Widget_CsvImportForm====
=====Introduction=====
Ce widget permet de gérer automatiquement un import de données à partir d'une source CSV.

Un fichier CSV contient des enregistrements (un enregistrement par ligne) dont les données (nom, prénom, téléphone...) sont séparées par des virgules. Pour être compatible avec les formats CSV de Microsoft, le widget gère la séparation des données par des points-virgules.

L'import s'effectue en plusieurs étapes :
* Affichage du formulaire de dépôt du fichier CSV
* Affichage du formulaire d'association '''Champ de table'''-'''Colonne du fichier CSV'''
* Import des données
* Affichage des résultats et erreurs si elles existent

=====Implémentation=====
Tout d'abord il est nécessaire d'afficher le formulaire de dépôt du fichier CSV en créant un objet Widget_CsvImportForm.

Pour préparer l'étape suivante
La méthode addImportField() permet d'indiquer les champs.

<source lang="php">
$W = bab_Functionality::get('Widgets');

$importForm = $W->CsvImportForm()
->addImportField('lastname', 'Nom', true)
->addImportField('firstname', 'Prénom', true)
->addImportField('email', 'E-mail')
->addImportField('phone', 'Téléphone')
;

$page = $W->Page();
$page->addItem($importForm);
$page->displayHtml();
</source>

Le formulaire aura cette apparence :

[[Image:csvimport_form.png|Formulaire d'import CSV]]

Widgets

2010-07-30T08:26:57Z

Jeraiz : /* Widget_CsvImportForm */

[[Catégorie:Documentation des librairies]]

Cette librairie facilite la création des interfaces en proposant des objets associés à chaque élément connu d'une page Web : champ de formulaire, tableau, lien avec puce, popup calendrier de sélection d'un jour...

{{Fonctionnalité|path=Widgets|addon=widgets|version=0.1.9}}

=== Initialisation ===

==== Fichier addonini.php ====

Pour accéder aux widgets dans un module d'Ovidentia, il est nécessaire d'installer la librairie Widgets et le module jQuery.

De manière a éviter tout problème ces pré-requis devront être signalés dans le fichier addonini.php du module en y ajoutant quelques lignes :

<source lang="ini">
;<?php/*

[general]
name="my_addon"
.
.
.

[addons]
widgets="0.2.0"

[functionalities]
jquery="Available"

*/?>
</source>

==== Utilisation de la librairie ====

Pour utiliser la librairie dans un code PHP, il est nécessaire d'utiliser la fonction bab_functionality(). Il est conseillé d'inclure les styles utiles à quelques widgets :

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
</source>

=== Les pages ===

La page est le point de départ d'une interface. C'est elle qui contient tous les éléments.

On définit une page grâce à l'objet Widget_BabPage.

La page créée est insérée dans le corps du site Ovidentia : le bandeau et les sections du site apparaîtront autour de la page.

<source lang="php">
$page = $W->BabPage();
</source>

Il est possible de définir le positionnement des éléments à l'intérieur de chaque élément.
Ici, on définit le positionnement pour la page en cours :

# La méthode VBoxLayout() définit une mise en page verticale.
# La méthode HBoxLayout() définit une mise en page horizontale.
# La méthode FlowLayout() définit une mise en page horizontale en 'écoulement' : les éléments reviennent à la ligne automatiquement.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());
</source>

Pour travailler avec des applications en pleine page ou avec des popups, vous pouvez désactiver le mode intégré avec la méthode setEmbedded(). Le bandeau et les sections du site n'apparaîtront pas :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->setEmbedded(false);
</source>

Pour afficher le contenu de la page, on utilise la méthode displayHtml() :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$bonjourLabel = $W->Label('Bonjour');
$page->addItem($bonjourLabel);

$page->displayHtml();
</source>

'''Définir un titre de page :'''

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->setTitle('Configuration');

$page->displayHtml();
</source>

'''Ajouter un message d'erreurs à la page :'''

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->addError("Vous n'avez pas les droits d'accès");

$page->displayHtml();
</source>

=== Insérer des éléments ===

On ajoute des éléments via la méthode addItem() sur un élément conteneur (objet Widget_BabPage par exemple). Dans l'exemple ci-dessous, on ajoute un texte dans notre page.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$bonjourLabel = $W->Label('Bonjour');
$page->addItem($bonjourLabel);

$page->displayHtml();
</source>

=== Navigation horizontale avec les onglets ===

La méthode addItemMenu() sur l'objet Widget_BabPage permet de définir un onglet. La méthode setCurrentItemMenu() permet de définir l'onglet courant.

Dans cet exemple, on affiche 2 onglets : configuration et droits. Droits est l'onglet en cours.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$addon = bab_getAddonInfosInstance('monmodule');
$page->addItemMenu('configuration', 'Configuration', $addon->getUrl().'user&idx=config');
$page->addItemMenu('droits', 'Droits', $addon->getUrl().'user&idx=droits');
$page->setCurrentItemMenu('droits');

$page->displayHtml();
</source>

=== Les textes ===

Les textes sont gérés par les objets Widget_Label et Widget_RichText.

Widget_Label permet d’ajouter un élément texte simple. Si le contenu du texte contient un code javascript, il ne sera pas interprété. Une balise HTML s’affichera à l’écran et ne sera pas interprétée.

<source lang="php">

$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$texte = $W->Label('Qui vivra verra.');
$page->addItem($texte);

$page->displayHtml();
</source>

Widget_RichText permet d’ajouter un élément texte complexe (texte mis en forme comme du HTML). Par défaut le fonctionnement est le même l’objet Widget_Label concernant l’affichage du texte. Cependant il possible d’utiliser la méthode setRenderingOptions() pour indiquer le format d’affichage du texte :

* BAB_HTML_ALL : valeur par défaut : combinaison de toutes les options suivantes

* BAB_HTML_ENTITIES : les caractères spéciaux seront convertis en caractères HTML

* BAB_HTML_AUTO : des balises paragraphes seront ajoutées pour remplacer les retours à la ligne dans le texte

* BAB_HTML_P : des balises paragraphes seront ajoutées pour remplacer les doubles retours à la ligne

* BAB_HTML_BR : des balises BR seront ajoutées pour remplacer les retours à la ligne

* BAB_HTML_LINKS : les URL et les e-mails seront remplacés par des liens

* BAB_HTML_JS : les caractères \ , ' et " seront protégés pour un code javascript, ce format n’est inclut dans BAB_HTML_ALL

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$texte = $W->RichText('<b>Qui vivra verra.</b>');
$texte->setRenderingOptions(BAB_HTML_AUTO);
$page->addItem($texte);

$page->displayHtml();
</source>

=== Code Html libre ===
Vous pouvez insérer du code Html quelconque via l'objet Widget_Html :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$html = $W->Html('<ul>
<li>Choix 1</li>
<li>Choix 2</li>
</ul>');
$page->addItem($html);
$page->displayHtml();
</source>

=== Les formulaires ===

La création d'un formulaire utilise essentiellement les objets Widget_Form et Widget_InputWidget.

Widget_Form permet de définir un formulaire, la cible (attribut action d'une balise form) est automatiquement pré-renseignée au point d'entrée d'Ovidentia (index.php). Pour configurer une cible plus précise, utilisez la méthode setHiddenValue() comme dans l'exemple ci-dessous.

Par défaut, la méthode utilisée pour l'envoi des données est POST. Si vous désirez une méthode GET, appelez la méthode setReadOnly() :

<source lang="php">
$form = $W->Form();
$form->setReadOnly();

$form->setLayout($W->VBoxLayout());

$form->setHiddenValue('tg', $GLOBALS['babAddonTarget'].'/admin');
$form->setHiddenValue('idx', 'configurationsave');
</source>

''' Les champs : '''

Les champs des formulaires sont des objets Widget_InputWidget. Liste des champs utiles :

* Checkbox : case à cocher
* DatePicker : sélection d'une date avec popup de calendrier
* GroupPicker : sélection d'un groupe d'utilisateurs
* LineEdit : case de saisie
* SimpleHtmlEdit : case de saisie avec mise en forme (éditeur wysiwyg simplifié)
* TextEdit : case de saisie multi-lignes
* TimePicker : sélection d'une heure
* Uploader : champ fichier

Après la création d'un champ, il est essentiel de définir son nom (attribut name d'une balise input) par la méthode setName(). Une valeur d'initialisation peut être renseignée via la méthode setValue().

<source lang="php">
$champidentifiant = $W->LineEdit()->setName('identifiant')->setValue('Votre identifiant');
</source>

'''Les boutons :'''

L'objte Widget_SubmitButton permet de définir un bouton de soumission :

<source lang="php">
$form->addItem($W->SubmitButton()->setLabel('Enregistrer'));
</source>

'''Exemple avec l'affichage d'un formulaire contenant 2 cases de saisies Identifiant et Mot de passe :'''

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$form = $W->Form();
$form->setLayout($W->VBoxLayout());
$form->setHiddenValue('tg', $GLOBALS['babAddonTarget'].'/admin');
$form->setHiddenValue('idx', 'configurationsave');

$form->addItem($W->LineEdit()->setName('identifiant')->setValue('Votre identifiant'));
$form->addItem($W->LineEdit()->setName('passe')->setValue('Votre mot de passe'));

$page->addItem($form);
$page->displayHtml();
</source>

'''Exemple de création d'une liste déroulante sélectionnée sur le 3ème choix :'''

<source lang="php">
$select = $W->Select()->setName('notation');
$select->addOption(1, 'mauvais');
$select->addOption(2, 'bon');
$select->addOption(3, 'parfait');
$select->setValue(3);
</source>

''' La réception des données saisies : '''

La réception des données saisies dans un formulaire dépend des conteneurs utilisés avec le formulaire. Explication :

Dans notre exemple, l'objet Widget_Form n'a pas de nom et ne contient aucun conteneur (un conteneur est un objet Widget qui contient d'autres objets : une frame est un conteneur). Nos 2 champs identifiant et passe seront récupérés normalement par PHP :

<source lang="php">
$identifiantsaisit = bab_pp('identifiant', '');
$motdepassesaisit = bab_pp('identifiant', '');
</source>

Cependant dès l'instant que vous définissez des noms aux conteneurs présents dans le formulaire, les données envoyées seront envoyées sous forme de tableaux.

Si on définit un nom à l'objet Widget_Form :
<source lang="php">
$form = $W->Form()->setName('formulaire_identification');
</source>

Les données seront reçues dans un tableau :

<source lang="php">
$donneesformulaire = bab_rp('formulaire_identification', array());
$identifiantsaisit = '';
$motdepassesaisit = '';
if (isset($donneesformulaire['identifiant'])) {
$identifiantsaisit = $donneesformulaire['identifiant'];
}
if (isset($donneesformulaire['passe'])) {
$motdepassesaisit = $donneesformulaire['passe'];
}
</source>

=== Styliser les éléments ===

Vous pouvez styliser les éléments Widgets en appelant une feuille de styles CSS dans la page. Vous définissez alors des styles sur les classes générées par les widgets.

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->addStyleSheet('styles.css');
</source>

Pour être plus précis, vous pouvez ajouter une classe sur tous les éléments widgets :

<source lang="php">
$field = $W->LineEdit()->setName('identifiant')->addClass('field-description');
</source>

=== Exemples ===

==== Hello world ! ====

Commençons par un exemple simple qui se contentera d'afficher le texte "Hello world !" sur une page. L'exemple contient un certain nombre d'opérations qui seront nécessaires pour toutes les pages utilisant les widgets.

<source lang="php">
// Ici on récupère l'objet Func_Widgets qui servira notamment à créer tous les widgets et layouts
$W = bab_functionality::get('Widgets');

// On crée une page, qui sera le container principal.
$page = $W->BabPage();

// On associe à la page une mise en page (layout) verticale : les éléments qu'on y ajoutera seront disposés les uns sous les autres.
$page->setLayout($W->VBoxLayout());

// Création d'un simple texte (Label)
$helloLabel = $W->Label('Hello world !');

// On ajoute ce texte à la page.
$page->addItem($helloLabel);

// C'est fini, on affiche la page.
$page->displayHtml();
</source>

=== Diagramme d'héritage des classes ===

Voici un diagramme court montrant l'héritage et les relations entre les classes objets :

[[Image:Diagramme.png|center|thumb|350px|Diagramme]]

Un peu d'explications :

Sur la gauche de l'image, on aperçoit les classes Widget_ContainerWidget, Widget_Widget et Widget_Item. Tous les objets de la librairie héritent de la classe Widget_Item.

On a pris comme exemple la classe Widget_Form qui gère la construction d'un formulaire de saisie. On remarque que la classe Widget_Form hérite de Widget_ContainerWidget. En effet, dans le cas des objets qui peuvent contenir d'autres objets, on passe par la classe Widget_ContainerWidget pour gérer les sous-éléments.

Un second avantage est la relation de la classe Widget_ContainerWidget avec Widget_Layout. Widget_Layout gère la disposition des éléments dans un Widget_ContainerWidget. Ainsi, le choix d'une disposition VBoxLayout permettra d'afficher automatiquement les éléments à la verticale les uns en dessous des autres sans gérer nous-mêmes de retours à la ligne.

Sur la droite, on aperçoit les classes Canvas. Elles sont destinées à afficher ou exporter les données au format désiré. Toutes les méthodes display() des objets de la librairie prennent en paramètre un Canvas. Le Canvas le plus utilisé est Widgets_HtmlCanvas : il affiche les objets (Form, InputSelect, DatePicker, Page...) pour une page Web donc au format HTML, javascript, css...

===Comprendre les Widgets un par un===

====Widget_CsvImportForm====
=====Introduction=====
Ce widget permet de gérer automatiquement un import de données à partir d'une source CSV.

Un fichier CSV contient des enregistrements (un enregistrement par ligne) dont les données (nom, prénom, téléphone...) sont séparées par des virgules. Pour être compatible avec les formats CSV de Microsoft, le widget gère la séparation des données par des points-virgules.

L'import s'effectue en plusieurs étapes :
* Affichage du formulaire de dépôt du fichier CSV
* Affichage du formulaire d'association '''Champ de table'''-'''Colonne du fichier CSV'''
* Import des données
* Affichage des résultats et erreurs si elles existent

=====Implémentation=====
Tout d'abord il est nécessaire d'afficher le formulaire de dépôt du fichier CSV en créant un objet Widget_CsvImportForm.

Pour préparer l'étape suivante
La méthode addImportField() permet d'indiquer les champs.

<source lang="php">
$W = bab_Functionality::get('Widgets');

$importForm = $W->CsvImportForm()
->addImportField('lastname', 'Nom', true)
->addImportField('firstname', 'Prénom', true)
->addImportField('email', 'E-mail')
->addImportField('phone', 'Téléphone')
;

$page = $W->Page();
$page->addItem($importForm);
$page->displayHtml();
</source>

Le formulaire

Widgets

2010-07-30T08:13:41Z

Jeraiz : /* Widget_CsvImportForm */

[[Catégorie:Documentation des librairies]]

Cette librairie facilite la création des interfaces en proposant des objets associés à chaque élément connu d'une page Web : champ de formulaire, tableau, lien avec puce, popup calendrier de sélection d'un jour...

{{Fonctionnalité|path=Widgets|addon=widgets|version=0.1.9}}

=== Initialisation ===

==== Fichier addonini.php ====

Pour accéder aux widgets dans un module d'Ovidentia, il est nécessaire d'installer la librairie Widgets et le module jQuery.

De manière a éviter tout problème ces pré-requis devront être signalés dans le fichier addonini.php du module en y ajoutant quelques lignes :

<source lang="ini">
;<?php/*

[general]
name="my_addon"
.
.
.

[addons]
widgets="0.2.0"

[functionalities]
jquery="Available"

*/?>
</source>

==== Utilisation de la librairie ====

Pour utiliser la librairie dans un code PHP, il est nécessaire d'utiliser la fonction bab_functionality(). Il est conseillé d'inclure les styles utiles à quelques widgets :

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
</source>

=== Les pages ===

La page est le point de départ d'une interface. C'est elle qui contient tous les éléments.

On définit une page grâce à l'objet Widget_BabPage.

La page créée est insérée dans le corps du site Ovidentia : le bandeau et les sections du site apparaîtront autour de la page.

<source lang="php">
$page = $W->BabPage();
</source>

Il est possible de définir le positionnement des éléments à l'intérieur de chaque élément.
Ici, on définit le positionnement pour la page en cours :

# La méthode VBoxLayout() définit une mise en page verticale.
# La méthode HBoxLayout() définit une mise en page horizontale.
# La méthode FlowLayout() définit une mise en page horizontale en 'écoulement' : les éléments reviennent à la ligne automatiquement.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());
</source>

Pour travailler avec des applications en pleine page ou avec des popups, vous pouvez désactiver le mode intégré avec la méthode setEmbedded(). Le bandeau et les sections du site n'apparaîtront pas :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->setEmbedded(false);
</source>

Pour afficher le contenu de la page, on utilise la méthode displayHtml() :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$bonjourLabel = $W->Label('Bonjour');
$page->addItem($bonjourLabel);

$page->displayHtml();
</source>

'''Définir un titre de page :'''

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->setTitle('Configuration');

$page->displayHtml();
</source>

'''Ajouter un message d'erreurs à la page :'''

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->addError("Vous n'avez pas les droits d'accès");

$page->displayHtml();
</source>

=== Insérer des éléments ===

On ajoute des éléments via la méthode addItem() sur un élément conteneur (objet Widget_BabPage par exemple). Dans l'exemple ci-dessous, on ajoute un texte dans notre page.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$bonjourLabel = $W->Label('Bonjour');
$page->addItem($bonjourLabel);

$page->displayHtml();
</source>

=== Navigation horizontale avec les onglets ===

La méthode addItemMenu() sur l'objet Widget_BabPage permet de définir un onglet. La méthode setCurrentItemMenu() permet de définir l'onglet courant.

Dans cet exemple, on affiche 2 onglets : configuration et droits. Droits est l'onglet en cours.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$addon = bab_getAddonInfosInstance('monmodule');
$page->addItemMenu('configuration', 'Configuration', $addon->getUrl().'user&idx=config');
$page->addItemMenu('droits', 'Droits', $addon->getUrl().'user&idx=droits');
$page->setCurrentItemMenu('droits');

$page->displayHtml();
</source>

=== Les textes ===

Les textes sont gérés par les objets Widget_Label et Widget_RichText.

Widget_Label permet d’ajouter un élément texte simple. Si le contenu du texte contient un code javascript, il ne sera pas interprété. Une balise HTML s’affichera à l’écran et ne sera pas interprétée.

<source lang="php">

$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$texte = $W->Label('Qui vivra verra.');
$page->addItem($texte);

$page->displayHtml();
</source>

Widget_RichText permet d’ajouter un élément texte complexe (texte mis en forme comme du HTML). Par défaut le fonctionnement est le même l’objet Widget_Label concernant l’affichage du texte. Cependant il possible d’utiliser la méthode setRenderingOptions() pour indiquer le format d’affichage du texte :

* BAB_HTML_ALL : valeur par défaut : combinaison de toutes les options suivantes

* BAB_HTML_ENTITIES : les caractères spéciaux seront convertis en caractères HTML

* BAB_HTML_AUTO : des balises paragraphes seront ajoutées pour remplacer les retours à la ligne dans le texte

* BAB_HTML_P : des balises paragraphes seront ajoutées pour remplacer les doubles retours à la ligne

* BAB_HTML_BR : des balises BR seront ajoutées pour remplacer les retours à la ligne

* BAB_HTML_LINKS : les URL et les e-mails seront remplacés par des liens

* BAB_HTML_JS : les caractères \ , ' et " seront protégés pour un code javascript, ce format n’est inclut dans BAB_HTML_ALL

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$texte = $W->RichText('<b>Qui vivra verra.</b>');
$texte->setRenderingOptions(BAB_HTML_AUTO);
$page->addItem($texte);

$page->displayHtml();
</source>

=== Code Html libre ===
Vous pouvez insérer du code Html quelconque via l'objet Widget_Html :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$html = $W->Html('<ul>
<li>Choix 1</li>
<li>Choix 2</li>
</ul>');
$page->addItem($html);
$page->displayHtml();
</source>

=== Les formulaires ===

La création d'un formulaire utilise essentiellement les objets Widget_Form et Widget_InputWidget.

Widget_Form permet de définir un formulaire, la cible (attribut action d'une balise form) est automatiquement pré-renseignée au point d'entrée d'Ovidentia (index.php). Pour configurer une cible plus précise, utilisez la méthode setHiddenValue() comme dans l'exemple ci-dessous.

Par défaut, la méthode utilisée pour l'envoi des données est POST. Si vous désirez une méthode GET, appelez la méthode setReadOnly() :

<source lang="php">
$form = $W->Form();
$form->setReadOnly();

$form->setLayout($W->VBoxLayout());

$form->setHiddenValue('tg', $GLOBALS['babAddonTarget'].'/admin');
$form->setHiddenValue('idx', 'configurationsave');
</source>

''' Les champs : '''

Les champs des formulaires sont des objets Widget_InputWidget. Liste des champs utiles :

* Checkbox : case à cocher
* DatePicker : sélection d'une date avec popup de calendrier
* GroupPicker : sélection d'un groupe d'utilisateurs
* LineEdit : case de saisie
* SimpleHtmlEdit : case de saisie avec mise en forme (éditeur wysiwyg simplifié)
* TextEdit : case de saisie multi-lignes
* TimePicker : sélection d'une heure
* Uploader : champ fichier

Après la création d'un champ, il est essentiel de définir son nom (attribut name d'une balise input) par la méthode setName(). Une valeur d'initialisation peut être renseignée via la méthode setValue().

<source lang="php">
$champidentifiant = $W->LineEdit()->setName('identifiant')->setValue('Votre identifiant');
</source>

'''Les boutons :'''

L'objte Widget_SubmitButton permet de définir un bouton de soumission :

<source lang="php">
$form->addItem($W->SubmitButton()->setLabel('Enregistrer'));
</source>

'''Exemple avec l'affichage d'un formulaire contenant 2 cases de saisies Identifiant et Mot de passe :'''

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$form = $W->Form();
$form->setLayout($W->VBoxLayout());
$form->setHiddenValue('tg', $GLOBALS['babAddonTarget'].'/admin');
$form->setHiddenValue('idx', 'configurationsave');

$form->addItem($W->LineEdit()->setName('identifiant')->setValue('Votre identifiant'));
$form->addItem($W->LineEdit()->setName('passe')->setValue('Votre mot de passe'));

$page->addItem($form);
$page->displayHtml();
</source>

'''Exemple de création d'une liste déroulante sélectionnée sur le 3ème choix :'''

<source lang="php">
$select = $W->Select()->setName('notation');
$select->addOption(1, 'mauvais');
$select->addOption(2, 'bon');
$select->addOption(3, 'parfait');
$select->setValue(3);
</source>

''' La réception des données saisies : '''

La réception des données saisies dans un formulaire dépend des conteneurs utilisés avec le formulaire. Explication :

Dans notre exemple, l'objet Widget_Form n'a pas de nom et ne contient aucun conteneur (un conteneur est un objet Widget qui contient d'autres objets : une frame est un conteneur). Nos 2 champs identifiant et passe seront récupérés normalement par PHP :

<source lang="php">
$identifiantsaisit = bab_pp('identifiant', '');
$motdepassesaisit = bab_pp('identifiant', '');
</source>

Cependant dès l'instant que vous définissez des noms aux conteneurs présents dans le formulaire, les données envoyées seront envoyées sous forme de tableaux.

Si on définit un nom à l'objet Widget_Form :
<source lang="php">
$form = $W->Form()->setName('formulaire_identification');
</source>

Les données seront reçues dans un tableau :

<source lang="php">
$donneesformulaire = bab_rp('formulaire_identification', array());
$identifiantsaisit = '';
$motdepassesaisit = '';
if (isset($donneesformulaire['identifiant'])) {
$identifiantsaisit = $donneesformulaire['identifiant'];
}
if (isset($donneesformulaire['passe'])) {
$motdepassesaisit = $donneesformulaire['passe'];
}
</source>

=== Styliser les éléments ===

Vous pouvez styliser les éléments Widgets en appelant une feuille de styles CSS dans la page. Vous définissez alors des styles sur les classes générées par les widgets.

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->addStyleSheet('styles.css');
</source>

Pour être plus précis, vous pouvez ajouter une classe sur tous les éléments widgets :

<source lang="php">
$field = $W->LineEdit()->setName('identifiant')->addClass('field-description');
</source>

=== Exemples ===

==== Hello world ! ====

Commençons par un exemple simple qui se contentera d'afficher le texte "Hello world !" sur une page. L'exemple contient un certain nombre d'opérations qui seront nécessaires pour toutes les pages utilisant les widgets.

<source lang="php">
// Ici on récupère l'objet Func_Widgets qui servira notamment à créer tous les widgets et layouts
$W = bab_functionality::get('Widgets');

// On crée une page, qui sera le container principal.
$page = $W->BabPage();

// On associe à la page une mise en page (layout) verticale : les éléments qu'on y ajoutera seront disposés les uns sous les autres.
$page->setLayout($W->VBoxLayout());

// Création d'un simple texte (Label)
$helloLabel = $W->Label('Hello world !');

// On ajoute ce texte à la page.
$page->addItem($helloLabel);

// C'est fini, on affiche la page.
$page->displayHtml();
</source>

=== Diagramme d'héritage des classes ===

Voici un diagramme court montrant l'héritage et les relations entre les classes objets :

[[Image:Diagramme.png|center|thumb|350px|Diagramme]]

Un peu d'explications :

Sur la gauche de l'image, on aperçoit les classes Widget_ContainerWidget, Widget_Widget et Widget_Item. Tous les objets de la librairie héritent de la classe Widget_Item.

On a pris comme exemple la classe Widget_Form qui gère la construction d'un formulaire de saisie. On remarque que la classe Widget_Form hérite de Widget_ContainerWidget. En effet, dans le cas des objets qui peuvent contenir d'autres objets, on passe par la classe Widget_ContainerWidget pour gérer les sous-éléments.

Un second avantage est la relation de la classe Widget_ContainerWidget avec Widget_Layout. Widget_Layout gère la disposition des éléments dans un Widget_ContainerWidget. Ainsi, le choix d'une disposition VBoxLayout permettra d'afficher automatiquement les éléments à la verticale les uns en dessous des autres sans gérer nous-mêmes de retours à la ligne.

Sur la droite, on aperçoit les classes Canvas. Elles sont destinées à afficher ou exporter les données au format désiré. Toutes les méthodes display() des objets de la librairie prennent en paramètre un Canvas. Le Canvas le plus utilisé est Widgets_HtmlCanvas : il affiche les objets (Form, InputSelect, DatePicker, Page...) pour une page Web donc au format HTML, javascript, css...

===Comprendre les Widgets un par un===

====Widget_CsvImportForm====
=====Introduction=====
Ce widget permet de gérer automatiquement un import de données à partir d'une source CSV.

=====Implémentation=====

<source lang="php">
$W = bab_Functionality::get('Widgets');
$import = $W->CsvImportForm()
->addImportField('lastname', 'Nom', true)
->addImportField('firstname', 'Prénom', true)
->addImportField('email', 'E-mail')
->addImportField('phone', 'Téléphone')
;
</source>

Widgets

2010-07-30T08:10:03Z

Jeraiz : /* Comprendre les Widgets un par un */

Widgets

2010-07-30T08:06:07Z

Jeraiz : /* Diagramme d'héritage des classes */

Feuille de route

2010-04-28T14:35:53Z

Jeraiz : /* Version 7.3.0 */

== Version 7.2.0 ==

{|class="prettytable" width="100%"
|| '''Description'''
| width="70"| '''État'''
|-
|| La page "Nouveautés" dans le noyau devient un module d'Ovidentia installé par défaut dans la distribution mais supprimable || Fait
|-
|| Un bouton de configuration dans la liste des modules de l'administrateur peut être ajouté sur chaque module a partir du fichier [[Variables du fichier addonini|addonini.php]] || Fait
|-
|| Les gestionnaires d'un thème d'articles peuvent maintenant modifier un commentaire d'article || Fait
|-
|| Utilisation du captcha lors de la rédaction d'un commentaire par un anonyme || Fait
|-
|| Lors de la rédaction d'un article, les utilisateurs peuvent noter l'article. Cette notation ( de 1 à 5 ) est restituée lors de la visualisation de l'article par OVML || Fait
|-
|| Possibilité de supprimer plusieurs utilisateurs en même temps || Fait
|-
|| Possibilité de copier ou de déplacer les membres d'un groupe vers un autre groupe || Fait
|-
|| Dans les forums, possibilité d'afficher un autre de champ de l'annuaire au lieu du nom du contributeur || Fait
|-
|| Nouvelle gestion de l'installation des modules et du noyau, ajout de la possibilité d'ajout des messages pour suivre la progression de l'installation || Fait
|-
|| Amélioration de l'API de l'éditeur WYSIWYG, tout les emplacement de contenu modifiable du noyau sont désormais capable de supporter des formats autre que le HTML || Fait
|-
|| Les utilisateurs peuvent configurer comment ils seront notifiés quand de nouvelles contributions arrivent sur les forums ( Pas de notification, notification uniquement quand un nouveau sujet est initié ) || Fait
|-
|| Supprimer des utilisateurs créés depuis une date donné, dans le menu administration > utilisateurs > utilitaires. ceci permet de revenir en arrière sur un import d'utilisateurs || Fait
|}

== Version 7.3.0 ==

{|class="prettytable" width="100%"
|| '''Description'''
| width="70" | '''État'''
|-
|| Modification du plan du site dans le noyau pour que les différentes pages du site puisse fournir leurs mots clefs pour le référencement en même temps que le point d'accès dans le sitemap || A l'étude
|-
|| Modification du comportement des droits d'accès dans les agendas, toujours permettre la modification des évènements de son agenda sauf quand un événement est verrouillé || Fait
|-
|| Notification de l'auteur d'un événement en plus des participants en cas de modification de l'évènement || Fait
|-
|| Calcul partiel du plan du site en base pour améliorer les performances et supporter des arborescences plus importantes || Fait
|-
|| Ajout de la possibilité d'insérer plusieurs articles ( $ARTICLE ) d'un même thème à l'aide de l'éditeur WYSIWYG || Fait
|-
|| Ajout de la possibilité de paramétrer l'ordre des résultats pour la recherche dans les annuaires, le paramétrage peut se faire par annuaire et pour tous les annuaires confondus (recherche globale) || Fait
|-
|| Maintenant il est possible de choisir les colonnes à afficher dans le gestionnaire de fichiers. Cette configuration se fait par l'administrateur général et est valable pour tous les répertoires || Fait
|-
|| On peut maintenant choisir la couleur d'affichage des jours fériés dans l'agenda || Fait
|-
|| Dans les menu Administrateur->Sites, scinder les options de l'agenda des options relatifs aux congés et aux jours fériés || Fait
|-
|| Dans la vue mensuelle de l'agenda, il sera possible de n'afficher que les jours du mois courant. Cette configuration est faite par l'administrateur et peut être surchargée par l'utilisateur dans ses options de l'agenda || Fait
|-
|| une gestion des événements à été ajouté sur la publication des fichiers dans le gestionnaires de fichiers, la notification par mail des destinataires est faite par une fonction externe enregistrée sur ces événements. Un module peut s'enregistrer et remplacer la gestion normale des notifications || Fait
|-
|| ajout d'un choix d'envoi d'un e-mail de notification à l'utilisateur auquel on vient de modifier son mot de passe || Fait
|-
|}

== Version future ==

{|class="prettytable" width="100%"
|| '''Description'''
| width="70"| '''État'''
|-
|| Création d'un (ou de) module(s) de saisie de notes et remplacement de la fonctionnalité Notes du noyau || A l'étude
|-
|| Passer l'éditeur wysiwyg "htmlarea" dans un module || A l'étude

|}

== Anciennes versions ==

Voir l'historique des changements pour les anciennes versions : [[Feuille de route (archives)]]

API des utilisateurs et des annuaires

2010-03-29T15:27:40Z

Jeraiz : /* bab_updateUserPasswordById() */

[[Catégorie:Développement de modules]]
[[Catégorie:API Ovidentia]]

== Les comptes utilisateurs ==

===bab_isUserAdministrator()===
Retourne '''true''' si l'utilisateur est administrateur. Sinon '''false'''
:'''function bab_isUserAdministrator()'''
===bab_isUserGroupManager()===
Retourne '''true''' si l'utilisateur est gestionnaire du groupe d'id $grpid. Sinon '''false'''
:'''function bab_isUserGroupManager($grpid="")'''
* '''$grpid''' :
*: ID du groupe pour lequel on souhaite savoir si l'utilisateur est gestionnaire. Si vide la fonction retiourne '''true''' si l'utilisateur est gestionnaire d'au moins un groupe.

===bab_getUserName()===
Retourne le nom complet de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserName($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserEmail()===
Retourne l'adresse email de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserEmail($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserNickname()===
Retourne l'identifiant de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserNickname($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserIdByEmail()===
Retourne l'ID de l'utilisateur à partir de son adresse email. Retourne 0 si aucun utilisateur
:'''function bab_getUserIdByEmail($email)'''
* '''$email''' :
*: Adresse email de l'utilisateur

===bab_getUserIdByNickname()===
Retourne l'ID de l'utilisateur à partir de son identifiant. Retourne 0 si aucun utilisateur
:'''function bab_getUserIdByNickname($nickname)'''
* '''$nickname''' :
*: Identifiant de l'utilisateur

===bab_getUserId()===
Retourn l'ID de l'utilisateur à partir de son nom. Sinon 0.
:'''function bab_getUserId( $name )'''
* '''$name''' :
*: Nom de l'utilisateur

===bab_getUserGroups()===
Retourne un tableau contenant les ID et les noms des groupes auxquels l'utilisateur appartient.
:'''function bab_getUserGroups($id = "")'''
* '''$id''' :
*: ID de l'utilisateur. Si vide le système utilise celui de l'utilisateur courant

===bab_composeUserName()===
Retourne une chaîne contenant le nom complet de l'utilisateur selon les préférences du site ( nom/prénom ou prénom/nom )
:'''function bab_composeUserName( $F, $L)'''
* '''$F''' :
*: Prénom de l'utilisateur
* '''$L''' :
*: Nom de l'utilisateur

===bab_userIsloggedin()===
Retourne '''true''' si l'utilisateur courant est authentifié. Sinon elle retourne '''false'''
:'''function bab_userIsloggedin()'''

===bab_registerUser()===
Permet d'inscrire un utilisateur dans le portail.
Retourne l'ID de l'utilisateur inscrit. Sinon '''false'''.
:'''function bab_registerUser($firstname, $lastname, $middlename, $email, $nickname, $password1, $password2, $confirmed, &$error, $bgroup = true)'''
* '''$firstname''' :
*: Prénom de l'utilisateur à inscrire
* '''$lastname''' :
*: Nom de l'utilisateur à inscrire
* '''$middlename''' :
*: Deuxième prénom de l'utilisateur à inscrire
* '''$email''' :
*: Adresse email de l'utilisateur à inscrire
* '''$nickname''' :
*: Identifiant de l'utilisateur à inscrire
* '''$password1''' :
*: Mot de passe de l'utilisateur à inscrire
* '''$password2''' :
*: De nouveau le même mot de passe de l'utilisateur à inscrire
* '''$confirmed''' :
*: '''true''' si l'inscription de l'utilisateur sera confirmée. Sinon '''false'''
* '''$error''' :
*: Variable passée par référence. Si l'inscription échoue, elle sera initialisée avec le message d'erreur

===bab_getUserInfos()===

Obtenir les informations d'un utilisateur, la fonction retourne un tableau contenant la fiche annuaire de l'utilisateur et les champs spécifiques obligatoires. Les information obtenues peuvent être utilisées en entrée avec la fonction bab_updateUserById()

les champs retournés par la fonction qui sont toujours présents sont :

*disabled : booléen 1 ou 0
*password_md5 : mot de passe du compte Ovidentia
*changepwd : booléen 1 ou 0
*is_confirmed : booléen 1 ou 0
*cn : surnom
*sn : nom
*mn : deuxième prénom
*givenname : prénom
*jpegphoto
*email
*btel
*mobile : numéro de téléphone mobile
*htel
*bfax
*title
*departmentnumber
*organisationname
*bstreetaddress,
*bcity
*bpostalcode
*bstate
*bcountry
*hstreetaddress
*hcity
*hpostalcode
*hstate
*hcountry
*user1
*user2
*user3

Remarque : il peut y avoir des champ d'annuaire optionnels. Des champs comme jpegphoto (photo de l'utilisateur) peuvent être désactivés par l'administrateur du site. Dans ce cas le tableau retourné ne contiendra pas l'entrée jpegphoto.

:'''function bab_getUserInfos($id_user)'''

===bab_canCurrentUserUpdateUser()===

Vérifie si l'utilisateur courant a les droits d'accès pour modifier le compte d'un utilisateur spécifié par son id. Retourne true ou false. True si l'utilisateur a les droits.

:'''function bab_canCurrentUserUpdateUser($userId)'''

* '''$userId''' :
*: ID de l'utilisateur à modifier

===bab_updateUserPasswordById()===

Modification du mot de passe de connexion d'un utilisateur. Retourne true ou false. True si l'utilisateur a été modifié.

:'''function bab_updateUserPasswordById($userId, $newPassword, $newPassword2, $ignoreAccessRights=false, $ignoreSixCharactersMinimum=false, &$error)'''

* '''$userId''' :
*: ID de l'utilisateur à modifier
* '''$newPassword''' :
*: nouveau mot de passe de connexion
* '''$newPassword2''' :
*: copie du nouveau mot de passe de connexion (utilisé lorsqu'on demande 2 fois le mot de passe dans un formulaire pour valider la saisie)
* '''$ignoreAccessRights''' :
*: booléen. Si true, on ignore les droits d'accès de l'utilisateur courant quant à sa possibilité de modifier le compte utilisateur
* '''$ignoreSixCharactersMinimum''' :
*: booléen. Si true, on ignore la restriction sur le minimum de 6 caractères
*: En cas d'erreurs, retourne le message Ovidentia traduit

===bab_updateUserNicknameById()===

Modification de l'identifiant de connexion d'un utilisateur. Retourne true ou false. True si l'utilisateur a été modifié.

:'''function bab_updateUserNicknameById($userId, $newNickname, $ignoreAccessRights=false, &$error)'''

* '''$userId''' :
*: ID de l'utilisateur à modifier
* '''$newNickname''' :
*: nouvel identifiant de connexion
* '''$ignoreAccessRights''' :
*: booléen. Si true, on ignore les droits d'accès de l'utilisateur courant quant à sa possibilité de modifier le compte utilisateur
* '''$error''' :
*: En cas d'erreurs, retourne le message Ovidentia traduit

===bab_updateUserById()===

Modification d'un utilisateur

:'''function bab_updateUserById($id, $info, &$error)'''

* '''$id''' :
*: ID de l'utilisateur à modifier
* '''$info''' :
*: $info est une variable tableau contenant les nouvelles valeurs à enregistrées, le format du tableau correspond au format retourné par la fonction bab_getUserInfos()
* '''&$error''' :
*: En cas d'erreur, cette variable sera renseignée avec un message d'erreur

===bab_updateUserByNickname()===

Modifier les informations d'un utilisateur a partir de l'identifiant

:'''function bab_updateUserByNickname($nickname, $info, &$error)'''

* '''$nickname''' :
*: Identifiant de l'utilisateur à modifier
* '''$info''' :
*: $info est une variable tableau contenant les nouvelles valeurs à enregistrées, le format du tableau correspond au format retourné par la fonction bab_getUserInfos()
* '''&$error''' :
*: En cas d'erreur, cette variable sera renseignée avec un message d'erreur

== Les fiches d'annuaires ==

===bab_getDirEntry()===

Retourne une fiche d'annuaire ou une liste de fiches d'annuaires.

retourne false si il y a une erreur dans les paramètres

retourne un tableau vide si l'utilisateur n'a pas accès aux informations

:'''function bab_getDirEntry($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = NULL )'''

* '''$id''' :
*: Ce paramètre est optionnel, les valeurs possibles sont :
*:
*: false : si le type est BAB_DIR_ENTRY_ID_USER, l'id de l'utilisateur connecté sera utilisé.
*: un nombre entier : utilisable pour tout les types
*: un tableau de nombre entiers : une liste d'id peut être utilisée pour les types BAB_DIR_ENTRY_ID_USER et BAB_DIR_ENTRY_ID dans ce cas la fonction retournera plusieurs fiches d'annuaire dans un tableau.

* '''type''' :
*: Ce paramètre est optionnel, il correspond au type d'information fourni dans le premier paramètre de la fonction, les valeurs possibles sont
*:
*: BAB_DIR_ENTRY_ID_USER : $id est un id d'utilisateur
*: BAB_DIR_ENTRY_ID : $id est un id de fiche d'annuaire
*: BAB_DIR_ENTRY_ID_DIRECTORY : $id est un id d'annuaire, dans ce cas seul la liste des champs de l'annuaire est retournée
*: BAB_DIR_ENTRY_ID_GROUP : $id est un id de groupe d'utilisateur, dans ce cas seul la liste des champs de l'annuaire de groupe est retournée
*:
*: La valeur par défaut est BAB_DIR_ENTRY_ID_USER

* '''$id_directory''' :
*: Ce paramètre est optionnel, peut être spécifié si le type est BAB_DIR_ENTRY_ID

===bab_getUserDirectories()===

Retourne une liste d'annuaires visibles par l'utilisateur

:'''function bab_getUserDirectories()'''

===bab_getUserDirEntryLink()===

Cette fonction permet d'obtenir un lien vers une fiche d'annuaire, pour un utilisateur ou un ID de fiche d'annuaire.

retourne false si la fiche n'est pas accessible

:'''function bab_getUserDirEntryLink($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = false)'''

* '''$id''' :
*: Ce paramètre est optionnel, les valeurs possibles sont :
*:
*: false : si le type est BAB_DIR_ENTRY_ID_USER, l'id de l'utilisateur connecté sera utilisé.
*: un nombre entier : utilisable pour tout les types

* '''type''' :
*: Ce paramètre est optionnel, il correspond au type d'information fourni dans le premier paramètre de la fonction, les valeurs possibles sont
*:
*: BAB_DIR_ENTRY_ID_USER : $id est un id d'utilisateur
*: BAB_DIR_ENTRY_ID : $id est un id de fiche d'annuaire
*:
*: La valeur par défaut est BAB_DIR_ENTRY_ID_USER

* '''$id_directory''' :
*: Ce paramètre est optionnel, peut être spécifié si le type est BAB_DIR_ENTRY_ID

API des utilisateurs et des annuaires

2010-03-29T15:06:36Z

Jeraiz : /* bab_updateUserNicknameById() */

[[Catégorie:Développement de modules]]
[[Catégorie:API Ovidentia]]

== Les comptes utilisateurs ==

===bab_isUserAdministrator()===
Retourne '''true''' si l'utilisateur est administrateur. Sinon '''false'''
:'''function bab_isUserAdministrator()'''
===bab_isUserGroupManager()===
Retourne '''true''' si l'utilisateur est gestionnaire du groupe d'id $grpid. Sinon '''false'''
:'''function bab_isUserGroupManager($grpid="")'''
* '''$grpid''' :
*: ID du groupe pour lequel on souhaite savoir si l'utilisateur est gestionnaire. Si vide la fonction retiourne '''true''' si l'utilisateur est gestionnaire d'au moins un groupe.

===bab_getUserName()===
Retourne le nom complet de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserName($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserEmail()===
Retourne l'adresse email de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserEmail($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserNickname()===
Retourne l'identifiant de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserNickname($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserIdByEmail()===
Retourne l'ID de l'utilisateur à partir de son adresse email. Retourne 0 si aucun utilisateur
:'''function bab_getUserIdByEmail($email)'''
* '''$email''' :
*: Adresse email de l'utilisateur

===bab_getUserIdByNickname()===
Retourne l'ID de l'utilisateur à partir de son identifiant. Retourne 0 si aucun utilisateur
:'''function bab_getUserIdByNickname($nickname)'''
* '''$nickname''' :
*: Identifiant de l'utilisateur

===bab_getUserId()===
Retourn l'ID de l'utilisateur à partir de son nom. Sinon 0.
:'''function bab_getUserId( $name )'''
* '''$name''' :
*: Nom de l'utilisateur

===bab_getUserGroups()===
Retourne un tableau contenant les ID et les noms des groupes auxquels l'utilisateur appartient.
:'''function bab_getUserGroups($id = "")'''
* '''$id''' :
*: ID de l'utilisateur. Si vide le système utilise celui de l'utilisateur courant

===bab_composeUserName()===
Retourne une chaîne contenant le nom complet de l'utilisateur selon les préférences du site ( nom/prénom ou prénom/nom )
:'''function bab_composeUserName( $F, $L)'''
* '''$F''' :
*: Prénom de l'utilisateur
* '''$L''' :
*: Nom de l'utilisateur

===bab_userIsloggedin()===
Retourne '''true''' si l'utilisateur courant est authentifié. Sinon elle retourne '''false'''
:'''function bab_userIsloggedin()'''

===bab_registerUser()===
Permet d'inscrire un utilisateur dans le portail.
Retourne l'ID de l'utilisateur inscrit. Sinon '''false'''.
:'''function bab_registerUser($firstname, $lastname, $middlename, $email, $nickname, $password1, $password2, $confirmed, &$error, $bgroup = true)'''
* '''$firstname''' :
*: Prénom de l'utilisateur à inscrire
* '''$lastname''' :
*: Nom de l'utilisateur à inscrire
* '''$middlename''' :
*: Deuxième prénom de l'utilisateur à inscrire
* '''$email''' :
*: Adresse email de l'utilisateur à inscrire
* '''$nickname''' :
*: Identifiant de l'utilisateur à inscrire
* '''$password1''' :
*: Mot de passe de l'utilisateur à inscrire
* '''$password2''' :
*: De nouveau le même mot de passe de l'utilisateur à inscrire
* '''$confirmed''' :
*: '''true''' si l'inscription de l'utilisateur sera confirmée. Sinon '''false'''
* '''$error''' :
*: Variable passée par référence. Si l'inscription échoue, elle sera initialisée avec le message d'erreur

===bab_getUserInfos()===

Obtenir les informations d'un utilisateur, la fonction retourne un tableau contenant la fiche annuaire de l'utilisateur et les champs spécifiques obligatoires. Les information obtenues peuvent être utilisées en entrée avec la fonction bab_updateUserById()

les champs retournés par la fonction qui sont toujours présents sont :

*disabled : booléen 1 ou 0
*password_md5 : mot de passe du compte Ovidentia
*changepwd : booléen 1 ou 0
*is_confirmed : booléen 1 ou 0
*cn : surnom
*sn : nom
*mn : deuxième prénom
*givenname : prénom
*jpegphoto
*email
*btel
*mobile : numéro de téléphone mobile
*htel
*bfax
*title
*departmentnumber
*organisationname
*bstreetaddress,
*bcity
*bpostalcode
*bstate
*bcountry
*hstreetaddress
*hcity
*hpostalcode
*hstate
*hcountry
*user1
*user2
*user3

Remarque : il peut y avoir des champ d'annuaire optionnels. Des champs comme jpegphoto (photo de l'utilisateur) peuvent être désactivés par l'administrateur du site. Dans ce cas le tableau retourné ne contiendra pas l'entrée jpegphoto.

:'''function bab_getUserInfos($id_user)'''

===bab_canCurrentUserUpdateUser()===

Vérifie si l'utilisateur courant a les droits d'accès pour modifier le compte d'un utilisateur spécifié par son id. Retourne true ou false. True si l'utilisateur a les droits.

:'''function bab_canCurrentUserUpdateUser($userId)'''

* '''$userId''' :
*: ID de l'utilisateur à modifier

===bab_updateUserPasswordById()===

Modification du mot de passe de connexion d'un utilisateur. Retourne true ou false. True si l'utilisateur a été modifié.

:'''function bab_updateUserPasswordById($userId, $newPassword, $newPassword2, $ignoreAccessRights=false, &$error)'''

* '''$userId''' :
*: ID de l'utilisateur à modifier
* '''$newPassword''' :
*: nouveau mot de passe de connexion
* '''$newPassword2''' :
*: copie du nouveau mot de passe de connexion (utilisé lorsqu'on demande 2 fois le mot de passe dans un formulaire pour valider la saisie)
* '''$ignoreAccessRights''' :
*: booléen. Si true, on ignore les droits d'accès de l'utilisateur courant quant à sa possibilité de modifier le compte utilisateur
* '''$error''' :
*: En cas d'erreurs, retourne le message Ovidentia traduit

===bab_updateUserNicknameById()===

Modification de l'identifiant de connexion d'un utilisateur. Retourne true ou false. True si l'utilisateur a été modifié.

:'''function bab_updateUserNicknameById($userId, $newNickname, $ignoreAccessRights=false, &$error)'''

* '''$userId''' :
*: ID de l'utilisateur à modifier
* '''$newNickname''' :
*: nouvel identifiant de connexion
* '''$ignoreAccessRights''' :
*: booléen. Si true, on ignore les droits d'accès de l'utilisateur courant quant à sa possibilité de modifier le compte utilisateur
* '''$error''' :
*: En cas d'erreurs, retourne le message Ovidentia traduit

===bab_updateUserById()===

Modification d'un utilisateur

:'''function bab_updateUserById($id, $info, &$error)'''

* '''$id''' :
*: ID de l'utilisateur à modifier
* '''$info''' :
*: $info est une variable tableau contenant les nouvelles valeurs à enregistrées, le format du tableau correspond au format retourné par la fonction bab_getUserInfos()
* '''&$error''' :
*: En cas d'erreur, cette variable sera renseignée avec un message d'erreur

===bab_updateUserByNickname()===

Modifier les informations d'un utilisateur a partir de l'identifiant

:'''function bab_updateUserByNickname($nickname, $info, &$error)'''

* '''$nickname''' :
*: Identifiant de l'utilisateur à modifier
* '''$info''' :
*: $info est une variable tableau contenant les nouvelles valeurs à enregistrées, le format du tableau correspond au format retourné par la fonction bab_getUserInfos()
* '''&$error''' :
*: En cas d'erreur, cette variable sera renseignée avec un message d'erreur

== Les fiches d'annuaires ==

===bab_getDirEntry()===

Retourne une fiche d'annuaire ou une liste de fiches d'annuaires.

retourne false si il y a une erreur dans les paramètres

retourne un tableau vide si l'utilisateur n'a pas accès aux informations

:'''function bab_getDirEntry($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = NULL )'''

* '''$id''' :
*: Ce paramètre est optionnel, les valeurs possibles sont :
*:
*: false : si le type est BAB_DIR_ENTRY_ID_USER, l'id de l'utilisateur connecté sera utilisé.
*: un nombre entier : utilisable pour tout les types
*: un tableau de nombre entiers : une liste d'id peut être utilisée pour les types BAB_DIR_ENTRY_ID_USER et BAB_DIR_ENTRY_ID dans ce cas la fonction retournera plusieurs fiches d'annuaire dans un tableau.

* '''type''' :
*: Ce paramètre est optionnel, il correspond au type d'information fourni dans le premier paramètre de la fonction, les valeurs possibles sont
*:
*: BAB_DIR_ENTRY_ID_USER : $id est un id d'utilisateur
*: BAB_DIR_ENTRY_ID : $id est un id de fiche d'annuaire
*: BAB_DIR_ENTRY_ID_DIRECTORY : $id est un id d'annuaire, dans ce cas seul la liste des champs de l'annuaire est retournée
*: BAB_DIR_ENTRY_ID_GROUP : $id est un id de groupe d'utilisateur, dans ce cas seul la liste des champs de l'annuaire de groupe est retournée
*:
*: La valeur par défaut est BAB_DIR_ENTRY_ID_USER

* '''$id_directory''' :
*: Ce paramètre est optionnel, peut être spécifié si le type est BAB_DIR_ENTRY_ID

===bab_getUserDirectories()===

Retourne une liste d'annuaires visibles par l'utilisateur

:'''function bab_getUserDirectories()'''

===bab_getUserDirEntryLink()===

Cette fonction permet d'obtenir un lien vers une fiche d'annuaire, pour un utilisateur ou un ID de fiche d'annuaire.

retourne false si la fiche n'est pas accessible

:'''function bab_getUserDirEntryLink($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = false)'''

* '''$id''' :
*: Ce paramètre est optionnel, les valeurs possibles sont :
*:
*: false : si le type est BAB_DIR_ENTRY_ID_USER, l'id de l'utilisateur connecté sera utilisé.
*: un nombre entier : utilisable pour tout les types

* '''type''' :
*: Ce paramètre est optionnel, il correspond au type d'information fourni dans le premier paramètre de la fonction, les valeurs possibles sont
*:
*: BAB_DIR_ENTRY_ID_USER : $id est un id d'utilisateur
*: BAB_DIR_ENTRY_ID : $id est un id de fiche d'annuaire
*:
*: La valeur par défaut est BAB_DIR_ENTRY_ID_USER

* '''$id_directory''' :
*: Ce paramètre est optionnel, peut être spécifié si le type est BAB_DIR_ENTRY_ID

API des utilisateurs et des annuaires

2010-03-29T13:48:55Z

Jeraiz : /* bab_updateUserById() */

[[Catégorie:Développement de modules]]
[[Catégorie:API Ovidentia]]

== Les comptes utilisateurs ==

===bab_isUserAdministrator()===
Retourne '''true''' si l'utilisateur est administrateur. Sinon '''false'''
:'''function bab_isUserAdministrator()'''
===bab_isUserGroupManager()===
Retourne '''true''' si l'utilisateur est gestionnaire du groupe d'id $grpid. Sinon '''false'''
:'''function bab_isUserGroupManager($grpid="")'''
* '''$grpid''' :
*: ID du groupe pour lequel on souhaite savoir si l'utilisateur est gestionnaire. Si vide la fonction retiourne '''true''' si l'utilisateur est gestionnaire d'au moins un groupe.

===bab_getUserName()===
Retourne le nom complet de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserName($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserEmail()===
Retourne l'adresse email de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserEmail($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserNickname()===
Retourne l'identifiant de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserNickname($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserIdByEmail()===
Retourne l'ID de l'utilisateur à partir de son adresse email. Retourne 0 si aucun utilisateur
:'''function bab_getUserIdByEmail($email)'''
* '''$email''' :
*: Adresse email de l'utilisateur

===bab_getUserIdByNickname()===
Retourne l'ID de l'utilisateur à partir de son identifiant. Retourne 0 si aucun utilisateur
:'''function bab_getUserIdByNickname($nickname)'''
* '''$nickname''' :
*: Identifiant de l'utilisateur

===bab_getUserId()===
Retourn l'ID de l'utilisateur à partir de son nom. Sinon 0.
:'''function bab_getUserId( $name )'''
* '''$name''' :
*: Nom de l'utilisateur

===bab_getUserGroups()===
Retourne un tableau contenant les ID et les noms des groupes auxquels l'utilisateur appartient.
:'''function bab_getUserGroups($id = "")'''
* '''$id''' :
*: ID de l'utilisateur. Si vide le système utilise celui de l'utilisateur courant

===bab_composeUserName()===
Retourne une chaîne contenant le nom complet de l'utilisateur selon les préférences du site ( nom/prénom ou prénom/nom )
:'''function bab_composeUserName( $F, $L)'''
* '''$F''' :
*: Prénom de l'utilisateur
* '''$L''' :
*: Nom de l'utilisateur

===bab_userIsloggedin()===
Retourne '''true''' si l'utilisateur courant est authentifié. Sinon elle retourne '''false'''
:'''function bab_userIsloggedin()'''

===bab_registerUser()===
Permet d'inscrire un utilisateur dans le portail.
Retourne l'ID de l'utilisateur inscrit. Sinon '''false'''.
:'''function bab_registerUser($firstname, $lastname, $middlename, $email, $nickname, $password1, $password2, $confirmed, &$error, $bgroup = true)'''
* '''$firstname''' :
*: Prénom de l'utilisateur à inscrire
* '''$lastname''' :
*: Nom de l'utilisateur à inscrire
* '''$middlename''' :
*: Deuxième prénom de l'utilisateur à inscrire
* '''$email''' :
*: Adresse email de l'utilisateur à inscrire
* '''$nickname''' :
*: Identifiant de l'utilisateur à inscrire
* '''$password1''' :
*: Mot de passe de l'utilisateur à inscrire
* '''$password2''' :
*: De nouveau le même mot de passe de l'utilisateur à inscrire
* '''$confirmed''' :
*: '''true''' si l'inscription de l'utilisateur sera confirmée. Sinon '''false'''
* '''$error''' :
*: Variable passée par référence. Si l'inscription échoue, elle sera initialisée avec le message d'erreur

===bab_getUserInfos()===

Obtenir les informations d'un utilisateur, la fonction retourne un tableau contenant la fiche annuaire de l'utilisateur et les champs spécifiques obligatoires. Les information obtenues peuvent être utilisées en entrée avec la fonction bab_updateUserById()

les champs retournés par la fonction qui sont toujours présents sont :

*disabled : booléen 1 ou 0
*password_md5 : mot de passe du compte Ovidentia
*changepwd : booléen 1 ou 0
*is_confirmed : booléen 1 ou 0
*cn : surnom
*sn : nom
*mn : deuxième prénom
*givenname : prénom
*jpegphoto
*email
*btel
*mobile : numéro de téléphone mobile
*htel
*bfax
*title
*departmentnumber
*organisationname
*bstreetaddress,
*bcity
*bpostalcode
*bstate
*bcountry
*hstreetaddress
*hcity
*hpostalcode
*hstate
*hcountry
*user1
*user2
*user3

Remarque : il peut y avoir des champ d'annuaire optionnels. Des champs comme jpegphoto (photo de l'utilisateur) peuvent être désactivés par l'administrateur du site. Dans ce cas le tableau retourné ne contiendra pas l'entrée jpegphoto.

:'''function bab_getUserInfos($id_user)'''

===bab_canCurrentUserUpdateUser()===

Vérifie si l'utilisateur courant a les droits d'accès pour modifier le compte d'un utilisateur spécifié par son id. Retourne true ou false. True si l'utilisateur a les droits.

:'''function bab_canCurrentUserUpdateUser($userId)'''

* '''$userId''' :
*: ID de l'utilisateur à modifier

===bab_updateUserNicknameById()===

Modification de l'identifiant de connexion d'un utilisateur. Retourne true ou false. True si l'utilisateur a été modifié.

:'''function bab_updateUserNicknameById($userId, $newNickname, $ignoreAccessRights=false, &$error)'''

* '''$userId''' :
*: ID de l'utilisateur à modifier
* '''$newNickname''' :
*: nouvel identifiant de connexion
* '''$ignoreAccessRights''' :
*: booléen. Si true, on ignore les droits d'accès de l'utilisateur courant quant à sa possibilité de modifier le compte utilisateur
* '''$error''' :
*: En cas d'erreurs, retourne le message Ovidentia traduit

===bab_updateUserById()===

Modification d'un utilisateur

:'''function bab_updateUserById($id, $info, &$error)'''

* '''$id''' :
*: ID de l'utilisateur à modifier
* '''$info''' :
*: $info est une variable tableau contenant les nouvelles valeurs à enregistrées, le format du tableau correspond au format retourné par la fonction bab_getUserInfos()
* '''&$error''' :
*: En cas d'erreur, cette variable sera renseignée avec un message d'erreur

===bab_updateUserByNickname()===

Modifier les informations d'un utilisateur a partir de l'identifiant

:'''function bab_updateUserByNickname($nickname, $info, &$error)'''

* '''$nickname''' :
*: Identifiant de l'utilisateur à modifier
* '''$info''' :
*: $info est une variable tableau contenant les nouvelles valeurs à enregistrées, le format du tableau correspond au format retourné par la fonction bab_getUserInfos()
* '''&$error''' :
*: En cas d'erreur, cette variable sera renseignée avec un message d'erreur

== Les fiches d'annuaires ==

===bab_getDirEntry()===

Retourne une fiche d'annuaire ou une liste de fiches d'annuaires.

retourne false si il y a une erreur dans les paramètres

retourne un tableau vide si l'utilisateur n'a pas accès aux informations

:'''function bab_getDirEntry($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = NULL )'''

* '''$id''' :
*: Ce paramètre est optionnel, les valeurs possibles sont :
*:
*: false : si le type est BAB_DIR_ENTRY_ID_USER, l'id de l'utilisateur connecté sera utilisé.
*: un nombre entier : utilisable pour tout les types
*: un tableau de nombre entiers : une liste d'id peut être utilisée pour les types BAB_DIR_ENTRY_ID_USER et BAB_DIR_ENTRY_ID dans ce cas la fonction retournera plusieurs fiches d'annuaire dans un tableau.

* '''type''' :
*: Ce paramètre est optionnel, il correspond au type d'information fourni dans le premier paramètre de la fonction, les valeurs possibles sont
*:
*: BAB_DIR_ENTRY_ID_USER : $id est un id d'utilisateur
*: BAB_DIR_ENTRY_ID : $id est un id de fiche d'annuaire
*: BAB_DIR_ENTRY_ID_DIRECTORY : $id est un id d'annuaire, dans ce cas seul la liste des champs de l'annuaire est retournée
*: BAB_DIR_ENTRY_ID_GROUP : $id est un id de groupe d'utilisateur, dans ce cas seul la liste des champs de l'annuaire de groupe est retournée
*:
*: La valeur par défaut est BAB_DIR_ENTRY_ID_USER

* '''$id_directory''' :
*: Ce paramètre est optionnel, peut être spécifié si le type est BAB_DIR_ENTRY_ID

===bab_getUserDirectories()===

Retourne une liste d'annuaires visibles par l'utilisateur

:'''function bab_getUserDirectories()'''

===bab_getUserDirEntryLink()===

Cette fonction permet d'obtenir un lien vers une fiche d'annuaire, pour un utilisateur ou un ID de fiche d'annuaire.

retourne false si la fiche n'est pas accessible

:'''function bab_getUserDirEntryLink($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = false)'''

* '''$id''' :
*: Ce paramètre est optionnel, les valeurs possibles sont :
*:
*: false : si le type est BAB_DIR_ENTRY_ID_USER, l'id de l'utilisateur connecté sera utilisé.
*: un nombre entier : utilisable pour tout les types

* '''type''' :
*: Ce paramètre est optionnel, il correspond au type d'information fourni dans le premier paramètre de la fonction, les valeurs possibles sont
*:
*: BAB_DIR_ENTRY_ID_USER : $id est un id d'utilisateur
*: BAB_DIR_ENTRY_ID : $id est un id de fiche d'annuaire
*:
*: La valeur par défaut est BAB_DIR_ENTRY_ID_USER

* '''$id_directory''' :
*: Ce paramètre est optionnel, peut être spécifié si le type est BAB_DIR_ENTRY_ID

API des utilisateurs et des annuaires

2010-03-29T12:45:16Z

Jeraiz : /* bab_getUserInfos() */

[[Catégorie:Développement de modules]]
[[Catégorie:API Ovidentia]]

== Les comptes utilisateurs ==

===bab_isUserAdministrator()===
Retourne '''true''' si l'utilisateur est administrateur. Sinon '''false'''
:'''function bab_isUserAdministrator()'''
===bab_isUserGroupManager()===
Retourne '''true''' si l'utilisateur est gestionnaire du groupe d'id $grpid. Sinon '''false'''
:'''function bab_isUserGroupManager($grpid="")'''
* '''$grpid''' :
*: ID du groupe pour lequel on souhaite savoir si l'utilisateur est gestionnaire. Si vide la fonction retiourne '''true''' si l'utilisateur est gestionnaire d'au moins un groupe.

===bab_getUserName()===
Retourne le nom complet de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserName($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserEmail()===
Retourne l'adresse email de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserEmail($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserNickname()===
Retourne l'identifiant de l'utilisateur d'ID $id.Sinon une chaîne vide.
:'''function bab_getUserNickname($id)'''
* '''$id''' :
*: ID de l'utilisateur

===bab_getUserIdByEmail()===
Retourne l'ID de l'utilisateur à partir de son adresse email. Retourne 0 si aucun utilisateur
:'''function bab_getUserIdByEmail($email)'''
* '''$email''' :
*: Adresse email de l'utilisateur

===bab_getUserIdByNickname()===
Retourne l'ID de l'utilisateur à partir de son identifiant. Retourne 0 si aucun utilisateur
:'''function bab_getUserIdByNickname($nickname)'''
* '''$nickname''' :
*: Identifiant de l'utilisateur

===bab_getUserId()===
Retourn l'ID de l'utilisateur à partir de son nom. Sinon 0.
:'''function bab_getUserId( $name )'''
* '''$name''' :
*: Nom de l'utilisateur

===bab_getUserGroups()===
Retourne un tableau contenant les ID et les noms des groupes auxquels l'utilisateur appartient.
:'''function bab_getUserGroups($id = "")'''
* '''$id''' :
*: ID de l'utilisateur. Si vide le système utilise celui de l'utilisateur courant

===bab_composeUserName()===
Retourne une chaîne contenant le nom complet de l'utilisateur selon les préférences du site ( nom/prénom ou prénom/nom )
:'''function bab_composeUserName( $F, $L)'''
* '''$F''' :
*: Prénom de l'utilisateur
* '''$L''' :
*: Nom de l'utilisateur

===bab_userIsloggedin()===
Retourne '''true''' si l'utilisateur courant est authentifié. Sinon elle retourne '''false'''
:'''function bab_userIsloggedin()'''

===bab_registerUser()===
Permet d'inscrire un utilisateur dans le portail.
Retourne l'ID de l'utilisateur inscrit. Sinon '''false'''.
:'''function bab_registerUser($firstname, $lastname, $middlename, $email, $nickname, $password1, $password2, $confirmed, &$error, $bgroup = true)'''
* '''$firstname''' :
*: Prénom de l'utilisateur à inscrire
* '''$lastname''' :
*: Nom de l'utilisateur à inscrire
* '''$middlename''' :
*: Deuxième prénom de l'utilisateur à inscrire
* '''$email''' :
*: Adresse email de l'utilisateur à inscrire
* '''$nickname''' :
*: Identifiant de l'utilisateur à inscrire
* '''$password1''' :
*: Mot de passe de l'utilisateur à inscrire
* '''$password2''' :
*: De nouveau le même mot de passe de l'utilisateur à inscrire
* '''$confirmed''' :
*: '''true''' si l'inscription de l'utilisateur sera confirmée. Sinon '''false'''
* '''$error''' :
*: Variable passée par référence. Si l'inscription échoue, elle sera initialisée avec le message d'erreur

===bab_getUserInfos()===

Obtenir les informations d'un utilisateur, la fonction retourne un tableau contenant la fiche annuaire de l'utilisateur et les champs spécifiques obligatoires. Les information obtenues peuvent être utilisées en entrée avec la fonction bab_updateUserById()

les champs retournés par la fonction qui sont toujours présents sont :

*disabled : booléen 1 ou 0
*password_md5 : mot de passe du compte Ovidentia
*changepwd : booléen 1 ou 0
*is_confirmed : booléen 1 ou 0
*cn : surnom
*sn : nom
*mn : deuxième prénom
*givenname : prénom
*jpegphoto
*email
*btel
*mobile : numéro de téléphone mobile
*htel
*bfax
*title
*departmentnumber
*organisationname
*bstreetaddress,
*bcity
*bpostalcode
*bstate
*bcountry
*hstreetaddress
*hcity
*hpostalcode
*hstate
*hcountry
*user1
*user2
*user3

Remarque : il peut y avoir des champ d'annuaire optionnels. Des champs comme jpegphoto (photo de l'utilisateur) peuvent être désactivés par l'administrateur du site. Dans ce cas le tableau retourné ne contiendra pas l'entrée jpegphoto.

:'''function bab_getUserInfos($id_user)'''

===bab_updateUserById()===

Modification d'un utilisateur

:'''function bab_updateUserById($id, $info, &$error)'''

* '''$id''' :
*: ID de l'utilisateur à modifier
* '''$info''' :
*: $info est une variable tableau contenant les nouvelles valeurs à enregistrées, le format du tableau correspond au format retourné par la fonction bab_getUserInfos()
* '''&$error''' :
*: En cas d'erreur, cette variable sera renseignée avec un message d'erreur

===bab_updateUserByNickname()===

Modifier les informations d'un utilisateur a partir de l'identifiant

:'''function bab_updateUserByNickname($nickname, $info, &$error)'''

* '''$nickname''' :
*: Identifiant de l'utilisateur à modifier
* '''$info''' :
*: $info est une variable tableau contenant les nouvelles valeurs à enregistrées, le format du tableau correspond au format retourné par la fonction bab_getUserInfos()
* '''&$error''' :
*: En cas d'erreur, cette variable sera renseignée avec un message d'erreur

== Les fiches d'annuaires ==

===bab_getDirEntry()===

Retourne une fiche d'annuaire ou une liste de fiches d'annuaires.

retourne false si il y a une erreur dans les paramètres

retourne un tableau vide si l'utilisateur n'a pas accès aux informations

:'''function bab_getDirEntry($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = NULL )'''

* '''$id''' :
*: Ce paramètre est optionnel, les valeurs possibles sont :
*:
*: false : si le type est BAB_DIR_ENTRY_ID_USER, l'id de l'utilisateur connecté sera utilisé.
*: un nombre entier : utilisable pour tout les types
*: un tableau de nombre entiers : une liste d'id peut être utilisée pour les types BAB_DIR_ENTRY_ID_USER et BAB_DIR_ENTRY_ID dans ce cas la fonction retournera plusieurs fiches d'annuaire dans un tableau.

* '''type''' :
*: Ce paramètre est optionnel, il correspond au type d'information fourni dans le premier paramètre de la fonction, les valeurs possibles sont
*:
*: BAB_DIR_ENTRY_ID_USER : $id est un id d'utilisateur
*: BAB_DIR_ENTRY_ID : $id est un id de fiche d'annuaire
*: BAB_DIR_ENTRY_ID_DIRECTORY : $id est un id d'annuaire, dans ce cas seul la liste des champs de l'annuaire est retournée
*: BAB_DIR_ENTRY_ID_GROUP : $id est un id de groupe d'utilisateur, dans ce cas seul la liste des champs de l'annuaire de groupe est retournée
*:
*: La valeur par défaut est BAB_DIR_ENTRY_ID_USER

* '''$id_directory''' :
*: Ce paramètre est optionnel, peut être spécifié si le type est BAB_DIR_ENTRY_ID

===bab_getUserDirectories()===

Retourne une liste d'annuaires visibles par l'utilisateur

:'''function bab_getUserDirectories()'''

===bab_getUserDirEntryLink()===

Cette fonction permet d'obtenir un lien vers une fiche d'annuaire, pour un utilisateur ou un ID de fiche d'annuaire.

retourne false si la fiche n'est pas accessible

:'''function bab_getUserDirEntryLink($id = false, $type = BAB_DIR_ENTRY_ID_USER, $id_directory = false)'''

* '''$id''' :
*: Ce paramètre est optionnel, les valeurs possibles sont :
*:
*: false : si le type est BAB_DIR_ENTRY_ID_USER, l'id de l'utilisateur connecté sera utilisé.
*: un nombre entier : utilisable pour tout les types

* '''type''' :
*: Ce paramètre est optionnel, il correspond au type d'information fourni dans le premier paramètre de la fonction, les valeurs possibles sont
*:
*: BAB_DIR_ENTRY_ID_USER : $id est un id d'utilisateur
*: BAB_DIR_ENTRY_ID : $id est un id de fiche d'annuaire
*:
*: La valeur par défaut est BAB_DIR_ENTRY_ID_USER

* '''$id_directory''' :
*: Ce paramètre est optionnel, peut être spécifié si le type est BAB_DIR_ENTRY_ID

Structures des tables de données d'Ovidentia

2010-03-04T09:56:34Z

Jeraiz : /* Table bab_cal_events */

Paramètres de la recherche

2010-02-24T13:29:36Z

Jeraiz : /* Paramètres généraux */

[[Catégorie:Développement de modules]]
[[Catégorie:API Ovidentia]]
[[Catégorie:Recherche]]
{{Warning|Cette normalisation des paramètres de la recherche est disponible à partir de Ovidentia 7.1.0}}

== But ==
Normaliser les paramètres passés au moteur de recherche d'OVIDENTIA afin de permettre aux utilisateurs ou aux addons de créer leur propre url de recherche.
La recherche doit permettre de prendre en compte les GET et les POST

== Paramètres généraux ==
URL : index.php?tg=search&...

{|class="prettytable" width="100%"
|| '''Paramètre'''
| '''Description'''
|-
|| idx || Si idx vaut 'find', la recherche est effectuée. Sinon seul le formulaire de recherche est affiché.
|-
|| what || Mot à rechercher
|-
|| what2 || Deuxième mot à rechercher
|-
|| option || Prend une des valeurs suivantes vide, OR, AND ou NOT
|-
|| item || Vide pour recherche dans tous les objets
* ''publication'' pour rechercher dans les articles
* ''forums'' pour rechercher dans forums
* ''faqs'' pour rechercher dans les faqs
* ''notes'' pour rechercher dans les notes
* ''files'' pour rechercher dans les fichiers
* ''contacts'' pour rechercher dans contacts
* ''directories'' pour rechercher dans les annuaires
* ''calendars'' pour rechercher dans les agendas
* ''addon/addonname'' or « addon/addonid » pour rechercher dans un un addon spécifique
|}

== Paramètres Articles ==

{|class="prettytable" width="100%"
|| '''Paramètre'''
| '''Description'''
|-
|| topic || vide ou id du thème où rechercher
|-
|| category || vide où la catégorie où chercher
|-
|| authorid || ID de l'auteur sinon vide
|-
|| before || Date de fin au format 'YYYY-MM-DD'
|-
|| after || Date de début au format 'YYYY-MM-DD'
|}

== Paramètres Forums ==
Pas de paramètres supplémentaires

== Paramètres Faqs ==
Pas de paramètres supplémentaires

== Paramètres Notes ==
Pas de paramètres supplémentaires

== Paramètres Fichiers ==

Pas de paramètres supplémentaires

== Paramètres Contacts ==
Pas de paramètres supplémentaires

== Paramètres Annuaires ==

{|class="prettytable" width="100%"
|| '''Paramètre''' || '''Description'''
|-
|| directoryid || ID de l'annuaire ou vide pour tous les annuaires
|-
|| f[0] || Nom du champ à chercher ( sn, givenname, email, etc … )
|-
|| v[0] || Valeur du champ à chercher ( sn, givenname, email, etc … )
|-
|| f[1] || Nom du champ à chercher ( sn, givenname, email, etc … )
|-
|| v[1] || Valeur du champ à chercher( sn, givenname, email, etc … )
|-
|| f[2] || Nom du champ à chercher ( sn, givenname, email, etc … )
|-
|| v[2] || Valeur du champ à chercher ( sn, givenname, email, etc … )
|}

Il est possible d'ajouter d'autres champs de recherche ou de ne pas tous les spécifier en augmentant ou en diminuant la clef des deux tableaux '''f''' et '''v'''

== Paramètres Agendas ==

{|class="prettytable" width="100%"
|| '''Paramètre'''
| '''Description'''
|-
|| calendarid || ID de l'agenda ou vide pour tous les agendas
|-
|| before || Date de fin au format 'YYYY-MM-DD'
|-
|| after || Date de début au format 'YYYY-MM-DD'
|}

Structures des tables de données d'Ovidentia

2010-01-07T14:03:59Z

Jeraiz : /* Table bab_users */

Cet article est en cours de rédaction. Son contenu n'est pas exhaustif.

== Agenda ==

=== Table bab_calendar ===
contient les agendas (les noms des agendas ne se trouvent pas dans cette table). La table est liée aux tables bab_cal_public, bab_cal_resources ou bab_cal_events (il n'y a pas de tables pour les agendas personnels)
* id : identifiant d'un agenda
* owner : correspond pour un agenda de ressources à l'identifiant de l'enregistrement dans la table bab_cal_resources
* type : type de l'agenda.
Agenda : 1
Agenda : 2
Agenda de ressources : 3

=== Table bab_cal_categories ===
contient les catégories d'événements
* id : identifiant de la catégorie
* name : nom de la catégorie
* description : description de la catégorie
* bgcolor : couleur héxa de la catégorie (ex : CC0000)

=== Table bab_cal_events ===
contient les événements des agendas (tous types d'agendas confondus). Cette table ne permet pas de savoir dans quels agendas sont publiés les événements car un événement peut faire partie de pluieurs agendas : voir table bab_cal_events_owners.
* id : identifiant de l'événement
* title : titre de l'événement
* description : description de l'événement
* description_format : format du texte de la description : html...
* location : lieu de l'événement
* start_date : date et heure de début de l'événement
* end_date : date et heure de fin de l'événement
* id_cat : identifiant de la catégorie d'événement
* id_creator : identifiant de l'auteur de l'événement
* hash : rempli uniquement lorsque l'événement est répétitif (ex : R_4697c6374e306b988eff36a868ff6f2c)
* color : couleur de l'événement (ex : FF0033)
* bprivate : indique si l'événement est privé. Valeur possible : Y ou N
* block : indique si l'événement est verrouillé. Valeur possible : Y ou N
* bfree : indique si l'événement est libre. Valeur possible : Y ou N
* date_modification : date de dernière modification de l'événement
* id_modifiedby : identifiant du dernier auteur modificateur
* uuid : identifiant unique de l'événement (utilisé pour des outils de synchronisation externe)

=== Table bab_cal_events_notes ===
contient les notes privées associées aux événements d'agendas par les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur
* note : contenu de la note

=== Table bab_cal_events_owners ===
lie les événements d'agendas (bab_cal_events) avec les agendas (bab_calendars)
* id_event : identifiant de l'événement
* id_cal : identifiant de l'agenda

=== Table bab_cal_events_reminders ===
contient les rappels d'événements pour les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur qui veut le rappel
* day : nombre de jours avant l'événement quand le rappel doit se déclencher
* hour : nombre d'heures avant l'événement quand le rappel doit se déclencher
* minute : nombre de minutes avant l'événement quand le rappel doit se déclencher
* bemail : vaut Y si les rappels doivent être envoyés par e-mails (voir options dans config.php), sinon N
* processed : vaut Y si l'utilisateur a demandé à cacher le rappel de sa fenêtre, sinon N par défaut

=== Table bab_cal_public ===
contient les agendas collectifs
* id : identifiant de l'agenda
* name : nom de l'agenda
* description : description de l'agenda
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation

=== Table bab_cal_resources ===
contient les agendas de ressources
* id : identifiant de l'agenda
* name : nom de l'agenda
* description :
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation
* availability_lock : vaut 1 si on veut empêcher la création d'événements en surbooking, sinon 0.

=== Table bab_cal_user_options ===
contient les options privés des utilisateurs sur l'ensemble des agendas

== Articles ==

=== Table bab_articles ===
contient les articles
* id : identifiant de l'article
* id_topic : identifiant du thème d'articles où se situe l'article
* id_author : identifiant de l'auteur de l'article
* date : date de création de l'article
* date_publication : date de publication de l'article
* date_archiving : date d'archivage de l'article
* date_modification : date de dernière modification de l'article
* title : titre de l'article
* head : introduction de l'article (obligatoire)
* head_format : format du texte de la description : html...
* body : corps de l'article
* body_format : format du texte de la description : html...
* archive : indique si l'article est une archive. Valeurs possibles : N ou Y
* lang : langue de l'article (fr, en...)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* ordering : entier indiquant l'ordre d'affichage de l'article dans le thème par rapport aux autres articles du thème
* id_modifiedby : identifiant du dernier auteur modificateur
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3

=== Table bab_articles_images ===
contient les images associées aux articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts ===
contient les brouillons d'articles (Rappel : avant d'être soumis ou approuvés, les textes sont des brouillons. Les brouillons se transforment en articles dès qu'ils sont soumis et approuvés)
* id : identifiant du brouillon
* id_author : identifiant de l'auteur du brouillon
* date_creation : date de création du brouillon
* date_modification : date de dernière modification du brouillon
* date_submission : date de soumission du brouillon
* date_publication : date de publication du brouillon
* date_archiving : date d'archivage du brouillon
* title : titre du brouillon
* head : introduction du brouillon (obligatoire)
* head_format : format du texte de la description : html...
* body : corps du brouillon
* head_format : format du texte de la description : html...
* lang : langue du brouillon (fr, en...)
* trash : indique si le brouillon est dans la corbeille ou pas. Valeurs possibles : N ou Y
* id_topic : identifiant du thème d'articles où se trouve le brouillon (peut être vide)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* hpage_private : vaut Y si l'article est proposé pour les pages d'accueil privées
* hpage_public : vaut Y si l'article est proposé pour les pages d'accueil publiques
* notify_members : vaut Y l'option 'notifier les lecteurs' est cochée
* idfai : identifiant de l'instance en cours du schéma d'approbation
* result : statut d'approbation (type entier). Valeurs possibles : 0, 1, 2, 3
0 : statut par défaut si pas d'approbation en cours
1 : l'article brouillon est en attente d'approbation
2 : l'article brouillon est approuvé (Remarque : ce statut n'est jamais utilisé car un article brouillon approuvé se transforme en article)
3 : l'article brouillon a été refusé
* id_article : identifiant de l'article si le brouillon est une modification d'un article existant
* id_anonymous : identifiant de l'auteur si l'auteur n'est pas authentifié. C'est l'identifiant d'un enregistrement dans la table BAB_USERS_LOG_TBL.
* approbation : vaut 0, 1 ou 2
* update_datemodif : vaut Y si

=== Table bab_art_drafts_files ===
contient les fichiers joints aux brouillons d'articles
* id :
* id_draft : identifiant de l'article brouillon
* name : nom du fichier (Ex : gaston.jpg)
* description : description du fichier
* ordering : entier indiquant l'ordre d'affichage du fichier par rapport aux autres fichiers joints de l'article brouillon

=== Table bab_art_drafts_images ===
contient les images associées aux brouillons d'articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts_notes ===
contient les commentaires des approbateurs qui ont refusés les articles brouillons (Pour le publicateur, les commentaires sont affichées en prévisualisation de l'article, depuis la liste des brouillons (lien Publication/onglet Mes Articles si l'article est en cours d'approbation))
* id : identifiant de la note
* id_draft : identifiant de l'article brouillon associé
* content : contenu texte de la note
* id_author : identifiant de l'auteur de la note
* date_note : date de création de la note

=== Table bab_art_drafts_tags ===
contient les tags (fonction Thésaurus) associés à des articles brouillons
* id_draft : identifiant de l'article brouillon
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_art_files ===
contient les fichiers joints des articles
* id : identifiant du fichier joint à l'article
* id_article : identifiant de l'article
* name :
* description : description du fichier joint
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3
* ordering : entier indiquant l'ordre d'affichage du fichier joint avec les autres fichiers joints d'un même article

=== Table bab_art_log ===
contient l'historique des modifications d'articles
* id : identifiant de la modification
* id_article : identifiant de l'article
* id_author : identifiant de l'auteur de la modification
* date_log : date et heure de la modification
* action_log : statut de la modification. Valeurs possibles : lock, unlock, commit, refused, accepted.
Lorsqu'on saisit la raison de la modification avant de modifier un article, le statut est lock.
Lorsqu'on soumet un article, le statut est commit. Si l'article ne passe pas par approbation, il y a immédiatement un autre enregistrement avec le statut accepted. commit et accepted sont aussi utilisés lorsqu'on modifie un brouillon puis qu'on soumet.
Lorsqu'on modifie un article et qu'on l'enregistre (on ne le soumet pas), seul un enregistrement est créé : celui avec le statut lock et la raison de la modification.
Il n'y a pas d'enregistrements si on créé un article et qu'il ne doit pas être approuvé.
Lorsqu'on supprime un brouillon, le statut est unlock.
* art_log : description de la modification. Contient le texte saisit comme raison de la modification

=== Table bab_art_tags ===
contient les tags (fonction Thésaurus) associés à des articles
* id_art : identifiant de l'article
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_comments ===
contient les commentaires des articles
* id : identifiant du commentaire
* id_parent : identifiant du commentaire parent
* id_article : identifiant de l'article associé au commentaire
* id_topic : identifiant du thème d'articles dans lequel est créé l'article
* id_author : auteur du commentaire
* id_last_editor : identifiant du dernier auteur modificateur
* date : date de création du commentaire
* last_update : date de la dernière modification du commentaire
* subject : titre du commentaire
* message : contenu texte du commentaire
* confirmed : Y si le commentaire est approuvé, N sinon
* name : nom de l'auteur du commentaire
* email : email de l'auteur du commentaire
* idfai : identifiant de l'instance du schéma d'approbation utilisé pour ce commentaire
* lang : langue du commentaire (fr, en...)
* article_rating : note attribuée à l'article. Valeurs possibles : 0, 1, 2, 3, 4, 5
0 : l'article n'est pas noté

=== Table bab_topcat_order ===
contient les numéros pour les tris d'affichage des catégories et des thèmes. Attention, sous une catégorie parente, il est possible d'ordonner les sous-catégories avec les sous-thèmes (il y a donc des mélanges d'où la colonne type).
Rappel : une catégorie est un conteneur de sous-catégories ou de thèmes.
* id : identifiant de l'ordre
* id_topcat : identifiant de la catégorie ou du thème que l'on veut ordonner
* type : 1 si l'ordre est définit pour une catégorie d'articles. 2 si l'ordre est défini pour un thème d'articles.
* ordering : entier indiquant l'ordre d'affichage de l'objet par rapport aux autres objets de la catégorie parente (id_parent)
* id_parent : identifiant de la catégorie d'articles parente d'idtopcat. C'est la catégorie dans laquelle on veut ordonner notre objet. Vaut 0 si l'objet qu'on veut trier est une catégorie de premier niveau (pas de catégorie parente).

=== Table bab_topics ===
contient les thèmes d'articles
* id : identifiant du thème
* category : nom du thème
* description : description du thème
* description_format : format du texte de la description : html...
* id_cat : identifiant de la catégorie dans laquelle se trouve le thème
* idsaart : identifiant du schéma d'approbation à la création d'articles
* idsacom : identifiant du schéma d'approbation des commentaires
* idsa_update : identifiant du schéma d'approbation à la modification des articles
* notify : Y si les auteurs peuvent notifier les lecteurs par email, N sinon
* lang : langue du thème (fr, en...)
* article_tmpl : nom du modèle d'articles
* display_tmpl : nom du patron d'affichage
* restrict_access : Y si les auteurs peuvent restreindre l'accès aux articles, N sinon
* allow_hpages : Y si on permet aux auteurs de proposer leurs articles pour les pages d'accueil, N sinon
* allow_pubdates : Y si on permet aux auteurs de spécifier des dates de publication, N sinon
* allow_attachments : Y si on permet aux auteurs de joindre des fichiers avec leurs articles, N sinon
* allow_update : entier indiquant si les auteurs peuvent modifier leurs articles. Valeurs possibles : 0, 1, 2
0 : les auteurs ne peuvent pas modifier leurs articles
1 : les auteurs peuvent modifier leurs articles, mais avec approbation
2 : les auteurs peuvent modifier leurs articles et sans approbation
* max_articles : nombre maximum d'articles sur la page des archives
* allow_manupdate : entier indiquant si les gestionnaires peuvent modifier les articles. Valeurs possibles : 0, 1, 2
0 : les gestionnaires ne peuvent pas modifier les articles
1 : les gestionnaires peuvent modifier les articles, mais avec approbation
2 : les gestionnaires peuvent modifier les articles et sans approbation
* auto_approbation : Y si on approuve automatiquement le contributeur dans le cas où il fait partie de la première étape du schéma d'approbation, N sinon
* busetags : Y si on utilise les mots-clés du thésaurus, N sinon
* allow_addImg : Y si on permet aux auteurs d'associer une image à un article
* allow_article_rating : Y si on permet aux auteurs des commentaires de noter les articles, N sinon

=== Table bab_topicscom_groups ===
Table de droits d'accès : groupes pouvant faire des commentaires sur le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsman_groups ===
Table de droits d'accès : groupes gestionnaires du thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsmod_groups ===
Table de droits d'accès : groupes pouvant modifier des articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicssub_groups ===
Table de droits d'accès : groupes pouvant soumettre de nouveaux articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsview_groups ===
Table de droist d'accès : groupes pouvant voir les articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topics_categories ===
contient les catégories d'articles (conteneurs des thèmes d'articles)
* id : identifiant de la catégorie
* title : titre de la catégorie
* description : description de la catégorie
* enabled : vaut Y si la section de la catégorie est activée, N sinon
* template : nom du patron de section
* id_dgowner : identifiant de la délégation où se trouve la catégorie, 0 si dans tout le site
* optional : utilisation inconnue !!!
* id_parent : identifiant de la catégorie parente
* display_tmpl : nom du patron d'affichage

=== Table bab_topics_categories_images ===
contient les images associées aux catégories d'articles
* id : identifiant de l'image
* idCategory : identifiant de la catégorie d'articles
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_topics_images ===
contient les images associées aux thèmes d'articles
* id : identifiant de l'image
* idTopic : identifiant du thème
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

== Utilisateurs ==

=== Table bab_users ===
contient les comptes utilisateurs (attention : les enregistrements sont liés avec les tables d'annuaires comme bab_dbdir_entries)
* id : identifiant de l'utilisateur
* nickname : identifiant de connexion
* firstname : prénom
* lastname : nom
* hashname : concaténation du prénom, du deuxième prénom et du nom, sans les tirets ni les espaces puis crypté en MD5 (utilisé pour tester lors de la création d'un utilisateur si un utilisateur de même coordonnées existe déjà)
* email : adresse de messagerie
* date : date de la création du compte utilisateur
* password : mot de passe de connexion (crypté en MD5)
* changepwd :
* remote_addr :
* confirm_hash : clef de confirmation utilisée dans le lien de l'email de confirmation de la création du compte
* is_confirmed : 1 si le compte utilisateur a été confirmé par l'administrateur, 0 sinon
* disabled : 1 si le compte est désactivé (authentification impossible), 0 sinon
* validity_start : date de début de la validité du compte utilisateur (authentification temporaire), 0000-00-00 sinon
* validity_end : date de fin de la validité du compte utilisateur (authentification temporaire), 0000-00-00 sinon
* lang : langue à utiliser pour l'interface Ovidentia (fr, en...) ou valeur vide
* skin : nom du skin à utiliser pour l'interface Ovidentia ou valeur vide
* style : nom du fichier css du skin à utiliser pour l'interface Ovidentia ou valeur vide
* lastlog : date de l'authentification de la précédente session (utilisé par exemple pour déterminer ce qui a été publié sur le portail depuis votre dernière connexion)
* datelog : date de l'authentification de la session en cours
* langfilter : filtre de langue à utiliser pour l'interface Ovidentia (fr, en...) ou valeur vide
* date_longformat : format des dates longues (option de l'utilisateur pour l'affichage des dates dans Ovidentia)
* date_shortformat : format des dates courtes (option de l'utilisateur pour l'affichage des dates dans Ovidentia)
* time_format : format des horaires (option de l'utilisateur pour l'affichage des horaires dans Ovidentia)
* cookie_validity : date de fin de validité pour la clef d'authentification par cookie
* cookie_id : clef de l'authentification par cookie en cours d'utilisation
* id_sitemap_profile : identifiant du profil du plan du site (lié avec la table bab_sitemap_profiles) associé à l'utilisateur

Structures des tables de données d'Ovidentia

2010-01-07T13:29:54Z

Jeraiz : /* Table bab_users */

Cet article est en cours de rédaction. Son contenu n'est pas exhaustif.

== Agenda ==

=== Table bab_calendar ===
contient les agendas (les noms des agendas ne se trouvent pas dans cette table). La table est liée aux tables bab_cal_public, bab_cal_resources ou bab_cal_events (il n'y a pas de tables pour les agendas personnels)
* id : identifiant d'un agenda
* owner : correspond pour un agenda de ressources à l'identifiant de l'enregistrement dans la table bab_cal_resources
* type : type de l'agenda.
Agenda : 1
Agenda : 2
Agenda de ressources : 3

=== Table bab_cal_categories ===
contient les catégories d'événements
* id : identifiant de la catégorie
* name : nom de la catégorie
* description : description de la catégorie
* bgcolor : couleur héxa de la catégorie (ex : CC0000)

=== Table bab_cal_events ===
contient les événements des agendas (tous types d'agendas confondus). Cette table ne permet pas de savoir dans quels agendas sont publiés les événements car un événement peut faire partie de pluieurs agendas : voir table bab_cal_events_owners.
* id : identifiant de l'événement
* title : titre de l'événement
* description : description de l'événement
* description_format : format du texte de la description : html...
* location : lieu de l'événement
* start_date : date et heure de début de l'événement
* end_date : date et heure de fin de l'événement
* id_cat : identifiant de la catégorie d'événement
* id_creator : identifiant de l'auteur de l'événement
* hash : rempli uniquement lorsque l'événement est répétitif (ex : R_4697c6374e306b988eff36a868ff6f2c)
* color : couleur de l'événement (ex : FF0033)
* bprivate : indique si l'événement est privé. Valeur possible : Y ou N
* block : indique si l'événement est verrouillé. Valeur possible : Y ou N
* bfree : indique si l'événement est libre. Valeur possible : Y ou N
* date_modification : date de dernière modification de l'événement
* id_modifiedby : identifiant du dernier auteur modificateur
* uuid : identifiant unique de l'événement (utilisé pour des outils de synchronisation externe)

=== Table bab_cal_events_notes ===
contient les notes privées associées aux événements d'agendas par les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur
* note : contenu de la note

=== Table bab_cal_events_owners ===
lie les événements d'agendas (bab_cal_events) avec les agendas (bab_calendars)
* id_event : identifiant de l'événement
* id_cal : identifiant de l'agenda

=== Table bab_cal_events_reminders ===
contient les rappels d'événements pour les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur qui veut le rappel
* day : nombre de jours avant l'événement quand le rappel doit se déclencher
* hour : nombre d'heures avant l'événement quand le rappel doit se déclencher
* minute : nombre de minutes avant l'événement quand le rappel doit se déclencher
* bemail : vaut Y si les rappels doivent être envoyés par e-mails (voir options dans config.php), sinon N
* processed : vaut Y si l'utilisateur a demandé à cacher le rappel de sa fenêtre, sinon N par défaut

=== Table bab_cal_public ===
contient les agendas collectifs
* id : identifiant de l'agenda
* name : nom de l'agenda
* description : description de l'agenda
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation

=== Table bab_cal_resources ===
contient les agendas de ressources
* id : identifiant de l'agenda
* name : nom de l'agenda
* description :
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation
* availability_lock : vaut 1 si on veut empêcher la création d'événements en surbooking, sinon 0.

=== Table bab_cal_user_options ===
contient les options privés des utilisateurs sur l'ensemble des agendas

== Articles ==

=== Table bab_articles ===
contient les articles
* id : identifiant de l'article
* id_topic : identifiant du thème d'articles où se situe l'article
* id_author : identifiant de l'auteur de l'article
* date : date de création de l'article
* date_publication : date de publication de l'article
* date_archiving : date d'archivage de l'article
* date_modification : date de dernière modification de l'article
* title : titre de l'article
* head : introduction de l'article (obligatoire)
* head_format : format du texte de la description : html...
* body : corps de l'article
* body_format : format du texte de la description : html...
* archive : indique si l'article est une archive. Valeurs possibles : N ou Y
* lang : langue de l'article (fr, en...)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* ordering : entier indiquant l'ordre d'affichage de l'article dans le thème par rapport aux autres articles du thème
* id_modifiedby : identifiant du dernier auteur modificateur
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3

=== Table bab_articles_images ===
contient les images associées aux articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts ===
contient les brouillons d'articles (Rappel : avant d'être soumis ou approuvés, les textes sont des brouillons. Les brouillons se transforment en articles dès qu'ils sont soumis et approuvés)
* id : identifiant du brouillon
* id_author : identifiant de l'auteur du brouillon
* date_creation : date de création du brouillon
* date_modification : date de dernière modification du brouillon
* date_submission : date de soumission du brouillon
* date_publication : date de publication du brouillon
* date_archiving : date d'archivage du brouillon
* title : titre du brouillon
* head : introduction du brouillon (obligatoire)
* head_format : format du texte de la description : html...
* body : corps du brouillon
* head_format : format du texte de la description : html...
* lang : langue du brouillon (fr, en...)
* trash : indique si le brouillon est dans la corbeille ou pas. Valeurs possibles : N ou Y
* id_topic : identifiant du thème d'articles où se trouve le brouillon (peut être vide)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* hpage_private : vaut Y si l'article est proposé pour les pages d'accueil privées
* hpage_public : vaut Y si l'article est proposé pour les pages d'accueil publiques
* notify_members : vaut Y l'option 'notifier les lecteurs' est cochée
* idfai : identifiant de l'instance en cours du schéma d'approbation
* result : statut d'approbation (type entier). Valeurs possibles : 0, 1, 2, 3
0 : statut par défaut si pas d'approbation en cours
1 : l'article brouillon est en attente d'approbation
2 : l'article brouillon est approuvé (Remarque : ce statut n'est jamais utilisé car un article brouillon approuvé se transforme en article)
3 : l'article brouillon a été refusé
* id_article : identifiant de l'article si le brouillon est une modification d'un article existant
* id_anonymous : identifiant de l'auteur si l'auteur n'est pas authentifié. C'est l'identifiant d'un enregistrement dans la table BAB_USERS_LOG_TBL.
* approbation : vaut 0, 1 ou 2
* update_datemodif : vaut Y si

=== Table bab_art_drafts_files ===
contient les fichiers joints aux brouillons d'articles
* id :
* id_draft : identifiant de l'article brouillon
* name : nom du fichier (Ex : gaston.jpg)
* description : description du fichier
* ordering : entier indiquant l'ordre d'affichage du fichier par rapport aux autres fichiers joints de l'article brouillon

=== Table bab_art_drafts_images ===
contient les images associées aux brouillons d'articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts_notes ===
contient les commentaires des approbateurs qui ont refusés les articles brouillons (Pour le publicateur, les commentaires sont affichées en prévisualisation de l'article, depuis la liste des brouillons (lien Publication/onglet Mes Articles si l'article est en cours d'approbation))
* id : identifiant de la note
* id_draft : identifiant de l'article brouillon associé
* content : contenu texte de la note
* id_author : identifiant de l'auteur de la note
* date_note : date de création de la note

=== Table bab_art_drafts_tags ===
contient les tags (fonction Thésaurus) associés à des articles brouillons
* id_draft : identifiant de l'article brouillon
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_art_files ===
contient les fichiers joints des articles
* id : identifiant du fichier joint à l'article
* id_article : identifiant de l'article
* name :
* description : description du fichier joint
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3
* ordering : entier indiquant l'ordre d'affichage du fichier joint avec les autres fichiers joints d'un même article

=== Table bab_art_log ===
contient l'historique des modifications d'articles
* id : identifiant de la modification
* id_article : identifiant de l'article
* id_author : identifiant de l'auteur de la modification
* date_log : date et heure de la modification
* action_log : statut de la modification. Valeurs possibles : lock, unlock, commit, refused, accepted.
Lorsqu'on saisit la raison de la modification avant de modifier un article, le statut est lock.
Lorsqu'on soumet un article, le statut est commit. Si l'article ne passe pas par approbation, il y a immédiatement un autre enregistrement avec le statut accepted. commit et accepted sont aussi utilisés lorsqu'on modifie un brouillon puis qu'on soumet.
Lorsqu'on modifie un article et qu'on l'enregistre (on ne le soumet pas), seul un enregistrement est créé : celui avec le statut lock et la raison de la modification.
Il n'y a pas d'enregistrements si on créé un article et qu'il ne doit pas être approuvé.
Lorsqu'on supprime un brouillon, le statut est unlock.
* art_log : description de la modification. Contient le texte saisit comme raison de la modification

=== Table bab_art_tags ===
contient les tags (fonction Thésaurus) associés à des articles
* id_art : identifiant de l'article
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_comments ===
contient les commentaires des articles
* id : identifiant du commentaire
* id_parent : identifiant du commentaire parent
* id_article : identifiant de l'article associé au commentaire
* id_topic : identifiant du thème d'articles dans lequel est créé l'article
* id_author : auteur du commentaire
* id_last_editor : identifiant du dernier auteur modificateur
* date : date de création du commentaire
* last_update : date de la dernière modification du commentaire
* subject : titre du commentaire
* message : contenu texte du commentaire
* confirmed : Y si le commentaire est approuvé, N sinon
* name : nom de l'auteur du commentaire
* email : email de l'auteur du commentaire
* idfai : identifiant de l'instance du schéma d'approbation utilisé pour ce commentaire
* lang : langue du commentaire (fr, en...)
* article_rating : note attribuée à l'article. Valeurs possibles : 0, 1, 2, 3, 4, 5
0 : l'article n'est pas noté

=== Table bab_topcat_order ===
contient les numéros pour les tris d'affichage des catégories et des thèmes. Attention, sous une catégorie parente, il est possible d'ordonner les sous-catégories avec les sous-thèmes (il y a donc des mélanges d'où la colonne type).
Rappel : une catégorie est un conteneur de sous-catégories ou de thèmes.
* id : identifiant de l'ordre
* id_topcat : identifiant de la catégorie ou du thème que l'on veut ordonner
* type : 1 si l'ordre est définit pour une catégorie d'articles. 2 si l'ordre est défini pour un thème d'articles.
* ordering : entier indiquant l'ordre d'affichage de l'objet par rapport aux autres objets de la catégorie parente (id_parent)
* id_parent : identifiant de la catégorie d'articles parente d'idtopcat. C'est la catégorie dans laquelle on veut ordonner notre objet. Vaut 0 si l'objet qu'on veut trier est une catégorie de premier niveau (pas de catégorie parente).

=== Table bab_topics ===
contient les thèmes d'articles
* id : identifiant du thème
* category : nom du thème
* description : description du thème
* description_format : format du texte de la description : html...
* id_cat : identifiant de la catégorie dans laquelle se trouve le thème
* idsaart : identifiant du schéma d'approbation à la création d'articles
* idsacom : identifiant du schéma d'approbation des commentaires
* idsa_update : identifiant du schéma d'approbation à la modification des articles
* notify : Y si les auteurs peuvent notifier les lecteurs par email, N sinon
* lang : langue du thème (fr, en...)
* article_tmpl : nom du modèle d'articles
* display_tmpl : nom du patron d'affichage
* restrict_access : Y si les auteurs peuvent restreindre l'accès aux articles, N sinon
* allow_hpages : Y si on permet aux auteurs de proposer leurs articles pour les pages d'accueil, N sinon
* allow_pubdates : Y si on permet aux auteurs de spécifier des dates de publication, N sinon
* allow_attachments : Y si on permet aux auteurs de joindre des fichiers avec leurs articles, N sinon
* allow_update : entier indiquant si les auteurs peuvent modifier leurs articles. Valeurs possibles : 0, 1, 2
0 : les auteurs ne peuvent pas modifier leurs articles
1 : les auteurs peuvent modifier leurs articles, mais avec approbation
2 : les auteurs peuvent modifier leurs articles et sans approbation
* max_articles : nombre maximum d'articles sur la page des archives
* allow_manupdate : entier indiquant si les gestionnaires peuvent modifier les articles. Valeurs possibles : 0, 1, 2
0 : les gestionnaires ne peuvent pas modifier les articles
1 : les gestionnaires peuvent modifier les articles, mais avec approbation
2 : les gestionnaires peuvent modifier les articles et sans approbation
* auto_approbation : Y si on approuve automatiquement le contributeur dans le cas où il fait partie de la première étape du schéma d'approbation, N sinon
* busetags : Y si on utilise les mots-clés du thésaurus, N sinon
* allow_addImg : Y si on permet aux auteurs d'associer une image à un article
* allow_article_rating : Y si on permet aux auteurs des commentaires de noter les articles, N sinon

=== Table bab_topicscom_groups ===
Table de droits d'accès : groupes pouvant faire des commentaires sur le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsman_groups ===
Table de droits d'accès : groupes gestionnaires du thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsmod_groups ===
Table de droits d'accès : groupes pouvant modifier des articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicssub_groups ===
Table de droits d'accès : groupes pouvant soumettre de nouveaux articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsview_groups ===
Table de droist d'accès : groupes pouvant voir les articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topics_categories ===
contient les catégories d'articles (conteneurs des thèmes d'articles)
* id : identifiant de la catégorie
* title : titre de la catégorie
* description : description de la catégorie
* enabled : vaut Y si la section de la catégorie est activée, N sinon
* template : nom du patron de section
* id_dgowner : identifiant de la délégation où se trouve la catégorie, 0 si dans tout le site
* optional : utilisation inconnue !!!
* id_parent : identifiant de la catégorie parente
* display_tmpl : nom du patron d'affichage

=== Table bab_topics_categories_images ===
contient les images associées aux catégories d'articles
* id : identifiant de l'image
* idCategory : identifiant de la catégorie d'articles
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_topics_images ===
contient les images associées aux thèmes d'articles
* id : identifiant de l'image
* idTopic : identifiant du thème
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

== Utilisateurs ==

=== Table bab_users ===
contient les comptes utilisateurs (attention : les enregistrements sont liés avec les tables d'annuaires comme bab_dbdir_entries)
* id : identifiant de l'utilisateur
* nickname : identifiant de connexion
* firstname : prénom
* lastname : nom
* hashname :
* email : adresse de messagerie
* date :
* password : mot de passe de connexion (crypté en MD5)
* changepwd :
* remote_addr :
* confirm_hash :
* is_confirmed : 1 si le compte utilisateur a été confirmé par l'administrateur, 0 sinon
* disabled : 1 si le compte est désactivé (authentification impossible), 0 sinon
* validity_start : date de début de la validité du compte utilisateur (authentification temporaire), 0000-00-00 sinon
* validity_end : date de fin de la validité du compte utilisateur (authentification temporaire), 0000-00-00 sinon
* lang : langue à utiliser pour l'interface Ovidentia (fr, en...) ou valeur vide
* skin : nom du skin à utiliser pour l'interface Ovidentia ou valeur vide
* style : nom du fichier css du skin à utiliser pour l'interface Ovidentia ou valeur vide
* lastlog :
* datelog :
* langfilter : filtre de langue à utiliser pour l'interface Ovidentia (fr, en...) ou valeur vide
* date_longformat : format des dates longues (option de l'utilisateur pour l'affichage des dates dans Ovidentia)
* date_shortformat : format des dates courtes (option de l'utilisateur pour l'affichage des dates dans Ovidentia)
* time_format : format des horaires (option de l'utilisateur pour l'affichage des horaires dans Ovidentia)
* cookie_validity :
* cookie_id :
* id_sitemap_profile : identifiant du profil du plan du site (lié avec la table bab_sitemap_profiles) associé à l'utilisateur

Structures des tables de données d'Ovidentia

2010-01-07T13:11:34Z

Jeraiz :

Cet article est en cours de rédaction. Son contenu n'est pas exhaustif.

== Agenda ==

=== Table bab_calendar ===
contient les agendas (les noms des agendas ne se trouvent pas dans cette table). La table est liée aux tables bab_cal_public, bab_cal_resources ou bab_cal_events (il n'y a pas de tables pour les agendas personnels)
* id : identifiant d'un agenda
* owner : correspond pour un agenda de ressources à l'identifiant de l'enregistrement dans la table bab_cal_resources
* type : type de l'agenda.
Agenda : 1
Agenda : 2
Agenda de ressources : 3

=== Table bab_cal_categories ===
contient les catégories d'événements
* id : identifiant de la catégorie
* name : nom de la catégorie
* description : description de la catégorie
* bgcolor : couleur héxa de la catégorie (ex : CC0000)

=== Table bab_cal_events ===
contient les événements des agendas (tous types d'agendas confondus). Cette table ne permet pas de savoir dans quels agendas sont publiés les événements car un événement peut faire partie de pluieurs agendas : voir table bab_cal_events_owners.
* id : identifiant de l'événement
* title : titre de l'événement
* description : description de l'événement
* description_format : format du texte de la description : html...
* location : lieu de l'événement
* start_date : date et heure de début de l'événement
* end_date : date et heure de fin de l'événement
* id_cat : identifiant de la catégorie d'événement
* id_creator : identifiant de l'auteur de l'événement
* hash : rempli uniquement lorsque l'événement est répétitif (ex : R_4697c6374e306b988eff36a868ff6f2c)
* color : couleur de l'événement (ex : FF0033)
* bprivate : indique si l'événement est privé. Valeur possible : Y ou N
* block : indique si l'événement est verrouillé. Valeur possible : Y ou N
* bfree : indique si l'événement est libre. Valeur possible : Y ou N
* date_modification : date de dernière modification de l'événement
* id_modifiedby : identifiant du dernier auteur modificateur
* uuid : identifiant unique de l'événement (utilisé pour des outils de synchronisation externe)

=== Table bab_cal_events_notes ===
contient les notes privées associées aux événements d'agendas par les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur
* note : contenu de la note

=== Table bab_cal_events_owners ===
lie les événements d'agendas (bab_cal_events) avec les agendas (bab_calendars)
* id_event : identifiant de l'événement
* id_cal : identifiant de l'agenda

=== Table bab_cal_events_reminders ===
contient les rappels d'événements pour les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur qui veut le rappel
* day : nombre de jours avant l'événement quand le rappel doit se déclencher
* hour : nombre d'heures avant l'événement quand le rappel doit se déclencher
* minute : nombre de minutes avant l'événement quand le rappel doit se déclencher
* bemail : vaut Y si les rappels doivent être envoyés par e-mails (voir options dans config.php), sinon N
* processed : vaut Y si l'utilisateur a demandé à cacher le rappel de sa fenêtre, sinon N par défaut

=== Table bab_cal_public ===
contient les agendas collectifs
* id : identifiant de l'agenda
* name : nom de l'agenda
* description : description de l'agenda
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation

=== Table bab_cal_resources ===
contient les agendas de ressources
* id : identifiant de l'agenda
* name : nom de l'agenda
* description :
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation
* availability_lock : vaut 1 si on veut empêcher la création d'événements en surbooking, sinon 0.

=== Table bab_cal_user_options ===
contient les options privés des utilisateurs sur l'ensemble des agendas

== Articles ==

=== Table bab_articles ===
contient les articles
* id : identifiant de l'article
* id_topic : identifiant du thème d'articles où se situe l'article
* id_author : identifiant de l'auteur de l'article
* date : date de création de l'article
* date_publication : date de publication de l'article
* date_archiving : date d'archivage de l'article
* date_modification : date de dernière modification de l'article
* title : titre de l'article
* head : introduction de l'article (obligatoire)
* head_format : format du texte de la description : html...
* body : corps de l'article
* body_format : format du texte de la description : html...
* archive : indique si l'article est une archive. Valeurs possibles : N ou Y
* lang : langue de l'article (fr, en...)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* ordering : entier indiquant l'ordre d'affichage de l'article dans le thème par rapport aux autres articles du thème
* id_modifiedby : identifiant du dernier auteur modificateur
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3

=== Table bab_articles_images ===
contient les images associées aux articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts ===
contient les brouillons d'articles (Rappel : avant d'être soumis ou approuvés, les textes sont des brouillons. Les brouillons se transforment en articles dès qu'ils sont soumis et approuvés)
* id : identifiant du brouillon
* id_author : identifiant de l'auteur du brouillon
* date_creation : date de création du brouillon
* date_modification : date de dernière modification du brouillon
* date_submission : date de soumission du brouillon
* date_publication : date de publication du brouillon
* date_archiving : date d'archivage du brouillon
* title : titre du brouillon
* head : introduction du brouillon (obligatoire)
* head_format : format du texte de la description : html...
* body : corps du brouillon
* head_format : format du texte de la description : html...
* lang : langue du brouillon (fr, en...)
* trash : indique si le brouillon est dans la corbeille ou pas. Valeurs possibles : N ou Y
* id_topic : identifiant du thème d'articles où se trouve le brouillon (peut être vide)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* hpage_private : vaut Y si l'article est proposé pour les pages d'accueil privées
* hpage_public : vaut Y si l'article est proposé pour les pages d'accueil publiques
* notify_members : vaut Y l'option 'notifier les lecteurs' est cochée
* idfai : identifiant de l'instance en cours du schéma d'approbation
* result : statut d'approbation (type entier). Valeurs possibles : 0, 1, 2, 3
0 : statut par défaut si pas d'approbation en cours
1 : l'article brouillon est en attente d'approbation
2 : l'article brouillon est approuvé (Remarque : ce statut n'est jamais utilisé car un article brouillon approuvé se transforme en article)
3 : l'article brouillon a été refusé
* id_article : identifiant de l'article si le brouillon est une modification d'un article existant
* id_anonymous : identifiant de l'auteur si l'auteur n'est pas authentifié. C'est l'identifiant d'un enregistrement dans la table BAB_USERS_LOG_TBL.
* approbation : vaut 0, 1 ou 2
* update_datemodif : vaut Y si

=== Table bab_art_drafts_files ===
contient les fichiers joints aux brouillons d'articles
* id :
* id_draft : identifiant de l'article brouillon
* name : nom du fichier (Ex : gaston.jpg)
* description : description du fichier
* ordering : entier indiquant l'ordre d'affichage du fichier par rapport aux autres fichiers joints de l'article brouillon

=== Table bab_art_drafts_images ===
contient les images associées aux brouillons d'articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts_notes ===
contient les commentaires des approbateurs qui ont refusés les articles brouillons (Pour le publicateur, les commentaires sont affichées en prévisualisation de l'article, depuis la liste des brouillons (lien Publication/onglet Mes Articles si l'article est en cours d'approbation))
* id : identifiant de la note
* id_draft : identifiant de l'article brouillon associé
* content : contenu texte de la note
* id_author : identifiant de l'auteur de la note
* date_note : date de création de la note

=== Table bab_art_drafts_tags ===
contient les tags (fonction Thésaurus) associés à des articles brouillons
* id_draft : identifiant de l'article brouillon
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_art_files ===
contient les fichiers joints des articles
* id : identifiant du fichier joint à l'article
* id_article : identifiant de l'article
* name :
* description : description du fichier joint
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3
* ordering : entier indiquant l'ordre d'affichage du fichier joint avec les autres fichiers joints d'un même article

=== Table bab_art_log ===
contient l'historique des modifications d'articles
* id : identifiant de la modification
* id_article : identifiant de l'article
* id_author : identifiant de l'auteur de la modification
* date_log : date et heure de la modification
* action_log : statut de la modification. Valeurs possibles : lock, unlock, commit, refused, accepted.
Lorsqu'on saisit la raison de la modification avant de modifier un article, le statut est lock.
Lorsqu'on soumet un article, le statut est commit. Si l'article ne passe pas par approbation, il y a immédiatement un autre enregistrement avec le statut accepted. commit et accepted sont aussi utilisés lorsqu'on modifie un brouillon puis qu'on soumet.
Lorsqu'on modifie un article et qu'on l'enregistre (on ne le soumet pas), seul un enregistrement est créé : celui avec le statut lock et la raison de la modification.
Il n'y a pas d'enregistrements si on créé un article et qu'il ne doit pas être approuvé.
Lorsqu'on supprime un brouillon, le statut est unlock.
* art_log : description de la modification. Contient le texte saisit comme raison de la modification

=== Table bab_art_tags ===
contient les tags (fonction Thésaurus) associés à des articles
* id_art : identifiant de l'article
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_comments ===
contient les commentaires des articles
* id : identifiant du commentaire
* id_parent : identifiant du commentaire parent
* id_article : identifiant de l'article associé au commentaire
* id_topic : identifiant du thème d'articles dans lequel est créé l'article
* id_author : auteur du commentaire
* id_last_editor : identifiant du dernier auteur modificateur
* date : date de création du commentaire
* last_update : date de la dernière modification du commentaire
* subject : titre du commentaire
* message : contenu texte du commentaire
* confirmed : Y si le commentaire est approuvé, N sinon
* name : nom de l'auteur du commentaire
* email : email de l'auteur du commentaire
* idfai : identifiant de l'instance du schéma d'approbation utilisé pour ce commentaire
* lang : langue du commentaire (fr, en...)
* article_rating : note attribuée à l'article. Valeurs possibles : 0, 1, 2, 3, 4, 5
0 : l'article n'est pas noté

=== Table bab_topcat_order ===
contient les numéros pour les tris d'affichage des catégories et des thèmes. Attention, sous une catégorie parente, il est possible d'ordonner les sous-catégories avec les sous-thèmes (il y a donc des mélanges d'où la colonne type).
Rappel : une catégorie est un conteneur de sous-catégories ou de thèmes.
* id : identifiant de l'ordre
* id_topcat : identifiant de la catégorie ou du thème que l'on veut ordonner
* type : 1 si l'ordre est définit pour une catégorie d'articles. 2 si l'ordre est défini pour un thème d'articles.
* ordering : entier indiquant l'ordre d'affichage de l'objet par rapport aux autres objets de la catégorie parente (id_parent)
* id_parent : identifiant de la catégorie d'articles parente d'idtopcat. C'est la catégorie dans laquelle on veut ordonner notre objet. Vaut 0 si l'objet qu'on veut trier est une catégorie de premier niveau (pas de catégorie parente).

=== Table bab_topics ===
contient les thèmes d'articles
* id : identifiant du thème
* category : nom du thème
* description : description du thème
* description_format : format du texte de la description : html...
* id_cat : identifiant de la catégorie dans laquelle se trouve le thème
* idsaart : identifiant du schéma d'approbation à la création d'articles
* idsacom : identifiant du schéma d'approbation des commentaires
* idsa_update : identifiant du schéma d'approbation à la modification des articles
* notify : Y si les auteurs peuvent notifier les lecteurs par email, N sinon
* lang : langue du thème (fr, en...)
* article_tmpl : nom du modèle d'articles
* display_tmpl : nom du patron d'affichage
* restrict_access : Y si les auteurs peuvent restreindre l'accès aux articles, N sinon
* allow_hpages : Y si on permet aux auteurs de proposer leurs articles pour les pages d'accueil, N sinon
* allow_pubdates : Y si on permet aux auteurs de spécifier des dates de publication, N sinon
* allow_attachments : Y si on permet aux auteurs de joindre des fichiers avec leurs articles, N sinon
* allow_update : entier indiquant si les auteurs peuvent modifier leurs articles. Valeurs possibles : 0, 1, 2
0 : les auteurs ne peuvent pas modifier leurs articles
1 : les auteurs peuvent modifier leurs articles, mais avec approbation
2 : les auteurs peuvent modifier leurs articles et sans approbation
* max_articles : nombre maximum d'articles sur la page des archives
* allow_manupdate : entier indiquant si les gestionnaires peuvent modifier les articles. Valeurs possibles : 0, 1, 2
0 : les gestionnaires ne peuvent pas modifier les articles
1 : les gestionnaires peuvent modifier les articles, mais avec approbation
2 : les gestionnaires peuvent modifier les articles et sans approbation
* auto_approbation : Y si on approuve automatiquement le contributeur dans le cas où il fait partie de la première étape du schéma d'approbation, N sinon
* busetags : Y si on utilise les mots-clés du thésaurus, N sinon
* allow_addImg : Y si on permet aux auteurs d'associer une image à un article
* allow_article_rating : Y si on permet aux auteurs des commentaires de noter les articles, N sinon

=== Table bab_topicscom_groups ===
Table de droits d'accès : groupes pouvant faire des commentaires sur le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsman_groups ===
Table de droits d'accès : groupes gestionnaires du thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsmod_groups ===
Table de droits d'accès : groupes pouvant modifier des articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicssub_groups ===
Table de droits d'accès : groupes pouvant soumettre de nouveaux articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsview_groups ===
Table de droist d'accès : groupes pouvant voir les articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topics_categories ===
contient les catégories d'articles (conteneurs des thèmes d'articles)
* id : identifiant de la catégorie
* title : titre de la catégorie
* description : description de la catégorie
* enabled : vaut Y si la section de la catégorie est activée, N sinon
* template : nom du patron de section
* id_dgowner : identifiant de la délégation où se trouve la catégorie, 0 si dans tout le site
* optional : utilisation inconnue !!!
* id_parent : identifiant de la catégorie parente
* display_tmpl : nom du patron d'affichage

=== Table bab_topics_categories_images ===
contient les images associées aux catégories d'articles
* id : identifiant de l'image
* idCategory : identifiant de la catégorie d'articles
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_topics_images ===
contient les images associées aux thèmes d'articles
* id : identifiant de l'image
* idTopic : identifiant du thème
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

== Utilisateurs ==

=== Table bab_users ===
contient les comptes utilisateurs (attention : les enregistrements sont liés avec les tables d'annuaires comme bab_dbdir_entries)
* id : identifiant de l'utilisateur
* nickname : identifiant de connexion
* firstname : prénom
* lastname : nom
* hashname :
* email : adresse de messagerie
* date :
* password :
* changepwd :
* remote_addr :
* confirm_hash :
* is_confirmed :
* disabled :
* validity_start :
* validity_end :
* lang : langue à utiliser pour l'interface Ovidentia (fr, en...) ou valeur vide
* skin : nom du skin à utiliser pour l'interface Ovidentia ou valeur vide
* style : nom du fichier css du skin à utiliser pour l'interface Ovidentia ou valeur vide
* lastlog :
* datelog :
* langfilter : filtre de langue à utiliser pour l'interface Ovidentia (fr, en...) ou valeur vide
* date_longformat :
* date_shortformat :
* time_format :
* cookie_validity :
* cookie_id :
* id_sitemap_profile : identifiant du profil du plan du site (lié avec la table bab_sitemap_profiles) associé à l'utilisateur

API noyau/module

2009-12-11T09:59:41Z

Jeraiz :

[[Catégorie:Développement de modules]]
[[Catégorie:API Ovidentia]]

== Introduction ==
Cette partie contient l'ensemble des fonctions mises à la disposition des modules par le noyau.
Ces fonctions se trouvent dans le fichier addonapi.php qui se trouve dans le répertoire '''"utilit"''' de la distribution.

== API date/temps ==

Voir l'article : [[API des dates]]

== API Navigateur ==
===bab_browserOS()===
Retourne le système d'exploitation ( windows, macos, linux ou chaîne vide si autre )
:'''function bab_browserOS()'''
===bab_browserAgent()===
Retourne le type de navigateur ( konqueror, opera, msie, nn6, nn4 ou chaîne vide si autre )
:'''function bab_browserAgent()'''
===bab_browserVersion()===
Retourne la version du navigateur
:'''function bab_browserVersion()'''

== API Traduction ==
===bab_translate()===
Permet de traduire une chaîne
:'''function bab_translate($str, $folder = "", $lang="")'''
* '''$str''' :
*: Contient la chaîne à traduire
* '''$folder''' :
*: Sous répertoire du répertoire lang ( pour les modules )
* '''$lang''' :
*: Vers quelle langue il faut faire la traduction. Si vide le système utilise la langue courante

===bab_getAvailableLanguages()===
Retourne un tableau contenant les différentes langues disponibles
:'''function bab_getAvailableLanguages()'''

== API Utilisateur ==

Voir l'article [[API des utilisateurs et des annuaires#Les comptes utilisateurs ]]

== API ACL ==

Consultez la documentation [[Access Control List#Fonctions pour tester les droits]]

== API Calendrier popup ==
===bab_calendarPopup()===

Cette fonction est dépréciée, elle retourne une url pour afficher l'agenda de sélection d'une date. Il est préférable d'utiliser l'[[API javascript bab_dialog]] avec bab_dialog.selectdate()

:'''function bab_calendarPopup($callback, $month="", $year="", $low="", $high="")'''

* '''$callback''' :
*: Nom de la fonction javascript à appeler lorsque l'utilisateur a choisis une date
* '''$month''' :
*: Numéro du mois
* '''$year''' :
*: Numéro de l'année
* '''$low''' :
*: nombre d'année avant l'année spécifiée par $year disponible dans le calendrier
* '''$high''' :
*: nombre d'année après l'année spécifiée par $year disponible dans le calendrier

== API templates/OVML ==
===bab_printTemplate()===

Retourne le template HTML fusionné avec les variables de l'objet passé en paramètre. Pour plus d'informations, voir un [[Exemple d'utilisation de la fonction bab printTemplate()]]

:'''function bab_printTemplate( &$class, $file, $section="")'''

* '''&$class''' :
*: Objet contenant les variables et les méthodes utilisées lors de la fusion avec le template
* '''$file''' :
*: Emplacement du fichier de template
* '''$section''':
*: Ce paramètre est optionnel, il permet de spécifier le nom du template a utiliser, si celui-ci n'est pas précisé, tout le fichier sera utilisé comme un template.

===bab_toHtml()===

Retourne la chaîne de caractères encodée pour être utilisée en HTML dans un template par exemple

:'''function bab_toHtml($str, $option = BAB_HTML_ENTITIES)'''

* '''$str''' :
*: chaîne de caractères
* '''$option''' :
*:BAB_HTML_ALL : Une combinaison des options
*:BAB_HTML_ENTITIES : Protéger les caractères pour l'affichage html
*:BAB_HTML_AUTO : Créer des paragraphes uniquement si le texte contiens des retours à la ligne
*:BAB_HTML_P : Les doubles retours à la lignes serons transformés en paragraphes
*:BAB_HTML_BR : Les retours à la ligne serons remplacés par des retours à la ligne HTML
*:BAB_HTML_LINKS : les url et les adresses email serons remplacées par des liens cliquables
*:BAB_HTML_JS : encode les caractères spéciaux pour créer une chaîne de caractères javascript
*:BAB_HTML_REPLACE : Transforme les macro $XXX() d'Ovidentia

remarque : pour du texte saisi par l'éditeur WYSIWYG il n'est pas nécessaire d'utiliser cette fonction, l'API permet de récupérer le texte déjà transformé en HTML : [[API editeur]]

===bab_printOvmlTemplate()===

Retourne le contenu du fichier ovml traité par le parser.

:'''function bab_printOvmlTemplate($file, $args=array())'''

* '''$file''' :
*: Emplacement du fichier OVML
* '''$args''':
*: Ce paramètre est optionnel, il permet de spécifier des variables et leurs valeurs qui pourrons être utilisées dans le fichier OVML, par exemple $_GET.

===bab_abbr()===

Retourne une version abrégée de la chaîne passée en paramètre

:'''function bab_abbr($text, $type, $max_length)'''

* '''$text''' :
*: Chaîne de caractère
* '''$type''' :
*: BAB_ABBR_FULL_WORDS : le texte est tronqué si la chaine est trop longue mais sans couper les mots
*: BAB_ABBR_INITIAL : La plremière lettre de chaque mot en majuscule avec un point après la lettre (initiales)
* '''$max_length''' :
*: Longueur maximale de la chaine en nombre de caractères

== API fichiers / Répertoires ==
===bab_getFileMimeType()===

Retourne le type mime d'un fichier

:'''function bab_getFileMimeType($file)'''

* '''$file''' :
*: Chemin complet (sur le système) vers le fichier

===bab_getFileContentDisposition()===

Retourne une information de préférence de l'administrateur du système concernant le header HTTP "content-disposition" préconisé lors d'un téléchargement de fichier utilisant un script PHP.

:'''function bab_getFileContentDisposition()'''

===bab_mkdir()===

Création d'un répertoire. La fonction retourne true en cas de succès et false en cas d'échec.

:'''function bab_mkdir($path, $mode='')'''

* '''$path''' :
*: Chemin complet (sur le système) vers le répertoire à créer
* '''$mode''' :
*: Paramètre optionnel, les droits d'accès en octale par exemple 0777

== API Annuaires ==

Voir l'article : [[API des utilisateurs et des annuaires#Les fiches d'annuaires]]

== API Groupes ==

Voir l'article : [[API des groupes]]

== API Debug ==
===bab_debug()===

Afficher une information dans la console de debug. Pour activer la console de debug, il faut placer un cookie sur le poste client, en ajoutant debug=1 dans n'importe quelle page d'ovidentia, le cookie sera enregistré avec la sévérité 1. Pour que la console s'affiche, il faut aussi être administrateur. Si un fichier bab_debug.txt existe à la racine du site, les informations serons loggées dans ce fichier sans contraintes de droits d'accès.

:'''function bab_debug($data, $severity = DBG_TRACE)'''

* '''$data''' :
*: Information a afficher dans la console, $data peut être une chaîne de caractères, un tableau ou un objet
* '''$severity''' :
*: Niveau de sévérité du message

===bab_getDebug()===

Cette fonction retourne la console de debug au format HTML, ceci permet d'utiliser le debug dans des popups ou la console n'est pas disponible par défaut.

:'''function bab_getDebug()'''

== API Registry ==
===bab_getRegistryInstance()===

retourne une instance de l'objet bab_registry. Plus d'informations sont disponibles dans documentation : [[Base de registre]]

:'''function bab_getRegistryInstance()'''

== API GET/POST ==
===bab_rp()===

Retourne une variable de la requête http, la valeur par défaut sera utilisée si le nom de la variable ne peut pas être trouvé dans la liste des variables soumises au script.

bab_rp recherche l'information dans $_GET et $_POST

:'''function bab_rp($name, $default = "")'''

* '''$name'''
*: Nom de la variable
* '''$default'''
*: Valeur par défaut

===bab_pp()===

Retourne une variable de la requête http, la valeur par défaut sera utilisée si le nom de la variable ne peut pas être trouvé dans la liste des variables soumises au script.

bab_pp recherche l'information dans $_POST

:'''function bab_pp($name, $default = "")'''

* '''$name'''
*: Nom de la variable
* '''$default'''
*: Valeur par défaut

===bab_gp()===

Retourne une variable de la requête http, la valeur par défaut sera utilisée si le nom de la variable ne peut pas être trouvé dans la liste des variables soumises au script.

bab_gp recherche l'information dans $_GET

:'''function bab_gp($name, $default = "")'''

* '''$name'''
*: Nom de la variable
* '''$default'''
*: Valeur par défaut

== API Divers ==

===bab_getAddonInfosInstance()===

:'''function bab_getAddonInfosInstance($addon_name)'''
* '''$addon_name''' :
*: nom du module

retourne un objet bab_addonInfos correspondant au nom du module passé en paramètre.
Pour plus de détails, consulter la documentation de l'[[API de gestion d'un module]]

===bab_locale()===

Initialise les informations de localisation en fonction des paramètres de l'utilisateur. Ceci permet de faire de la traduction en utilisant [http://fr.php.net/gettext gettext].

La fonction effectue un appel à [http://fr.php.net/setlocale setlocale] avec en paramètre LC_ALL et la chaine correspondante aux options de langue choisie par l'utilisateur ou l'administrateur.

La fonction retourne false en cas d'erreur ou la chaine de la locale si la valeur a bien été définie. Par exemple la valeur retournée pourra être "fr" ou "fr_FR" ou "fr_FR.utf8" ...

:'''function bab_locale()'''

===bab_getActiveSessions()===

Retourne un tableau avec les sessions en cours sur l'installation d'Ovidentia. Pour chaque session, les clefs suivantes sont disponibles :

* id_user
* user_name
* user_email
* session_id
* remote_addr
* forwarded_for
* registration_date
* previous_login_date
* login_date
* last_hit_date

:'''function bab_getActiveSessions()'''

== API Authentification ==
===bab_requireCredential()===

L'appel à cette fonction force l'affichage du formulaire d'authentification d'Ovidentia. Après renseignement de l'identifiant et du mot de passe, l'utilisateur est automatiquement redirigé vers la page d'origine où bab_requireCredential() a été appelée.

Exemple d'utilisation : l'utilisateur courant se situe sur une page restreinte par des droits d'accès. On a vérifié que l'utilisateur courant n'avait pas les droits nécessaires : on cherche donc à l'amener sur le formulaire d'authentification.

Cette fonction peut s'avérer très utile dans le cas d'urls externes. Par exemple : un utilisateur reçoit un e-mail contenant une adresse url vers le portail Ovidentia. Si bab_requireCredential() a été utilisé, l'utilisateur sera redirigé vers le formulaire d'authentification s'il n'avait pas les droits nécessaires.

'''function bab_requireCredential($message)'''

* '''$message'''
*: Message d'erreurs qui sera affiché avec le formulaire d'authentification

===bab_requireAccess===

L'appel à cette fonction force l'affichage du formulaire d'authentification d'Ovidentia. Après renseignement de l'identifiant et du mot de passe, l'utilisateur est automatiquement redirigé vers la page d'origine où bab_requireAccess() a été appelée.

Cette fonction est quasi-similaire à bab_requireCredential(). Elle contient cependant 2 paramètres supplémentaires permettant de faciliter son utilisation avec des droits ACL (tables *_groups).

'''function bab_requireAccess($tables, $idObject, $loginMessage)'''

* '''$tables'''
*: nom de la table ACL ou tableau contenant les noms des tables ACL à tester. Attention : la redirection vers le formulaire d'authentification sera effectuée si l'utilisateur n'a pas accès dans l'un des droits d'accès (OU).
* '''$idObject'''
*: Identifiant de l'objet à tester avec les tables ACL
* '''$loginMessage'''
*: Message d'erreurs qui sera affiché avec le formulaire d'authentification

Structures des tables de données d'Ovidentia

2009-09-08T09:36:51Z

Jeraiz : /* Table bab_topics */

Cet article est en cours de rédaction. Son contenu n'est pas exhaustif.

== Agenda ==

=== Table bab_calendar ===
contient les agendas (les noms des agendas ne se trouvent pas dans cette table). La table est liée aux tables bab_cal_public, bab_cal_resources ou bab_cal_events (il n'y a pas de tables pour les agendas personnels)
* id : identifiant d'un agenda
* owner : correspond pour un agenda de ressources à l'identifiant de l'enregistrement dans la table bab_cal_resources
* type : type de l'agenda.
Agenda : 1
Agenda : 2
Agenda de ressources : 3

=== Table bab_cal_categories ===
contient les catégories d'événements
* id : identifiant de la catégorie
* name : nom de la catégorie
* description : description de la catégorie
* bgcolor : couleur héxa de la catégorie (ex : CC0000)

=== Table bab_cal_events ===
contient les événements des agendas (tous types d'agendas confondus). Cette table ne permet pas de savoir dans quels agendas sont publiés les événements car un événement peut faire partie de pluieurs agendas : voir table bab_cal_events_owners.
* id : identifiant de l'événement
* title : titre de l'événement
* description : description de l'événement
* description_format : format du texte de la description : html...
* location : lieu de l'événement
* start_date : date et heure de début de l'événement
* end_date : date et heure de fin de l'événement
* id_cat : identifiant de la catégorie d'événement
* id_creator : identifiant de l'auteur de l'événement
* hash : rempli uniquement lorsque l'événement est répétitif (ex : R_4697c6374e306b988eff36a868ff6f2c)
* color : couleur de l'événement (ex : FF0033)
* bprivate : indique si l'événement est privé. Valeur possible : Y ou N
* block : indique si l'événement est verrouillé. Valeur possible : Y ou N
* bfree : indique si l'événement est libre. Valeur possible : Y ou N
* date_modification : date de dernière modification de l'événement
* id_modifiedby : identifiant du dernier auteur modificateur
* uuid : identifiant unique de l'événement (utilisé pour des outils de synchronisation externe)

=== Table bab_cal_events_notes ===
contient les notes privées associées aux événements d'agendas par les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur
* note : contenu de la note

=== Table bab_cal_events_owners ===
lie les événements d'agendas (bab_cal_events) avec les agendas (bab_calendars)
* id_event : identifiant de l'événement
* id_cal : identifiant de l'agenda

=== Table bab_cal_events_reminders ===
contient les rappels d'événements pour les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur qui veut le rappel
* day : nombre de jours avant l'événement quand le rappel doit se déclencher
* hour : nombre d'heures avant l'événement quand le rappel doit se déclencher
* minute : nombre de minutes avant l'événement quand le rappel doit se déclencher
* bemail : vaut Y si les rappels doivent être envoyés par e-mails (voir options dans config.php), sinon N
* processed : vaut Y si l'utilisateur a demandé à cacher le rappel de sa fenêtre, sinon N par défaut

=== Table bab_cal_public ===
contient les agendas collectifs
* id : identifiant de l'agenda
* name : nom de l'agenda
* description : description de l'agenda
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation

=== Table bab_cal_resources ===
contient les agendas de ressources
* id : identifiant de l'agenda
* name : nom de l'agenda
* description :
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation
* availability_lock : vaut 1 si on veut empêcher la création d'événements en surbooking, sinon 0.

=== Table bab_cal_user_options ===
contient les options privés des utilisateurs sur l'ensemble des agendas

== Articles ==

=== Table bab_articles ===
contient les articles
* id : identifiant de l'article
* id_topic : identifiant du thème d'articles où se situe l'article
* id_author : identifiant de l'auteur de l'article
* date : date de création de l'article
* date_publication : date de publication de l'article
* date_archiving : date d'archivage de l'article
* date_modification : date de dernière modification de l'article
* title : titre de l'article
* head : introduction de l'article (obligatoire)
* head_format : format du texte de la description : html...
* body : corps de l'article
* body_format : format du texte de la description : html...
* archive : indique si l'article est une archive. Valeurs possibles : N ou Y
* lang : langue de l'article (fr, en...)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* ordering : entier indiquant l'ordre d'affichage de l'article dans le thème par rapport aux autres articles du thème
* id_modifiedby : identifiant du dernier auteur modificateur
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3

=== Table bab_articles_images ===
contient les images associées aux articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts ===
contient les brouillons d'articles (Rappel : avant d'être soumis ou approuvés, les textes sont des brouillons. Les brouillons se transforment en articles dès qu'ils sont soumis et approuvés)
* id : identifiant du brouillon
* id_author : identifiant de l'auteur du brouillon
* date_creation : date de création du brouillon
* date_modification : date de dernière modification du brouillon
* date_submission : date de soumission du brouillon
* date_publication : date de publication du brouillon
* date_archiving : date d'archivage du brouillon
* title : titre du brouillon
* head : introduction du brouillon (obligatoire)
* head_format : format du texte de la description : html...
* body : corps du brouillon
* head_format : format du texte de la description : html...
* lang : langue du brouillon (fr, en...)
* trash : indique si le brouillon est dans la corbeille ou pas. Valeurs possibles : N ou Y
* id_topic : identifiant du thème d'articles où se trouve le brouillon (peut être vide)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* hpage_private : vaut Y si l'article est proposé pour les pages d'accueil privées
* hpage_public : vaut Y si l'article est proposé pour les pages d'accueil publiques
* notify_members : vaut Y l'option 'notifier les lecteurs' est cochée
* idfai : identifiant de l'instance en cours du schéma d'approbation
* result : statut d'approbation (type entier). Valeurs possibles : 0, 1, 2, 3
0 : statut par défaut si pas d'approbation en cours
1 : l'article brouillon est en attente d'approbation
2 : l'article brouillon est approuvé (Remarque : ce statut n'est jamais utilisé car un article brouillon approuvé se transforme en article)
3 : l'article brouillon a été refusé
* id_article : identifiant de l'article si le brouillon est une modification d'un article existant
* id_anonymous : identifiant de l'auteur si l'auteur n'est pas authentifié. C'est l'identifiant d'un enregistrement dans la table BAB_USERS_LOG_TBL.
* approbation : vaut 0, 1 ou 2
* update_datemodif : vaut Y si

=== Table bab_art_drafts_files ===
contient les fichiers joints aux brouillons d'articles
* id :
* id_draft : identifiant de l'article brouillon
* name : nom du fichier (Ex : gaston.jpg)
* description : description du fichier
* ordering : entier indiquant l'ordre d'affichage du fichier par rapport aux autres fichiers joints de l'article brouillon

=== Table bab_art_drafts_images ===
contient les images associées aux brouillons d'articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts_notes ===
contient les commentaires des approbateurs qui ont refusés les articles brouillons (Pour le publicateur, les commentaires sont affichées en prévisualisation de l'article, depuis la liste des brouillons (lien Publication/onglet Mes Articles si l'article est en cours d'approbation))
* id : identifiant de la note
* id_draft : identifiant de l'article brouillon associé
* content : contenu texte de la note
* id_author : identifiant de l'auteur de la note
* date_note : date de création de la note

=== Table bab_art_drafts_tags ===
contient les tags (fonction Thésaurus) associés à des articles brouillons
* id_draft : identifiant de l'article brouillon
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_art_files ===
contient les fichiers joints des articles
* id : identifiant du fichier joint à l'article
* id_article : identifiant de l'article
* name :
* description : description du fichier joint
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3
* ordering : entier indiquant l'ordre d'affichage du fichier joint avec les autres fichiers joints d'un même article

=== Table bab_art_log ===
contient l'historique des modifications d'articles
* id : identifiant de la modification
* id_article : identifiant de l'article
* id_author : identifiant de l'auteur de la modification
* date_log : date et heure de la modification
* action_log : statut de la modification. Valeurs possibles : lock, unlock, commit, refused, accepted.
Lorsqu'on saisit la raison de la modification avant de modifier un article, le statut est lock.
Lorsqu'on soumet un article, le statut est commit. Si l'article ne passe pas par approbation, il y a immédiatement un autre enregistrement avec le statut accepted. commit et accepted sont aussi utilisés lorsqu'on modifie un brouillon puis qu'on soumet.
Lorsqu'on modifie un article et qu'on l'enregistre (on ne le soumet pas), seul un enregistrement est créé : celui avec le statut lock et la raison de la modification.
Il n'y a pas d'enregistrements si on créé un article et qu'il ne doit pas être approuvé.
Lorsqu'on supprime un brouillon, le statut est unlock.
* art_log : description de la modification. Contient le texte saisit comme raison de la modification

=== Table bab_art_tags ===
contient les tags (fonction Thésaurus) associés à des articles
* id_art : identifiant de l'article
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_comments ===
contient les commentaires des articles
* id : identifiant du commentaire
* id_parent : identifiant du commentaire parent
* id_article : identifiant de l'article associé au commentaire
* id_topic : identifiant du thème d'articles dans lequel est créé l'article
* id_author : auteur du commentaire
* id_last_editor : identifiant du dernier auteur modificateur
* date : date de création du commentaire
* last_update : date de la dernière modification du commentaire
* subject : titre du commentaire
* message : contenu texte du commentaire
* confirmed : Y si le commentaire est approuvé, N sinon
* name : nom de l'auteur du commentaire
* email : email de l'auteur du commentaire
* idfai : identifiant de l'instance du schéma d'approbation utilisé pour ce commentaire
* lang : langue du commentaire (fr, en...)
* article_rating : note attribuée à l'article. Valeurs possibles : 0, 1, 2, 3, 4, 5
0 : l'article n'est pas noté

=== Table bab_topcat_order ===
contient les numéros pour les tris d'affichage des catégories et des thèmes. Attention, sous une catégorie parente, il est possible d'ordonner les sous-catégories avec les sous-thèmes (il y a donc des mélanges d'où la colonne type).
Rappel : une catégorie est un conteneur de sous-catégories ou de thèmes.
* id : identifiant de l'ordre
* id_topcat : identifiant de la catégorie ou du thème que l'on veut ordonner
* type : 1 si l'ordre est définit pour une catégorie d'articles. 2 si l'ordre est défini pour un thème d'articles.
* ordering : entier indiquant l'ordre d'affichage de l'objet par rapport aux autres objets de la catégorie parente (id_parent)
* id_parent : identifiant de la catégorie d'articles parente d'idtopcat. C'est la catégorie dans laquelle on veut ordonner notre objet. Vaut 0 si l'objet qu'on veut trier est une catégorie de premier niveau (pas de catégorie parente).

=== Table bab_topics ===
contient les thèmes d'articles
* id : identifiant du thème
* category : nom du thème
* description : description du thème
* description_format : format du texte de la description : html...
* id_cat : identifiant de la catégorie dans laquelle se trouve le thème
* idsaart : identifiant du schéma d'approbation à la création d'articles
* idsacom : identifiant du schéma d'approbation des commentaires
* idsa_update : identifiant du schéma d'approbation à la modification des articles
* notify : Y si les auteurs peuvent notifier les lecteurs par email, N sinon
* lang : langue du thème (fr, en...)
* article_tmpl : nom du modèle d'articles
* display_tmpl : nom du patron d'affichage
* restrict_access : Y si les auteurs peuvent restreindre l'accès aux articles, N sinon
* allow_hpages : Y si on permet aux auteurs de proposer leurs articles pour les pages d'accueil, N sinon
* allow_pubdates : Y si on permet aux auteurs de spécifier des dates de publication, N sinon
* allow_attachments : Y si on permet aux auteurs de joindre des fichiers avec leurs articles, N sinon
* allow_update : entier indiquant si les auteurs peuvent modifier leurs articles. Valeurs possibles : 0, 1, 2
0 : les auteurs ne peuvent pas modifier leurs articles
1 : les auteurs peuvent modifier leurs articles, mais avec approbation
2 : les auteurs peuvent modifier leurs articles et sans approbation
* max_articles : nombre maximum d'articles sur la page des archives
* allow_manupdate : entier indiquant si les gestionnaires peuvent modifier les articles. Valeurs possibles : 0, 1, 2
0 : les gestionnaires ne peuvent pas modifier les articles
1 : les gestionnaires peuvent modifier les articles, mais avec approbation
2 : les gestionnaires peuvent modifier les articles et sans approbation
* auto_approbation : Y si on approuve automatiquement le contributeur dans le cas où il fait partie de la première étape du schéma d'approbation, N sinon
* busetags : Y si on utilise les mots-clés du thésaurus, N sinon
* allow_addImg : Y si on permet aux auteurs d'associer une image à un article
* allow_article_rating : Y si on permet aux auteurs des commentaires de noter les articles, N sinon

=== Table bab_topicscom_groups ===
Table de droits d'accès : groupes pouvant faire des commentaires sur le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsman_groups ===
Table de droits d'accès : groupes gestionnaires du thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsmod_groups ===
Table de droits d'accès : groupes pouvant modifier des articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicssub_groups ===
Table de droits d'accès : groupes pouvant soumettre de nouveaux articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsview_groups ===
Table de droist d'accès : groupes pouvant voir les articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topics_categories ===
contient les catégories d'articles (conteneurs des thèmes d'articles)
* id : identifiant de la catégorie
* title : titre de la catégorie
* description : description de la catégorie
* enabled : vaut Y si la section de la catégorie est activée, N sinon
* template : nom du patron de section
* id_dgowner : identifiant de la délégation où se trouve la catégorie, 0 si dans tout le site
* optional : utilisation inconnue !!!
* id_parent : identifiant de la catégorie parente
* display_tmpl : nom du patron d'affichage

=== Table bab_topics_categories_images ===
contient les images associées aux catégories d'articles
* id : identifiant de l'image
* idCategory : identifiant de la catégorie d'articles
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_topics_images ===
contient les images associées aux thèmes d'articles
* id : identifiant de l'image
* idTopic : identifiant du thème
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

Structures des tables de données d'Ovidentia

2009-09-08T09:36:29Z

Jeraiz : /* Table bab_art_drafts */

Cet article est en cours de rédaction. Son contenu n'est pas exhaustif.

== Agenda ==

=== Table bab_calendar ===
contient les agendas (les noms des agendas ne se trouvent pas dans cette table). La table est liée aux tables bab_cal_public, bab_cal_resources ou bab_cal_events (il n'y a pas de tables pour les agendas personnels)
* id : identifiant d'un agenda
* owner : correspond pour un agenda de ressources à l'identifiant de l'enregistrement dans la table bab_cal_resources
* type : type de l'agenda.
Agenda : 1
Agenda : 2
Agenda de ressources : 3

=== Table bab_cal_categories ===
contient les catégories d'événements
* id : identifiant de la catégorie
* name : nom de la catégorie
* description : description de la catégorie
* bgcolor : couleur héxa de la catégorie (ex : CC0000)

=== Table bab_cal_events ===
contient les événements des agendas (tous types d'agendas confondus). Cette table ne permet pas de savoir dans quels agendas sont publiés les événements car un événement peut faire partie de pluieurs agendas : voir table bab_cal_events_owners.
* id : identifiant de l'événement
* title : titre de l'événement
* description : description de l'événement
* description_format : format du texte de la description : html...
* location : lieu de l'événement
* start_date : date et heure de début de l'événement
* end_date : date et heure de fin de l'événement
* id_cat : identifiant de la catégorie d'événement
* id_creator : identifiant de l'auteur de l'événement
* hash : rempli uniquement lorsque l'événement est répétitif (ex : R_4697c6374e306b988eff36a868ff6f2c)
* color : couleur de l'événement (ex : FF0033)
* bprivate : indique si l'événement est privé. Valeur possible : Y ou N
* block : indique si l'événement est verrouillé. Valeur possible : Y ou N
* bfree : indique si l'événement est libre. Valeur possible : Y ou N
* date_modification : date de dernière modification de l'événement
* id_modifiedby : identifiant du dernier auteur modificateur
* uuid : identifiant unique de l'événement (utilisé pour des outils de synchronisation externe)

=== Table bab_cal_events_notes ===
contient les notes privées associées aux événements d'agendas par les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur
* note : contenu de la note

=== Table bab_cal_events_owners ===
lie les événements d'agendas (bab_cal_events) avec les agendas (bab_calendars)
* id_event : identifiant de l'événement
* id_cal : identifiant de l'agenda

=== Table bab_cal_events_reminders ===
contient les rappels d'événements pour les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur qui veut le rappel
* day : nombre de jours avant l'événement quand le rappel doit se déclencher
* hour : nombre d'heures avant l'événement quand le rappel doit se déclencher
* minute : nombre de minutes avant l'événement quand le rappel doit se déclencher
* bemail : vaut Y si les rappels doivent être envoyés par e-mails (voir options dans config.php), sinon N
* processed : vaut Y si l'utilisateur a demandé à cacher le rappel de sa fenêtre, sinon N par défaut

=== Table bab_cal_public ===
contient les agendas collectifs
* id : identifiant de l'agenda
* name : nom de l'agenda
* description : description de l'agenda
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation

=== Table bab_cal_resources ===
contient les agendas de ressources
* id : identifiant de l'agenda
* name : nom de l'agenda
* description :
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation
* availability_lock : vaut 1 si on veut empêcher la création d'événements en surbooking, sinon 0.

=== Table bab_cal_user_options ===
contient les options privés des utilisateurs sur l'ensemble des agendas

== Articles ==

=== Table bab_articles ===
contient les articles
* id : identifiant de l'article
* id_topic : identifiant du thème d'articles où se situe l'article
* id_author : identifiant de l'auteur de l'article
* date : date de création de l'article
* date_publication : date de publication de l'article
* date_archiving : date d'archivage de l'article
* date_modification : date de dernière modification de l'article
* title : titre de l'article
* head : introduction de l'article (obligatoire)
* head_format : format du texte de la description : html...
* body : corps de l'article
* body_format : format du texte de la description : html...
* archive : indique si l'article est une archive. Valeurs possibles : N ou Y
* lang : langue de l'article (fr, en...)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* ordering : entier indiquant l'ordre d'affichage de l'article dans le thème par rapport aux autres articles du thème
* id_modifiedby : identifiant du dernier auteur modificateur
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3

=== Table bab_articles_images ===
contient les images associées aux articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts ===
contient les brouillons d'articles (Rappel : avant d'être soumis ou approuvés, les textes sont des brouillons. Les brouillons se transforment en articles dès qu'ils sont soumis et approuvés)
* id : identifiant du brouillon
* id_author : identifiant de l'auteur du brouillon
* date_creation : date de création du brouillon
* date_modification : date de dernière modification du brouillon
* date_submission : date de soumission du brouillon
* date_publication : date de publication du brouillon
* date_archiving : date d'archivage du brouillon
* title : titre du brouillon
* head : introduction du brouillon (obligatoire)
* head_format : format du texte de la description : html...
* body : corps du brouillon
* head_format : format du texte de la description : html...
* lang : langue du brouillon (fr, en...)
* trash : indique si le brouillon est dans la corbeille ou pas. Valeurs possibles : N ou Y
* id_topic : identifiant du thème d'articles où se trouve le brouillon (peut être vide)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* hpage_private : vaut Y si l'article est proposé pour les pages d'accueil privées
* hpage_public : vaut Y si l'article est proposé pour les pages d'accueil publiques
* notify_members : vaut Y l'option 'notifier les lecteurs' est cochée
* idfai : identifiant de l'instance en cours du schéma d'approbation
* result : statut d'approbation (type entier). Valeurs possibles : 0, 1, 2, 3
0 : statut par défaut si pas d'approbation en cours
1 : l'article brouillon est en attente d'approbation
2 : l'article brouillon est approuvé (Remarque : ce statut n'est jamais utilisé car un article brouillon approuvé se transforme en article)
3 : l'article brouillon a été refusé
* id_article : identifiant de l'article si le brouillon est une modification d'un article existant
* id_anonymous : identifiant de l'auteur si l'auteur n'est pas authentifié. C'est l'identifiant d'un enregistrement dans la table BAB_USERS_LOG_TBL.
* approbation : vaut 0, 1 ou 2
* update_datemodif : vaut Y si

=== Table bab_art_drafts_files ===
contient les fichiers joints aux brouillons d'articles
* id :
* id_draft : identifiant de l'article brouillon
* name : nom du fichier (Ex : gaston.jpg)
* description : description du fichier
* ordering : entier indiquant l'ordre d'affichage du fichier par rapport aux autres fichiers joints de l'article brouillon

=== Table bab_art_drafts_images ===
contient les images associées aux brouillons d'articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts_notes ===
contient les commentaires des approbateurs qui ont refusés les articles brouillons (Pour le publicateur, les commentaires sont affichées en prévisualisation de l'article, depuis la liste des brouillons (lien Publication/onglet Mes Articles si l'article est en cours d'approbation))
* id : identifiant de la note
* id_draft : identifiant de l'article brouillon associé
* content : contenu texte de la note
* id_author : identifiant de l'auteur de la note
* date_note : date de création de la note

=== Table bab_art_drafts_tags ===
contient les tags (fonction Thésaurus) associés à des articles brouillons
* id_draft : identifiant de l'article brouillon
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_art_files ===
contient les fichiers joints des articles
* id : identifiant du fichier joint à l'article
* id_article : identifiant de l'article
* name :
* description : description du fichier joint
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3
* ordering : entier indiquant l'ordre d'affichage du fichier joint avec les autres fichiers joints d'un même article

=== Table bab_art_log ===
contient l'historique des modifications d'articles
* id : identifiant de la modification
* id_article : identifiant de l'article
* id_author : identifiant de l'auteur de la modification
* date_log : date et heure de la modification
* action_log : statut de la modification. Valeurs possibles : lock, unlock, commit, refused, accepted.
Lorsqu'on saisit la raison de la modification avant de modifier un article, le statut est lock.
Lorsqu'on soumet un article, le statut est commit. Si l'article ne passe pas par approbation, il y a immédiatement un autre enregistrement avec le statut accepted. commit et accepted sont aussi utilisés lorsqu'on modifie un brouillon puis qu'on soumet.
Lorsqu'on modifie un article et qu'on l'enregistre (on ne le soumet pas), seul un enregistrement est créé : celui avec le statut lock et la raison de la modification.
Il n'y a pas d'enregistrements si on créé un article et qu'il ne doit pas être approuvé.
Lorsqu'on supprime un brouillon, le statut est unlock.
* art_log : description de la modification. Contient le texte saisit comme raison de la modification

=== Table bab_art_tags ===
contient les tags (fonction Thésaurus) associés à des articles
* id_art : identifiant de l'article
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_comments ===
contient les commentaires des articles
* id : identifiant du commentaire
* id_parent : identifiant du commentaire parent
* id_article : identifiant de l'article associé au commentaire
* id_topic : identifiant du thème d'articles dans lequel est créé l'article
* id_author : auteur du commentaire
* id_last_editor : identifiant du dernier auteur modificateur
* date : date de création du commentaire
* last_update : date de la dernière modification du commentaire
* subject : titre du commentaire
* message : contenu texte du commentaire
* confirmed : Y si le commentaire est approuvé, N sinon
* name : nom de l'auteur du commentaire
* email : email de l'auteur du commentaire
* idfai : identifiant de l'instance du schéma d'approbation utilisé pour ce commentaire
* lang : langue du commentaire (fr, en...)
* article_rating : note attribuée à l'article. Valeurs possibles : 0, 1, 2, 3, 4, 5
0 : l'article n'est pas noté

=== Table bab_topcat_order ===
contient les numéros pour les tris d'affichage des catégories et des thèmes. Attention, sous une catégorie parente, il est possible d'ordonner les sous-catégories avec les sous-thèmes (il y a donc des mélanges d'où la colonne type).
Rappel : une catégorie est un conteneur de sous-catégories ou de thèmes.
* id : identifiant de l'ordre
* id_topcat : identifiant de la catégorie ou du thème que l'on veut ordonner
* type : 1 si l'ordre est définit pour une catégorie d'articles. 2 si l'ordre est défini pour un thème d'articles.
* ordering : entier indiquant l'ordre d'affichage de l'objet par rapport aux autres objets de la catégorie parente (id_parent)
* id_parent : identifiant de la catégorie d'articles parente d'idtopcat. C'est la catégorie dans laquelle on veut ordonner notre objet. Vaut 0 si l'objet qu'on veut trier est une catégorie de premier niveau (pas de catégorie parente).

=== Table bab_topics ===
contient les thèmes d'articles
* id : identifiant du thème
* category : nom du thème
* description : description du thème
* id_cat : identifiant de la catégorie dans laquelle se trouve le thème
* idsaart : identifiant du schéma d'approbation à la création d'articles
* idsacom : identifiant du schéma d'approbation des commentaires
* idsa_update : identifiant du schéma d'approbation à la modification des articles
* notify : Y si les auteurs peuvent notifier les lecteurs par email, N sinon
* lang : langue du thème (fr, en...)
* article_tmpl : nom du modèle d'articles
* display_tmpl : nom du patron d'affichage
* restrict_access : Y si les auteurs peuvent restreindre l'accès aux articles, N sinon
* allow_hpages : Y si on permet aux auteurs de proposer leurs articles pour les pages d'accueil, N sinon
* allow_pubdates : Y si on permet aux auteurs de spécifier des dates de publication, N sinon
* allow_attachments : Y si on permet aux auteurs de joindre des fichiers avec leurs articles, N sinon
* allow_update : entier indiquant si les auteurs peuvent modifier leurs articles. Valeurs possibles : 0, 1, 2
0 : les auteurs ne peuvent pas modifier leurs articles
1 : les auteurs peuvent modifier leurs articles, mais avec approbation
2 : les auteurs peuvent modifier leurs articles et sans approbation
* max_articles : nombre maximum d'articles sur la page des archives
* allow_manupdate : entier indiquant si les gestionnaires peuvent modifier les articles. Valeurs possibles : 0, 1, 2
0 : les gestionnaires ne peuvent pas modifier les articles
1 : les gestionnaires peuvent modifier les articles, mais avec approbation
2 : les gestionnaires peuvent modifier les articles et sans approbation
* auto_approbation : Y si on approuve automatiquement le contributeur dans le cas où il fait partie de la première étape du schéma d'approbation, N sinon
* busetags : Y si on utilise les mots-clés du thésaurus, N sinon
* allow_addImg : Y si on permet aux auteurs d'associer une image à un article
* allow_article_rating : Y si on permet aux auteurs des commentaires de noter les articles, N sinon

=== Table bab_topicscom_groups ===
Table de droits d'accès : groupes pouvant faire des commentaires sur le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsman_groups ===
Table de droits d'accès : groupes gestionnaires du thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsmod_groups ===
Table de droits d'accès : groupes pouvant modifier des articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicssub_groups ===
Table de droits d'accès : groupes pouvant soumettre de nouveaux articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsview_groups ===
Table de droist d'accès : groupes pouvant voir les articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topics_categories ===
contient les catégories d'articles (conteneurs des thèmes d'articles)
* id : identifiant de la catégorie
* title : titre de la catégorie
* description : description de la catégorie
* enabled : vaut Y si la section de la catégorie est activée, N sinon
* template : nom du patron de section
* id_dgowner : identifiant de la délégation où se trouve la catégorie, 0 si dans tout le site
* optional : utilisation inconnue !!!
* id_parent : identifiant de la catégorie parente
* display_tmpl : nom du patron d'affichage

=== Table bab_topics_categories_images ===
contient les images associées aux catégories d'articles
* id : identifiant de l'image
* idCategory : identifiant de la catégorie d'articles
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_topics_images ===
contient les images associées aux thèmes d'articles
* id : identifiant de l'image
* idTopic : identifiant du thème
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

Structures des tables de données d'Ovidentia

2009-09-08T09:35:55Z

Jeraiz : /* Table bab_articles */

Cet article est en cours de rédaction. Son contenu n'est pas exhaustif.

== Agenda ==

=== Table bab_calendar ===
contient les agendas (les noms des agendas ne se trouvent pas dans cette table). La table est liée aux tables bab_cal_public, bab_cal_resources ou bab_cal_events (il n'y a pas de tables pour les agendas personnels)
* id : identifiant d'un agenda
* owner : correspond pour un agenda de ressources à l'identifiant de l'enregistrement dans la table bab_cal_resources
* type : type de l'agenda.
Agenda : 1
Agenda : 2
Agenda de ressources : 3

=== Table bab_cal_categories ===
contient les catégories d'événements
* id : identifiant de la catégorie
* name : nom de la catégorie
* description : description de la catégorie
* bgcolor : couleur héxa de la catégorie (ex : CC0000)

=== Table bab_cal_events ===
contient les événements des agendas (tous types d'agendas confondus). Cette table ne permet pas de savoir dans quels agendas sont publiés les événements car un événement peut faire partie de pluieurs agendas : voir table bab_cal_events_owners.
* id : identifiant de l'événement
* title : titre de l'événement
* description : description de l'événement
* description_format : format du texte de la description : html...
* location : lieu de l'événement
* start_date : date et heure de début de l'événement
* end_date : date et heure de fin de l'événement
* id_cat : identifiant de la catégorie d'événement
* id_creator : identifiant de l'auteur de l'événement
* hash : rempli uniquement lorsque l'événement est répétitif (ex : R_4697c6374e306b988eff36a868ff6f2c)
* color : couleur de l'événement (ex : FF0033)
* bprivate : indique si l'événement est privé. Valeur possible : Y ou N
* block : indique si l'événement est verrouillé. Valeur possible : Y ou N
* bfree : indique si l'événement est libre. Valeur possible : Y ou N
* date_modification : date de dernière modification de l'événement
* id_modifiedby : identifiant du dernier auteur modificateur
* uuid : identifiant unique de l'événement (utilisé pour des outils de synchronisation externe)

=== Table bab_cal_events_notes ===
contient les notes privées associées aux événements d'agendas par les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur
* note : contenu de la note

=== Table bab_cal_events_owners ===
lie les événements d'agendas (bab_cal_events) avec les agendas (bab_calendars)
* id_event : identifiant de l'événement
* id_cal : identifiant de l'agenda

=== Table bab_cal_events_reminders ===
contient les rappels d'événements pour les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur qui veut le rappel
* day : nombre de jours avant l'événement quand le rappel doit se déclencher
* hour : nombre d'heures avant l'événement quand le rappel doit se déclencher
* minute : nombre de minutes avant l'événement quand le rappel doit se déclencher
* bemail : vaut Y si les rappels doivent être envoyés par e-mails (voir options dans config.php), sinon N
* processed : vaut Y si l'utilisateur a demandé à cacher le rappel de sa fenêtre, sinon N par défaut

=== Table bab_cal_public ===
contient les agendas collectifs
* id : identifiant de l'agenda
* name : nom de l'agenda
* description : description de l'agenda
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation

=== Table bab_cal_resources ===
contient les agendas de ressources
* id : identifiant de l'agenda
* name : nom de l'agenda
* description :
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation
* availability_lock : vaut 1 si on veut empêcher la création d'événements en surbooking, sinon 0.

=== Table bab_cal_user_options ===
contient les options privés des utilisateurs sur l'ensemble des agendas

== Articles ==

=== Table bab_articles ===
contient les articles
* id : identifiant de l'article
* id_topic : identifiant du thème d'articles où se situe l'article
* id_author : identifiant de l'auteur de l'article
* date : date de création de l'article
* date_publication : date de publication de l'article
* date_archiving : date d'archivage de l'article
* date_modification : date de dernière modification de l'article
* title : titre de l'article
* head : introduction de l'article (obligatoire)
* head_format : format du texte de la description : html...
* body : corps de l'article
* body_format : format du texte de la description : html...
* archive : indique si l'article est une archive. Valeurs possibles : N ou Y
* lang : langue de l'article (fr, en...)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* ordering : entier indiquant l'ordre d'affichage de l'article dans le thème par rapport aux autres articles du thème
* id_modifiedby : identifiant du dernier auteur modificateur
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3

=== Table bab_articles_images ===
contient les images associées aux articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts ===
contient les brouillons d'articles (Rappel : avant d'être soumis ou approuvés, les textes sont des brouillons. Les brouillons se transforment en articles dès qu'ils sont soumis et approuvés)
* id : identifiant du brouillon
* id_author : identifiant de l'auteur du brouillon
* date_creation : date de création du brouillon
* date_modification : date de dernière modification du brouillon
* date_submission : date de soumission du brouillon
* date_publication : date de publication du brouillon
* date_archiving : date d'archivage du brouillon
* title : titre du brouillon
* head : introduction du brouillon (obligatoire)
* body : corps du brouillon
* lang : langue du brouillon (fr, en...)
* trash : indique si le brouillon est dans la corbeille ou pas. Valeurs possibles : N ou Y
* id_topic : identifiant du thème d'articles où se trouve le brouillon (peut être vide)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* hpage_private : vaut Y si l'article est proposé pour les pages d'accueil privées
* hpage_public : vaut Y si l'article est proposé pour les pages d'accueil publiques
* notify_members : vaut Y l'option 'notifier les lecteurs' est cochée
* idfai : identifiant de l'instance en cours du schéma d'approbation
* result : statut d'approbation (type entier). Valeurs possibles : 0, 1, 2, 3
0 : statut par défaut si pas d'approbation en cours
1 : l'article brouillon est en attente d'approbation
2 : l'article brouillon est approuvé (Remarque : ce statut n'est jamais utilisé car un article brouillon approuvé se transforme en article)
3 : l'article brouillon a été refusé
* id_article : identifiant de l'article si le brouillon est une modification d'un article existant
* id_anonymous : identifiant de l'auteur si l'auteur n'est pas authentifié. C'est l'identifiant d'un enregistrement dans la table BAB_USERS_LOG_TBL.
* approbation : vaut 0, 1 ou 2
* update_datemodif : vaut Y si

=== Table bab_art_drafts_files ===
contient les fichiers joints aux brouillons d'articles
* id :
* id_draft : identifiant de l'article brouillon
* name : nom du fichier (Ex : gaston.jpg)
* description : description du fichier
* ordering : entier indiquant l'ordre d'affichage du fichier par rapport aux autres fichiers joints de l'article brouillon

=== Table bab_art_drafts_images ===
contient les images associées aux brouillons d'articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts_notes ===
contient les commentaires des approbateurs qui ont refusés les articles brouillons (Pour le publicateur, les commentaires sont affichées en prévisualisation de l'article, depuis la liste des brouillons (lien Publication/onglet Mes Articles si l'article est en cours d'approbation))
* id : identifiant de la note
* id_draft : identifiant de l'article brouillon associé
* content : contenu texte de la note
* id_author : identifiant de l'auteur de la note
* date_note : date de création de la note

=== Table bab_art_drafts_tags ===
contient les tags (fonction Thésaurus) associés à des articles brouillons
* id_draft : identifiant de l'article brouillon
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_art_files ===
contient les fichiers joints des articles
* id : identifiant du fichier joint à l'article
* id_article : identifiant de l'article
* name :
* description : description du fichier joint
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3
* ordering : entier indiquant l'ordre d'affichage du fichier joint avec les autres fichiers joints d'un même article

=== Table bab_art_log ===
contient l'historique des modifications d'articles
* id : identifiant de la modification
* id_article : identifiant de l'article
* id_author : identifiant de l'auteur de la modification
* date_log : date et heure de la modification
* action_log : statut de la modification. Valeurs possibles : lock, unlock, commit, refused, accepted.
Lorsqu'on saisit la raison de la modification avant de modifier un article, le statut est lock.
Lorsqu'on soumet un article, le statut est commit. Si l'article ne passe pas par approbation, il y a immédiatement un autre enregistrement avec le statut accepted. commit et accepted sont aussi utilisés lorsqu'on modifie un brouillon puis qu'on soumet.
Lorsqu'on modifie un article et qu'on l'enregistre (on ne le soumet pas), seul un enregistrement est créé : celui avec le statut lock et la raison de la modification.
Il n'y a pas d'enregistrements si on créé un article et qu'il ne doit pas être approuvé.
Lorsqu'on supprime un brouillon, le statut est unlock.
* art_log : description de la modification. Contient le texte saisit comme raison de la modification

=== Table bab_art_tags ===
contient les tags (fonction Thésaurus) associés à des articles
* id_art : identifiant de l'article
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_comments ===
contient les commentaires des articles
* id : identifiant du commentaire
* id_parent : identifiant du commentaire parent
* id_article : identifiant de l'article associé au commentaire
* id_topic : identifiant du thème d'articles dans lequel est créé l'article
* id_author : auteur du commentaire
* id_last_editor : identifiant du dernier auteur modificateur
* date : date de création du commentaire
* last_update : date de la dernière modification du commentaire
* subject : titre du commentaire
* message : contenu texte du commentaire
* confirmed : Y si le commentaire est approuvé, N sinon
* name : nom de l'auteur du commentaire
* email : email de l'auteur du commentaire
* idfai : identifiant de l'instance du schéma d'approbation utilisé pour ce commentaire
* lang : langue du commentaire (fr, en...)
* article_rating : note attribuée à l'article. Valeurs possibles : 0, 1, 2, 3, 4, 5
0 : l'article n'est pas noté

=== Table bab_topcat_order ===
contient les numéros pour les tris d'affichage des catégories et des thèmes. Attention, sous une catégorie parente, il est possible d'ordonner les sous-catégories avec les sous-thèmes (il y a donc des mélanges d'où la colonne type).
Rappel : une catégorie est un conteneur de sous-catégories ou de thèmes.
* id : identifiant de l'ordre
* id_topcat : identifiant de la catégorie ou du thème que l'on veut ordonner
* type : 1 si l'ordre est définit pour une catégorie d'articles. 2 si l'ordre est défini pour un thème d'articles.
* ordering : entier indiquant l'ordre d'affichage de l'objet par rapport aux autres objets de la catégorie parente (id_parent)
* id_parent : identifiant de la catégorie d'articles parente d'idtopcat. C'est la catégorie dans laquelle on veut ordonner notre objet. Vaut 0 si l'objet qu'on veut trier est une catégorie de premier niveau (pas de catégorie parente).

=== Table bab_topics ===
contient les thèmes d'articles
* id : identifiant du thème
* category : nom du thème
* description : description du thème
* id_cat : identifiant de la catégorie dans laquelle se trouve le thème
* idsaart : identifiant du schéma d'approbation à la création d'articles
* idsacom : identifiant du schéma d'approbation des commentaires
* idsa_update : identifiant du schéma d'approbation à la modification des articles
* notify : Y si les auteurs peuvent notifier les lecteurs par email, N sinon
* lang : langue du thème (fr, en...)
* article_tmpl : nom du modèle d'articles
* display_tmpl : nom du patron d'affichage
* restrict_access : Y si les auteurs peuvent restreindre l'accès aux articles, N sinon
* allow_hpages : Y si on permet aux auteurs de proposer leurs articles pour les pages d'accueil, N sinon
* allow_pubdates : Y si on permet aux auteurs de spécifier des dates de publication, N sinon
* allow_attachments : Y si on permet aux auteurs de joindre des fichiers avec leurs articles, N sinon
* allow_update : entier indiquant si les auteurs peuvent modifier leurs articles. Valeurs possibles : 0, 1, 2
0 : les auteurs ne peuvent pas modifier leurs articles
1 : les auteurs peuvent modifier leurs articles, mais avec approbation
2 : les auteurs peuvent modifier leurs articles et sans approbation
* max_articles : nombre maximum d'articles sur la page des archives
* allow_manupdate : entier indiquant si les gestionnaires peuvent modifier les articles. Valeurs possibles : 0, 1, 2
0 : les gestionnaires ne peuvent pas modifier les articles
1 : les gestionnaires peuvent modifier les articles, mais avec approbation
2 : les gestionnaires peuvent modifier les articles et sans approbation
* auto_approbation : Y si on approuve automatiquement le contributeur dans le cas où il fait partie de la première étape du schéma d'approbation, N sinon
* busetags : Y si on utilise les mots-clés du thésaurus, N sinon
* allow_addImg : Y si on permet aux auteurs d'associer une image à un article
* allow_article_rating : Y si on permet aux auteurs des commentaires de noter les articles, N sinon

=== Table bab_topicscom_groups ===
Table de droits d'accès : groupes pouvant faire des commentaires sur le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsman_groups ===
Table de droits d'accès : groupes gestionnaires du thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsmod_groups ===
Table de droits d'accès : groupes pouvant modifier des articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicssub_groups ===
Table de droits d'accès : groupes pouvant soumettre de nouveaux articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsview_groups ===
Table de droist d'accès : groupes pouvant voir les articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topics_categories ===
contient les catégories d'articles (conteneurs des thèmes d'articles)
* id : identifiant de la catégorie
* title : titre de la catégorie
* description : description de la catégorie
* enabled : vaut Y si la section de la catégorie est activée, N sinon
* template : nom du patron de section
* id_dgowner : identifiant de la délégation où se trouve la catégorie, 0 si dans tout le site
* optional : utilisation inconnue !!!
* id_parent : identifiant de la catégorie parente
* display_tmpl : nom du patron d'affichage

=== Table bab_topics_categories_images ===
contient les images associées aux catégories d'articles
* id : identifiant de l'image
* idCategory : identifiant de la catégorie d'articles
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_topics_images ===
contient les images associées aux thèmes d'articles
* id : identifiant de l'image
* idTopic : identifiant du thème
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

Structures des tables de données d'Ovidentia

2009-09-08T09:35:23Z

Jeraiz : /* Table bab_cal_events */

Cet article est en cours de rédaction. Son contenu n'est pas exhaustif.

== Agenda ==

=== Table bab_calendar ===
contient les agendas (les noms des agendas ne se trouvent pas dans cette table). La table est liée aux tables bab_cal_public, bab_cal_resources ou bab_cal_events (il n'y a pas de tables pour les agendas personnels)
* id : identifiant d'un agenda
* owner : correspond pour un agenda de ressources à l'identifiant de l'enregistrement dans la table bab_cal_resources
* type : type de l'agenda.
Agenda : 1
Agenda : 2
Agenda de ressources : 3

=== Table bab_cal_categories ===
contient les catégories d'événements
* id : identifiant de la catégorie
* name : nom de la catégorie
* description : description de la catégorie
* bgcolor : couleur héxa de la catégorie (ex : CC0000)

=== Table bab_cal_events ===
contient les événements des agendas (tous types d'agendas confondus). Cette table ne permet pas de savoir dans quels agendas sont publiés les événements car un événement peut faire partie de pluieurs agendas : voir table bab_cal_events_owners.
* id : identifiant de l'événement
* title : titre de l'événement
* description : description de l'événement
* description_format : format du texte de la description : html...
* location : lieu de l'événement
* start_date : date et heure de début de l'événement
* end_date : date et heure de fin de l'événement
* id_cat : identifiant de la catégorie d'événement
* id_creator : identifiant de l'auteur de l'événement
* hash : rempli uniquement lorsque l'événement est répétitif (ex : R_4697c6374e306b988eff36a868ff6f2c)
* color : couleur de l'événement (ex : FF0033)
* bprivate : indique si l'événement est privé. Valeur possible : Y ou N
* block : indique si l'événement est verrouillé. Valeur possible : Y ou N
* bfree : indique si l'événement est libre. Valeur possible : Y ou N
* date_modification : date de dernière modification de l'événement
* id_modifiedby : identifiant du dernier auteur modificateur
* uuid : identifiant unique de l'événement (utilisé pour des outils de synchronisation externe)

=== Table bab_cal_events_notes ===
contient les notes privées associées aux événements d'agendas par les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur
* note : contenu de la note

=== Table bab_cal_events_owners ===
lie les événements d'agendas (bab_cal_events) avec les agendas (bab_calendars)
* id_event : identifiant de l'événement
* id_cal : identifiant de l'agenda

=== Table bab_cal_events_reminders ===
contient les rappels d'événements pour les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur qui veut le rappel
* day : nombre de jours avant l'événement quand le rappel doit se déclencher
* hour : nombre d'heures avant l'événement quand le rappel doit se déclencher
* minute : nombre de minutes avant l'événement quand le rappel doit se déclencher
* bemail : vaut Y si les rappels doivent être envoyés par e-mails (voir options dans config.php), sinon N
* processed : vaut Y si l'utilisateur a demandé à cacher le rappel de sa fenêtre, sinon N par défaut

=== Table bab_cal_public ===
contient les agendas collectifs
* id : identifiant de l'agenda
* name : nom de l'agenda
* description : description de l'agenda
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation

=== Table bab_cal_resources ===
contient les agendas de ressources
* id : identifiant de l'agenda
* name : nom de l'agenda
* description :
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation
* availability_lock : vaut 1 si on veut empêcher la création d'événements en surbooking, sinon 0.

=== Table bab_cal_user_options ===
contient les options privés des utilisateurs sur l'ensemble des agendas

== Articles ==

=== Table bab_articles ===
contient les articles
* id : identifiant de l'article
* id_topic : identifiant du thème d'articles où se situe l'article
* id_author : identifiant de l'auteur de l'article
* date : date de création de l'article
* date_publication : date de publication de l'article
* date_archiving : date d'archivage de l'article
* date_modification : date de dernière modification de l'article
* title : titre de l'article
* head : introduction de l'article (obligatoire)
* body : corps de l'article
* archive : indique si l'article est une archive. Valeurs possibles : N ou Y
* lang : langue de l'article (fr, en...)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* ordering : entier indiquant l'ordre d'affichage de l'article dans le thème par rapport aux autres articles du thème
* id_modifiedby : identifiant du dernier auteur modificateur
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3

=== Table bab_articles_images ===
contient les images associées aux articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts ===
contient les brouillons d'articles (Rappel : avant d'être soumis ou approuvés, les textes sont des brouillons. Les brouillons se transforment en articles dès qu'ils sont soumis et approuvés)
* id : identifiant du brouillon
* id_author : identifiant de l'auteur du brouillon
* date_creation : date de création du brouillon
* date_modification : date de dernière modification du brouillon
* date_submission : date de soumission du brouillon
* date_publication : date de publication du brouillon
* date_archiving : date d'archivage du brouillon
* title : titre du brouillon
* head : introduction du brouillon (obligatoire)
* body : corps du brouillon
* lang : langue du brouillon (fr, en...)
* trash : indique si le brouillon est dans la corbeille ou pas. Valeurs possibles : N ou Y
* id_topic : identifiant du thème d'articles où se trouve le brouillon (peut être vide)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* hpage_private : vaut Y si l'article est proposé pour les pages d'accueil privées
* hpage_public : vaut Y si l'article est proposé pour les pages d'accueil publiques
* notify_members : vaut Y l'option 'notifier les lecteurs' est cochée
* idfai : identifiant de l'instance en cours du schéma d'approbation
* result : statut d'approbation (type entier). Valeurs possibles : 0, 1, 2, 3
0 : statut par défaut si pas d'approbation en cours
1 : l'article brouillon est en attente d'approbation
2 : l'article brouillon est approuvé (Remarque : ce statut n'est jamais utilisé car un article brouillon approuvé se transforme en article)
3 : l'article brouillon a été refusé
* id_article : identifiant de l'article si le brouillon est une modification d'un article existant
* id_anonymous : identifiant de l'auteur si l'auteur n'est pas authentifié. C'est l'identifiant d'un enregistrement dans la table BAB_USERS_LOG_TBL.
* approbation : vaut 0, 1 ou 2
* update_datemodif : vaut Y si

=== Table bab_art_drafts_files ===
contient les fichiers joints aux brouillons d'articles
* id :
* id_draft : identifiant de l'article brouillon
* name : nom du fichier (Ex : gaston.jpg)
* description : description du fichier
* ordering : entier indiquant l'ordre d'affichage du fichier par rapport aux autres fichiers joints de l'article brouillon

=== Table bab_art_drafts_images ===
contient les images associées aux brouillons d'articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts_notes ===
contient les commentaires des approbateurs qui ont refusés les articles brouillons (Pour le publicateur, les commentaires sont affichées en prévisualisation de l'article, depuis la liste des brouillons (lien Publication/onglet Mes Articles si l'article est en cours d'approbation))
* id : identifiant de la note
* id_draft : identifiant de l'article brouillon associé
* content : contenu texte de la note
* id_author : identifiant de l'auteur de la note
* date_note : date de création de la note

=== Table bab_art_drafts_tags ===
contient les tags (fonction Thésaurus) associés à des articles brouillons
* id_draft : identifiant de l'article brouillon
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_art_files ===
contient les fichiers joints des articles
* id : identifiant du fichier joint à l'article
* id_article : identifiant de l'article
* name :
* description : description du fichier joint
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3
* ordering : entier indiquant l'ordre d'affichage du fichier joint avec les autres fichiers joints d'un même article

=== Table bab_art_log ===
contient l'historique des modifications d'articles
* id : identifiant de la modification
* id_article : identifiant de l'article
* id_author : identifiant de l'auteur de la modification
* date_log : date et heure de la modification
* action_log : statut de la modification. Valeurs possibles : lock, unlock, commit, refused, accepted.
Lorsqu'on saisit la raison de la modification avant de modifier un article, le statut est lock.
Lorsqu'on soumet un article, le statut est commit. Si l'article ne passe pas par approbation, il y a immédiatement un autre enregistrement avec le statut accepted. commit et accepted sont aussi utilisés lorsqu'on modifie un brouillon puis qu'on soumet.
Lorsqu'on modifie un article et qu'on l'enregistre (on ne le soumet pas), seul un enregistrement est créé : celui avec le statut lock et la raison de la modification.
Il n'y a pas d'enregistrements si on créé un article et qu'il ne doit pas être approuvé.
Lorsqu'on supprime un brouillon, le statut est unlock.
* art_log : description de la modification. Contient le texte saisit comme raison de la modification

=== Table bab_art_tags ===
contient les tags (fonction Thésaurus) associés à des articles
* id_art : identifiant de l'article
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_comments ===
contient les commentaires des articles
* id : identifiant du commentaire
* id_parent : identifiant du commentaire parent
* id_article : identifiant de l'article associé au commentaire
* id_topic : identifiant du thème d'articles dans lequel est créé l'article
* id_author : auteur du commentaire
* id_last_editor : identifiant du dernier auteur modificateur
* date : date de création du commentaire
* last_update : date de la dernière modification du commentaire
* subject : titre du commentaire
* message : contenu texte du commentaire
* confirmed : Y si le commentaire est approuvé, N sinon
* name : nom de l'auteur du commentaire
* email : email de l'auteur du commentaire
* idfai : identifiant de l'instance du schéma d'approbation utilisé pour ce commentaire
* lang : langue du commentaire (fr, en...)
* article_rating : note attribuée à l'article. Valeurs possibles : 0, 1, 2, 3, 4, 5
0 : l'article n'est pas noté

=== Table bab_topcat_order ===
contient les numéros pour les tris d'affichage des catégories et des thèmes. Attention, sous une catégorie parente, il est possible d'ordonner les sous-catégories avec les sous-thèmes (il y a donc des mélanges d'où la colonne type).
Rappel : une catégorie est un conteneur de sous-catégories ou de thèmes.
* id : identifiant de l'ordre
* id_topcat : identifiant de la catégorie ou du thème que l'on veut ordonner
* type : 1 si l'ordre est définit pour une catégorie d'articles. 2 si l'ordre est défini pour un thème d'articles.
* ordering : entier indiquant l'ordre d'affichage de l'objet par rapport aux autres objets de la catégorie parente (id_parent)
* id_parent : identifiant de la catégorie d'articles parente d'idtopcat. C'est la catégorie dans laquelle on veut ordonner notre objet. Vaut 0 si l'objet qu'on veut trier est une catégorie de premier niveau (pas de catégorie parente).

=== Table bab_topics ===
contient les thèmes d'articles
* id : identifiant du thème
* category : nom du thème
* description : description du thème
* id_cat : identifiant de la catégorie dans laquelle se trouve le thème
* idsaart : identifiant du schéma d'approbation à la création d'articles
* idsacom : identifiant du schéma d'approbation des commentaires
* idsa_update : identifiant du schéma d'approbation à la modification des articles
* notify : Y si les auteurs peuvent notifier les lecteurs par email, N sinon
* lang : langue du thème (fr, en...)
* article_tmpl : nom du modèle d'articles
* display_tmpl : nom du patron d'affichage
* restrict_access : Y si les auteurs peuvent restreindre l'accès aux articles, N sinon
* allow_hpages : Y si on permet aux auteurs de proposer leurs articles pour les pages d'accueil, N sinon
* allow_pubdates : Y si on permet aux auteurs de spécifier des dates de publication, N sinon
* allow_attachments : Y si on permet aux auteurs de joindre des fichiers avec leurs articles, N sinon
* allow_update : entier indiquant si les auteurs peuvent modifier leurs articles. Valeurs possibles : 0, 1, 2
0 : les auteurs ne peuvent pas modifier leurs articles
1 : les auteurs peuvent modifier leurs articles, mais avec approbation
2 : les auteurs peuvent modifier leurs articles et sans approbation
* max_articles : nombre maximum d'articles sur la page des archives
* allow_manupdate : entier indiquant si les gestionnaires peuvent modifier les articles. Valeurs possibles : 0, 1, 2
0 : les gestionnaires ne peuvent pas modifier les articles
1 : les gestionnaires peuvent modifier les articles, mais avec approbation
2 : les gestionnaires peuvent modifier les articles et sans approbation
* auto_approbation : Y si on approuve automatiquement le contributeur dans le cas où il fait partie de la première étape du schéma d'approbation, N sinon
* busetags : Y si on utilise les mots-clés du thésaurus, N sinon
* allow_addImg : Y si on permet aux auteurs d'associer une image à un article
* allow_article_rating : Y si on permet aux auteurs des commentaires de noter les articles, N sinon

=== Table bab_topicscom_groups ===
Table de droits d'accès : groupes pouvant faire des commentaires sur le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsman_groups ===
Table de droits d'accès : groupes gestionnaires du thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsmod_groups ===
Table de droits d'accès : groupes pouvant modifier des articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicssub_groups ===
Table de droits d'accès : groupes pouvant soumettre de nouveaux articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsview_groups ===
Table de droist d'accès : groupes pouvant voir les articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topics_categories ===
contient les catégories d'articles (conteneurs des thèmes d'articles)
* id : identifiant de la catégorie
* title : titre de la catégorie
* description : description de la catégorie
* enabled : vaut Y si la section de la catégorie est activée, N sinon
* template : nom du patron de section
* id_dgowner : identifiant de la délégation où se trouve la catégorie, 0 si dans tout le site
* optional : utilisation inconnue !!!
* id_parent : identifiant de la catégorie parente
* display_tmpl : nom du patron d'affichage

=== Table bab_topics_categories_images ===
contient les images associées aux catégories d'articles
* id : identifiant de l'image
* idCategory : identifiant de la catégorie d'articles
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_topics_images ===
contient les images associées aux thèmes d'articles
* id : identifiant de l'image
* idTopic : identifiant du thème
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

Object-Relational Mapping

2009-09-07T14:54:11Z

Jeraiz : /* Sélectionner des données (équivalent requêtes SELECT en MySQL) */

La librairie LibOrm (Object-Relational Mapping) est une bibliothèque de correspondance entre la base de données et des objets PHP. Elle facilite la définition des tables de données et les requêtes SQL.

Le module LibOrm est disponible sur CVS : [http://213.215.40.194/cgi-bin/cvsweb.cgi/libraries/LibOrm/libraries/LibOrm]

{{Fonctionnalité|path=LibOrm|addon=LibOrm|version=0.6.3}}

--> Cette page ne recense pas toutes les possibilités de la librairie. Elle donne un aperçu des fonctions permettant de débuter dans l'utilisation de la librairie.

=== Exemple ===
Nous travaillons sur un module d'Ovidentia qui requiert la librairie LibOrm. Pour plus d'explications sur la méthode d'intégration d'une librairie dans un module : [[Fichiers spécifiques des modules]].

Dans notre module, nous gérons 2 tables de données : Contact et AdressePostale. Ces 2 tables sont liées car 1 contact a 1 adresse postale.

==== Les tables de données ====

Définition de la structure de la table AdressePostale. Il est indispensable de terminer le nom de la classe par Set.

<source lang="php">
/**
* Definition of a postal address.
*
* @property ORM_PkField $id
* @property ORM_TextField $rue
* @property ORM_StringField $codepostal
* @property ORM_StringField $ville
*/
class monmodule_AddressePostaleSet extends ORM_MySqlRecordSet {
function __construct() {
parent::__construct();

$this->setPrimaryKey('id');
$this->addFields(
ORM_TextField('rue')->setDescription('Street'),
ORM_StringField('codepostal', 10)->setDescription('Zip code'),
ORM_StringField('ville', 60)->setDescription('City')
);
}
}
</source>

Définition de la classe AdressePostale en tant qu'enregistrement (record). Lorsque la librairie LibOrm retournera une ligne de la table AdressePostale, la librairie retournera un objet de la classe AdressePostale.
Remarque : si vous n'avez pas besoin de personnaliser la classe d'enregistrement, il n'est pas nécessaire de la créer. Elle sera automatiquement créée par la librairie à partir du nom de la classe AdressePostaleSet.

<source lang="php">
class monmodule_AddressePostale extends ORM_MySqlRecord {

}
</source>

Définition de la structure de la table Contact :

<source lang="php">
class monmodule_ContactSet extends ORM_MySqlRecordSet {
function __construct() {
parent::__construct();

$this->setPrimaryKey('id');
$this->addFields(
ORM_StringField('nom', 80)->setDescription('Nom'),
ORM_StringField('prenom', 80)->setDescription('Prénom'),
ORM_StringField('poste', 50)->setDescription('Métier'),
ORM_StringField('bureau', 15)->setDescription('Bureau'),
ORM_StringField('telephone', 30)->setDescription('Téléphone'),
ORM_StringField('fax', 30)->setDescription('Fax'),
ORM_StringField('mobile', 30)->setDescription('Téléphone Mobile'),
ORM_StringField('email', 255)->setDescription('E-mail')
);

$this->hasOne('addressepostale', 'monmodule_AddressePostaleSet');
}
}
</source>

Définition de la classe Contact en tant qu'enregistrement (record).

<source lang="php">
class monmodule_Contact extends ORM_MySqlRecord {

}
</source>

''' Type de champs : '''

* ORM_PkField : Primary Key (1 seul dans une table)
* ORM_FkField : Foreign key (référence à une autre clé)
* ORM_IntField : entier
* ORM_BoolField : booléen
* ORM_CurrencyField : monnaie
* ORM_DateField : date
* ORM_TimeField : temps
* ORM_DatetimeField : date et temps
* ORM_StringField : chaine
* ORM_TextField : chaine multi-lignes
* ORM_EnumField : énumération

=== Utilisation de la librairie et initialisation ===

Après installation de la librairie sur le portail, vous pouvez l'utiliser dans votre code PHP en appelant la fonctionnalité.
Il est nécessaire d'initialiser le back-end (la base de données) qui sera utilisé. En effet la librairie prévoit des requêtes dans différents formats de base de données : MySQL, XML, RSS...

Cet exemple montre l'utilisation du back-end MySQL. Le constructeur de la classe ORM_MySqlBackend prend en paramètre la variable globale d'Ovidentia (objet babDatabase) :

<source lang="php">
bab_functionality::get('LibOrm')->initMySql();
$mysqlbackend = new ORM_MySqlBackend($GLOBALS['babDB']);
ORM_MySqlRecordSet::setBackend($mysqlbackend);
</source>

==== Requêtes : gestion des données ====

Nous avons défini nos tables de données dans les chapitres précédents. Pour les exemples de requêtes les définitions de classes doivent être disponibles dans le code PHP.

===== Insérer des données (équivalent requêtes INSERT dans MySQL) =====

Pour ajouter une donnée (ici une adresse postale), on définit un nouvel enregistrement en utilisant la méthode newRecord() sur la classe de définition (ici monmodule_AdressePostaleSet).

<source lang="php">
$adresseset = new monmodule_AddressePostaleSet();
$adresse = $adresseset->newRecord();
</source>

Les champs définis dans la classe monmodule_AddressePostaleSet seront disponibles sous la forme de variables dans les objets de cette classe. La méthode save() sur l'objet effectuera l'enregistrement de la nouvelle donnée.

<source lang="php">
$adresseset = new monmodule_AddressePostaleSet();
$adresse = $adresseset->newRecord();

$adresse->rue = '45, rue Georges André';
$adresse->codepostal = '54000';
$adresse->ville = 'Nancy';

$adresse->save();
</source>

Remarque :

Dès l'utilisation de la méthode save() sur l'objet, vous travaillez sur la donnée enregistrée. Un nouvel appel à la méthode save() ne créera pas un nouvel enregistrement mais modifiera la donnée en cours :

<source lang="php">
$adresseset = new monmodule_AddressePostaleSet();
$adresse = $adresseset->newRecord();

$adresse->rue = '45, rue Georges André';
$adresse->codepostal = '54000';
$adresse->ville = 'Nancy';

$adresse->save();

$adresse->codepostal = '78000';
$adresse->ville = 'Versailles';

$adresse->save();
</source>

====== Gestion des données liées ======

Nos définitions de tables prévoyaient une liaison entre un contact et une adresse postale. Voici un exemple permettant d'insérer un contact et son adresse automatiquement. Il est nécessaire pour cela de définir une liaison JOIN :

<source lang="php">
$contactset = new monmodule_ContactSet();
$contactset->join('addressepostale');

$contact = $contactset->newRecord();

$contact->nom = 'Martin';
$contact->prenom = 'Henry';
$contact->addressepostale->rue = '45, rue Georges André';
$contact->addressepostale->codepostal = '54000';
$contact->addressepostale->ville = 'Nancy';

$contact->save();
</source>

===== Sélectionner des données (équivalent requêtes SELECT en MySQL) =====

La sélection de données s'effectue par la méthode select() sur l'objet de définition. Il est conseillé d'utiliser la commande foreach pour parcourir les résultats.

Cet exemple montre la sélection de tous les contacts et affiche leurs noms.

<source lang="php">
$contactset = new monmodule_ContactSet();

$contacts = $contactset->select();
foreach ($contacts as $contact) {
echo $contact->nom;
}
</source>

Cet exemple montre la sélection de tous les contacts dont le prénom est Paul et affiche leurs noms. On passe en paramètre à la méthode select() un critère (objet ORM_Criteria).

<source lang="php">
$contactset = new monmodule_ContactSet();

$contacts = $contactset->select($contactset->prenom->is('Paul'));
foreach ($contacts as $contact) {
echo $contact->nom;
}
</source>

Cet exemple montre la sélection de tous les contacts dont le prénom est Paul et dont le nom commence par André et affiche leurs noms. L'opérateur _AND_ permet la création d'un critère à partir de 2 critères.

<source lang="php">
$contactset = new monmodule_ContactSet();
$contactset->join('addressepostale');

$contacts = $contactset->select($contactset->prenom->is('Paul')->_AND_($contactset->nom->startsWith('André')));
foreach ($contacts as $contact) {
echo $contact->nom;
}
</source>

''' Une autre méthode pour sélectionner un enregistrement : '''

Pour sélectionner un seul enregistrement de table, vous pouvez utiliser la méthode select() mais choisissez plutôt la méthode get(). Cette dernière retourne exclusivement l'objet en recevant la valeur de la clé primaire.

<source lang="php">
$contactset = new monmodule_ContactSet();
$contactset->join('addressepostale');

$contact = $contactset->get(5);
if ($contact !== NULL) {
echo $contact->nom;
}
</source>

''' Types de critères : '''

* greaterThan
* greaterThanOrEqual
* lessThan
* lessThanOrEqual
* in
* is
* isNot
* notIn
* notLike
* like
* startsWith
* endsWith
* contains
* fieldIsNull

''' Opérateurs : '''

* _AND_
* _OR_
* _NOT

'''Ordonner les résultats :'''

Vous pouvez ordonner simplement les résultats en utilisant la méthode orderAsc() ou orderDesc() de cette manière :

<source lang="php">
$contactset = new monmodule_ContactSet();
$contactset->join('addressepostale');

$contacts = $contactset->select()->orderAsc($contactset->nom);
foreach ($contacts as $contact) {
echo $contact->nom;
}
</source>

===== Mettre à jour des données (équivalent requêtes UPDATE en MySQL) =====

La modification d'une donnée passe par la méthode save() sur l'objet en cours. La donnée en cours peut provenir d'une requête de sélection ou de création.

Cet exemple montre 2 appels à la méthode save(). Le premier appel créé un nouvel enregistrement. Le deuxième effectue une modification de l'enregistrement.

<source lang="php">
$adresseset = new monmodule_AddressePostaleSet();
$adresse = $adresseset->newRecord();
$adresse->rue = '45, rue Georges André';
$adresse->codepostal = '54000';
$adresse->ville = 'Nancy';

$adresse->save();

$adresse->codepostal = '78000';
$adresse->ville = 'Versailles';

$adresse->save();
</source>

Cet exemple montre l'appel à la méthode save() après une requête de sélection. Le code affecte une majuscule au prénom Paul à tous les contacts qui n'en n'avaient pas.

<source lang="php">
$contactset = new monmodule_ContactSet();
$contactset->join('addressepostale');

$contacts = $contactset->select($contactset->prenom->is('paul'));
foreach ($contacts as $contact) {
$contact->prenom = 'Paul';
$contact->save();
}
</source>

===== Supprimer des données (équivalent requêtes DELETE en MySQL) =====

Pour supprimer des données, on utilise la méthode delete sur l'objet de définition. Cette méthode prend en paramètre un critère (objet ORM_Criteria).

Dans cet exemple, on supprime tous les contacts dont le prénom est paul :

<source lang="php">
$contactset = new monmodule_ContactSet();

$contacts = $contactset->delete($contactset->prenom->is('paul'));
</source>

Widgets

2009-08-11T11:55:04Z

Jeraiz : /* Diagramme d'héritage des classes */

[[Catégorie:Documentation des librairies]]

Cette librairie facilite la création des interfaces en proposant des objets associés à chaque élément connu d'une page Web : champ de formulaire, tableau, lien avec puce, popup calendrier de sélection d'un jour...

{{Fonctionnalité|path=Widgets|addon=widgets|version=0.1.9}}

=== Initialisation ===

==== Fichier addonini.php ====

Pour accéder aux widgets dans un module d'Ovidentia, il est nécessaire d'installer la librairie Widgets et le module jQuery.

De manière a éviter tout problème ces pré-requis devront être signalés dans le fichier addonini.php du module en y ajoutant quelques lignes :

<source lang="ini">
;<?php/*

[general]
name="my_addon"
.
.
.

[addons]
widgets="0.2.0"

[functionalities]
jquery="Available"

*/?>
</source>

==== Utilisation de la librairie ====

Pour utiliser la librairie dans un code PHP, il est nécessaire d'utiliser la fonction bab_functionality(). Il est conseillé d'inclure les styles utiles à quelques widgets :

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
</source>

=== Les pages ===

La page est le point de départ d'une interface. C'est elle qui contient tous les éléments.

On définit une page grâce à l'objet Widget_BabPage.

La page créée est insérée dans le corps du site Ovidentia : le bandeau et les sections du site apparaîtront autour de la page.

<source lang="php">
$page = $W->BabPage();
</source>

Il est possible de définir le positionnement des éléments à l'intérieur de chaque élément.
Ici, on définit le positionnement pour la page en cours :

# La méthode VBoxLayout() définit une mise en page verticale.
# La méthode HBoxLayout() définit une mise en page horizontale.
# La méthode FlowLayout() définit une mise en page horizontale en 'écoulement' : les éléments reviennent à la ligne automatiquement.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());
</source>

Pour travailler avec des applications en pleine page ou avec des popups, vous pouvez désactiver le mode intégré avec la méthode setEmbedded(). Le bandeau et les sections du site n'apparaîtront pas :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->setEmbedded(false);
</source>

Pour afficher le contenu de la page, on utilise la méthode displayHtml() :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$bonjourLabel = $W->Label('Bonjour');
$page->addItem($bonjourLabel);

$page->displayHtml();
</source>

'''Définir un titre de page :'''

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->setTitle('Configuration');

$page->displayHtml();
</source>

'''Ajouter un message d'erreurs à la page :'''

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->addError("Vous n'avez pas les droits d'accès");

$page->displayHtml();
</source>

=== Insérer des éléments ===

On ajoute des éléments via la méthode addItem() sur un élément conteneur (objet Widget_BabPage par exemple). Dans l'exemple ci-dessous, on ajoute un texte dans notre page.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$bonjourLabel = $W->Label('Bonjour');
$page->addItem($bonjourLabel);

$page->displayHtml();
</source>

=== Navigation horizontale avec les onglets ===

La méthode addItemMenu() sur l'objet Widget_BabPage permet de définir un onglet. La méthode setCurrentItemMenu() permet de définir l'onglet courant.

Dans cet exemple, on affiche 2 onglets : configuration et droits. Droits est l'onglet en cours.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$addon = bab_getAddonInfosInstance('monmodule');
$page->addItemMenu('configuration', 'Configuration', $addon->getUrl().'user&idx=config');
$page->addItemMenu('droits', 'Droits', $addon->getUrl().'user&idx=droits');
$page->setCurrentItemMenu('droits');

$page->displayHtml();
</source>

=== Les textes ===

Les textes sont gérés par les objets Widget_Label et Widget_RichText.

Widget_Label permet d’ajouter un élément texte simple. Si le contenu du texte contient un code javascript, il ne sera pas interprété. Une balise HTML s’affichera à l’écran et ne sera pas interprétée.

<source lang="php">

$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$texte = $W->Label('Qui vivra verra.');
$page->addItem($texte);

$page->displayHtml();
</source>

Widget_RichText permet d’ajouter un élément texte complexe (texte mis en forme comme du HTML). Par défaut le fonctionnement est le même l’objet Widget_Label concernant l’affichage du texte. Cependant il possible d’utiliser la méthode setRenderingOptions() pour indiquer le format d’affichage du texte :

* BAB_HTML_ALL : valeur par défaut : combinaison de plusieurs options

* BAB_HTML_ENTITIES : les caractères spéciaux seront convertis en caractères HTML

* BAB_HTML_AUTO : des balises paragraphes seront ajoutées pour remplacer les retours à la ligne dans le texte

* BAB_HTML_P : des balises paragraphes seront ajoutées pour remplacer les doubles retours à la ligne

* BAB_HTML_BR : des balises BR seront ajoutées pour remplacer les retours à la ligne

* BAB_HTML_LINKS : les URL et les e-mails seront remplacés par des liens

* BAB_HTML_JS : les caractères \ , ' et " seront protégés pour un code javascript, ce format n’est inclut dans BAB_HTML_ALL

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$texte = $W->RichText('<b>Qui vivra verra.</b>');
$texte->setRenderingOptions(BAB_HTML_AUTO);
$page->addItem($texte);

$page->displayHtml();
</source>

=== Code Html libre ===
Vous pouvez insérer du code Html quelconque via l'objet Widget_Html :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$html = $W->Html('<ul>
<li>Choix 1</li>
<li>Choix 2</li>
</ul>');
$page->addItem($html);
$page->displayHtml();
</source>

=== Les formulaires ===

La création d'un formulaire utilise essentiellement les objets Widget_Form et Widget_InputWidget.

Widget_Form permet de définir un formulaire, la cible (attribut action d'une balise form) est automatiquement pré-renseignée au point d'entrée d'Ovidentia (index.php). Pour configurer une cible plus précise, utilisez la méthode setHiddenValue() comme dans l'exemple ci-dessous.

Par défaut, la méthode utilisée pour l'envoi des données est POST. Si vous désirez une méthode GET, appelez la méthode setReadOnly() :

<source lang="php">
$form = $W->Form();
$form->setReadOnly();

$form->setLayout($W->VBoxLayout());

$form->setHiddenValue('tg', $GLOBALS['babAddonTarget'].'/admin');
$form->setHiddenValue('idx', 'configurationsave');
</source>

''' Les champs : '''

Les champs des formulaires sont des objets Widget_InputWidget. Liste des champs utiles :

* Checkbox : case à cocher
* DatePicker : sélection d'une date avec popup de calendrier
* GroupPicker : sélection d'un groupe d'utilisateurs
* LineEdit : case de saisie
* SimpleHtmlEdit : case de saisie avec mise en forme (éditeur wysiwyg simplifié)
* TextEdit : case de saisie multi-lignes
* TimePicker : sélection d'une heure
* Uploader : champ fichier

Après la création d'un champ, il est essentiel de définir son nom (attribut name d'une balise input) par la méthode setName(). Une valeur d'initialisation peut être renseignée via la méthode setValue().

<source lang="php">
$champidentifiant = $W->LineEdit()->setName('identifiant')->setValue('Votre identifiant');
</source>

'''Les boutons :'''

L'objte Widget_SubmitButton permet de définir un bouton de soumission :

<source lang="php">
$form->addItem($W->SubmitButton()->setLabel('Enregistrer'));
</source>

'''Exemple avec l'affichage d'un formulaire contenant 2 cases de saisies Identifiant et Mot de passe :'''

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$form = $W->Form();
$form->setLayout($W->VBoxLayout());
$form->setHiddenValue('tg', $GLOBALS['babAddonTarget'].'/admin');
$form->setHiddenValue('idx', 'configurationsave');

$form->addItem($W->LineEdit()->setName('identifiant')->setValue('Votre identifiant'));
$form->addItem($W->LineEdit()->setName('passe')->setValue('Votre mot de passe'));

$page->addItem($form);
$page->displayHtml();
</source>

'''Exemple de création d'une liste déroulante sélectionnée sur le 3ème choix :'''

<source lang="php">
$select = $W->Select()->setName('notation');
$select->addOption(1, 'mauvais');
$select->addOption(2, 'bon');
$select->addOption(3, 'parfait');
$select->setValue(3);
</source>

''' La réception des données saisies : '''

La réception des données saisies dans un formulaire dépend des conteneurs utilisés avec le formulaire. Explication :

Dans notre exemple, l'objet Widget_Form n'a pas de nom et ne contient aucun conteneur (un conteneur est un objet Widget qui contient d'autres objets : une frame est un conteneur). Nos 2 champs identifiant et passe seront récupérés normalement par PHP :

<source lang="php">
$identifiantsaisit = bab_pp('identifiant', '');
$motdepassesaisit = bab_pp('identifiant', '');
</source>

Cependant dès l'instant que vous définissez des noms aux conteneurs présents dans le formulaire, les données envoyées seront envoyées sous forme de tableaux.

Si on définit un nom à l'objet Widget_Form :
<source lang="php">
$form = $W->Form()->setName('formulaire_identification');
</source>

Les données seront reçues dans un tableau :

<source lang="php">
$donneesformulaire = bab_rp('formulaire_identification', array());
$identifiantsaisit = '';
$motdepassesaisit = '';
if (isset($donneesformulaire['identifiant'])) {
$identifiantsaisit = $donneesformulaire['identifiant'];
}
if (isset($donneesformulaire['passe'])) {
$motdepassesaisit = $donneesformulaire['passe'];
}
</source>

=== Styliser les éléments ===

Vous pouvez styliser les éléments Widgets en appelant une feuille de styles CSS dans la page. Vous définissez alors des styles sur les classes générées par les widgets.

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->addStyleSheet('styles.css');
</source>

Pour être plus précis, vous pouvez ajouter une classe sur tous les éléments widgets :

<source lang="php">
$field = $W->LineEdit()->setName('identifiant')->addClass('field-description');
</source>

=== Exemples ===

==== Hello world ! ====

Commençons par un exemple simple qui se contentera d'afficher le texte "Hello world !" sur une page. L'exemple contient un certain nombre d'opérations qui seront nécessaires pour toutes les pages utilisant les widgets.

<source lang="php">
// Ici on récupère l'objet Func_Widgets qui servira notamment à créer tous les widgets et layouts
$W = bab_functionality::get('Widgets');

// On crée une page, qui sera le container principal.
$page = $W->BabPage();

// On associe à la page une mise en page (layout) verticale : les éléments qu'on y ajoutera seront disposés les uns sous les autres.
$page->setLayout($W->VBoxLayout());

// Création d'un simple texte (Label)
$helloLabel = $W->Label('Hello world !');

// On ajoute ce texte à la page.
$page->addItem($helloLabel);

// C'est fini, on affiche la page.
$page->displayHtml();
</source>

=== Diagramme d'héritage des classes ===

Voici un diagramme court montrant l'héritage et les relations entre les classes objets :

[[Image:Diagramme.png|center|thumb|350px|Diagramme]]

Un peu d'explications :

Sur la gauche de l'image, on aperçoit les classes Widget_ContainerWidget, Widget_Widget et Widget_Item. Tous les objets de la librairie héritent de la classe Widget_Item.

On a pris comme exemple la classe Widget_Form qui gère la construction d'un formulaire de saisie. On remarque que la classe Widget_Form hérite de Widget_ContainerWidget. En effet, dans le cas des objets qui peuvent contenir d'autres objets, on passe par la classe Widget_ContainerWidget pour gérer les sous-éléments.

Un second avantage est la relation de la classe Widget_ContainerWidget avec Widget_Layout. Widget_Layout gère la disposition des éléments dans un Widget_ContainerWidget. Ainsi, le choix d'une disposition VBoxLayout permettra d'afficher automatiquement les éléments à la verticale les uns en dessous des autres sans gérer nous-mêmes de retours à la ligne.

Sur la droite, on aperçoit les classes Canvas. Elles sont destinées à afficher ou exporter les données au format désiré. Toutes les méthodes display() des objets de la librairie prennent en paramètre un Canvas. Le Canvas le plus utilisé est Widgets_HtmlCanvas : il affiche les objets (Form, InputSelect, DatePicker, Page...) pour une page Web donc au format HTML, javascript, css...

Widgets

2009-08-11T11:54:37Z

Jeraiz : /* Diagramme d'héritage des classes */

[[Catégorie:Documentation des librairies]]

Cette librairie facilite la création des interfaces en proposant des objets associés à chaque élément connu d'une page Web : champ de formulaire, tableau, lien avec puce, popup calendrier de sélection d'un jour...

{{Fonctionnalité|path=Widgets|addon=widgets|version=0.1.9}}

=== Initialisation ===

==== Fichier addonini.php ====

Pour accéder aux widgets dans un module d'Ovidentia, il est nécessaire d'installer la librairie Widgets et le module jQuery.

De manière a éviter tout problème ces pré-requis devront être signalés dans le fichier addonini.php du module en y ajoutant quelques lignes :

<source lang="ini">
;<?php/*

[general]
name="my_addon"
.
.
.

[addons]
widgets="0.2.0"

[functionalities]
jquery="Available"

*/?>
</source>

==== Utilisation de la librairie ====

Pour utiliser la librairie dans un code PHP, il est nécessaire d'utiliser la fonction bab_functionality(). Il est conseillé d'inclure les styles utiles à quelques widgets :

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
</source>

=== Les pages ===

La page est le point de départ d'une interface. C'est elle qui contient tous les éléments.

On définit une page grâce à l'objet Widget_BabPage.

La page créée est insérée dans le corps du site Ovidentia : le bandeau et les sections du site apparaîtront autour de la page.

<source lang="php">
$page = $W->BabPage();
</source>

Il est possible de définir le positionnement des éléments à l'intérieur de chaque élément.
Ici, on définit le positionnement pour la page en cours :

# La méthode VBoxLayout() définit une mise en page verticale.
# La méthode HBoxLayout() définit une mise en page horizontale.
# La méthode FlowLayout() définit une mise en page horizontale en 'écoulement' : les éléments reviennent à la ligne automatiquement.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());
</source>

Pour travailler avec des applications en pleine page ou avec des popups, vous pouvez désactiver le mode intégré avec la méthode setEmbedded(). Le bandeau et les sections du site n'apparaîtront pas :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->setEmbedded(false);
</source>

Pour afficher le contenu de la page, on utilise la méthode displayHtml() :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$bonjourLabel = $W->Label('Bonjour');
$page->addItem($bonjourLabel);

$page->displayHtml();
</source>

'''Définir un titre de page :'''

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->setTitle('Configuration');

$page->displayHtml();
</source>

'''Ajouter un message d'erreurs à la page :'''

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->addError("Vous n'avez pas les droits d'accès");

$page->displayHtml();
</source>

=== Insérer des éléments ===

On ajoute des éléments via la méthode addItem() sur un élément conteneur (objet Widget_BabPage par exemple). Dans l'exemple ci-dessous, on ajoute un texte dans notre page.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$bonjourLabel = $W->Label('Bonjour');
$page->addItem($bonjourLabel);

$page->displayHtml();
</source>

=== Navigation horizontale avec les onglets ===

La méthode addItemMenu() sur l'objet Widget_BabPage permet de définir un onglet. La méthode setCurrentItemMenu() permet de définir l'onglet courant.

Dans cet exemple, on affiche 2 onglets : configuration et droits. Droits est l'onglet en cours.

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$addon = bab_getAddonInfosInstance('monmodule');
$page->addItemMenu('configuration', 'Configuration', $addon->getUrl().'user&idx=config');
$page->addItemMenu('droits', 'Droits', $addon->getUrl().'user&idx=droits');
$page->setCurrentItemMenu('droits');

$page->displayHtml();
</source>

=== Les textes ===

Les textes sont gérés par les objets Widget_Label et Widget_RichText.

Widget_Label permet d’ajouter un élément texte simple. Si le contenu du texte contient un code javascript, il ne sera pas interprété. Une balise HTML s’affichera à l’écran et ne sera pas interprétée.

<source lang="php">

$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$texte = $W->Label('Qui vivra verra.');
$page->addItem($texte);

$page->displayHtml();
</source>

Widget_RichText permet d’ajouter un élément texte complexe (texte mis en forme comme du HTML). Par défaut le fonctionnement est le même l’objet Widget_Label concernant l’affichage du texte. Cependant il possible d’utiliser la méthode setRenderingOptions() pour indiquer le format d’affichage du texte :

* BAB_HTML_ALL : valeur par défaut : combinaison de plusieurs options

* BAB_HTML_ENTITIES : les caractères spéciaux seront convertis en caractères HTML

* BAB_HTML_AUTO : des balises paragraphes seront ajoutées pour remplacer les retours à la ligne dans le texte

* BAB_HTML_P : des balises paragraphes seront ajoutées pour remplacer les doubles retours à la ligne

* BAB_HTML_BR : des balises BR seront ajoutées pour remplacer les retours à la ligne

* BAB_HTML_LINKS : les URL et les e-mails seront remplacés par des liens

* BAB_HTML_JS : les caractères \ , ' et " seront protégés pour un code javascript, ce format n’est inclut dans BAB_HTML_ALL

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$texte = $W->RichText('<b>Qui vivra verra.</b>');
$texte->setRenderingOptions(BAB_HTML_AUTO);
$page->addItem($texte);

$page->displayHtml();
</source>

=== Code Html libre ===
Vous pouvez insérer du code Html quelconque via l'objet Widget_Html :

<source lang="php">
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$html = $W->Html('<ul>
<li>Choix 1</li>
<li>Choix 2</li>
</ul>');
$page->addItem($html);
$page->displayHtml();
</source>

=== Les formulaires ===

La création d'un formulaire utilise essentiellement les objets Widget_Form et Widget_InputWidget.

Widget_Form permet de définir un formulaire, la cible (attribut action d'une balise form) est automatiquement pré-renseignée au point d'entrée d'Ovidentia (index.php). Pour configurer une cible plus précise, utilisez la méthode setHiddenValue() comme dans l'exemple ci-dessous.

Par défaut, la méthode utilisée pour l'envoi des données est POST. Si vous désirez une méthode GET, appelez la méthode setReadOnly() :

<source lang="php">
$form = $W->Form();
$form->setReadOnly();

$form->setLayout($W->VBoxLayout());

$form->setHiddenValue('tg', $GLOBALS['babAddonTarget'].'/admin');
$form->setHiddenValue('idx', 'configurationsave');
</source>

''' Les champs : '''

Les champs des formulaires sont des objets Widget_InputWidget. Liste des champs utiles :

* Checkbox : case à cocher
* DatePicker : sélection d'une date avec popup de calendrier
* GroupPicker : sélection d'un groupe d'utilisateurs
* LineEdit : case de saisie
* SimpleHtmlEdit : case de saisie avec mise en forme (éditeur wysiwyg simplifié)
* TextEdit : case de saisie multi-lignes
* TimePicker : sélection d'une heure
* Uploader : champ fichier

Après la création d'un champ, il est essentiel de définir son nom (attribut name d'une balise input) par la méthode setName(). Une valeur d'initialisation peut être renseignée via la méthode setValue().

<source lang="php">
$champidentifiant = $W->LineEdit()->setName('identifiant')->setValue('Votre identifiant');
</source>

'''Les boutons :'''

L'objte Widget_SubmitButton permet de définir un bouton de soumission :

<source lang="php">
$form->addItem($W->SubmitButton()->setLabel('Enregistrer'));
</source>

'''Exemple avec l'affichage d'un formulaire contenant 2 cases de saisies Identifiant et Mot de passe :'''

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$form = $W->Form();
$form->setLayout($W->VBoxLayout());
$form->setHiddenValue('tg', $GLOBALS['babAddonTarget'].'/admin');
$form->setHiddenValue('idx', 'configurationsave');

$form->addItem($W->LineEdit()->setName('identifiant')->setValue('Votre identifiant'));
$form->addItem($W->LineEdit()->setName('passe')->setValue('Votre mot de passe'));

$page->addItem($form);
$page->displayHtml();
</source>

'''Exemple de création d'une liste déroulante sélectionnée sur le 3ème choix :'''

<source lang="php">
$select = $W->Select()->setName('notation');
$select->addOption(1, 'mauvais');
$select->addOption(2, 'bon');
$select->addOption(3, 'parfait');
$select->setValue(3);
</source>

''' La réception des données saisies : '''

La réception des données saisies dans un formulaire dépend des conteneurs utilisés avec le formulaire. Explication :

Dans notre exemple, l'objet Widget_Form n'a pas de nom et ne contient aucun conteneur (un conteneur est un objet Widget qui contient d'autres objets : une frame est un conteneur). Nos 2 champs identifiant et passe seront récupérés normalement par PHP :

<source lang="php">
$identifiantsaisit = bab_pp('identifiant', '');
$motdepassesaisit = bab_pp('identifiant', '');
</source>

Cependant dès l'instant que vous définissez des noms aux conteneurs présents dans le formulaire, les données envoyées seront envoyées sous forme de tableaux.

Si on définit un nom à l'objet Widget_Form :
<source lang="php">
$form = $W->Form()->setName('formulaire_identification');
</source>

Les données seront reçues dans un tableau :

<source lang="php">
$donneesformulaire = bab_rp('formulaire_identification', array());
$identifiantsaisit = '';
$motdepassesaisit = '';
if (isset($donneesformulaire['identifiant'])) {
$identifiantsaisit = $donneesformulaire['identifiant'];
}
if (isset($donneesformulaire['passe'])) {
$motdepassesaisit = $donneesformulaire['passe'];
}
</source>

=== Styliser les éléments ===

Vous pouvez styliser les éléments Widgets en appelant une feuille de styles CSS dans la page. Vous définissez alors des styles sur les classes générées par les widgets.

<source lang="php">
$W = bab_functionality::get('Widgets');
$W->includeCss();
$page = $W->BabPage();
$page->setLayout($W->VBoxLayout());

$page->addStyleSheet('styles.css');
</source>

Pour être plus précis, vous pouvez ajouter une classe sur tous les éléments widgets :

<source lang="php">
$field = $W->LineEdit()->setName('identifiant')->addClass('field-description');
</source>

=== Exemples ===

==== Hello world ! ====

Commençons par un exemple simple qui se contentera d'afficher le texte "Hello world !" sur une page. L'exemple contient un certain nombre d'opérations qui seront nécessaires pour toutes les pages utilisant les widgets.

<source lang="php">
// Ici on récupère l'objet Func_Widgets qui servira notamment à créer tous les widgets et layouts
$W = bab_functionality::get('Widgets');

// On crée une page, qui sera le container principal.
$page = $W->BabPage();

// On associe à la page une mise en page (layout) verticale : les éléments qu'on y ajoutera seront disposés les uns sous les autres.
$page->setLayout($W->VBoxLayout());

// Création d'un simple texte (Label)
$helloLabel = $W->Label('Hello world !');

// On ajoute ce texte à la page.
$page->addItem($helloLabel);

// C'est fini, on affiche la page.
$page->displayHtml();
</source>

=== Diagramme d'héritage des classes ===

Voici un diagramme court montrant l'héritage et les relations entre les classes objets :

[[Image:Diagramme.png|center|thumb|350px|Diagramme]]

Un peu d'explications :

Sur la gauche de l'image, on aperçoit les classes Widget_ContainerWidget, Widget_Widget et Widget_Item. Tous les objets de la librairie héritent de la classe Widget_Item.

On a pris comme exemple la classe Widget_Form qui gère la construction d'un formulaire de saisie. On remarque que la classe Widget_Form hérite de Widget_ContainerWidget. En effet, dans le cas des objets qui peuvent contenir d'autres objets, on passe par la classe Widget_ContainerWidget pour gérer les sous-éléments.

Un second avantage est la relation de la classe Widget_ContainerWidget avec Widget_Layout. Widget_Layout gère la disposition des éléments dans un Widget_ContainerWidget. Ainsi, le choix d'une disposition VBoxLayout permettra d'afficher automatiquement les éléments à la verticale les uns en dessous des autres sans gérer nous-mêmes de retours à la ligne.

Sur la droite, on aperçoit les classes Canvas. Elles sont destinées à afficher ou exporter les données au format désiré. Toutes les méthodes display() des objets de la librairie prennent en paramètre un Canvas. Le Canvas le plus utilisé est Widgets_HtmlCanvas : il affiche les objets (Form, InputSelect, DatePicker, Page...) pour une page Web donc au foramt HTML, javascript, css...

Fichier:Diagramme.png

2009-08-11T11:41:35Z

Jeraiz : Diagramme simplifié des classes de la librairie Widgets

Diagramme simplifié des classes de la librairie Widgets

Widgets

2009-08-11T11:40:57Z

Jeraiz : /* Diagramme d'héritage des classes */

Widgets

2009-08-11T09:46:40Z

Jeraiz :

Structures des tables de données d'Ovidentia

2009-08-06T09:05:37Z

Jeraiz : /* Table bab_comments */

Cet article est en cours de rédaction. Son contenu n'est pas exhaustif.

== Agenda ==

=== Table bab_calendar ===
contient les agendas (les noms des agendas ne se trouvent pas dans cette table). La table est liée aux tables bab_cal_public, bab_cal_resources ou bab_cal_events (il n'y a pas de tables pour les agendas personnels)
* id : identifiant d'un agenda
* owner : correspond pour un agenda de ressources à l'identifiant de l'enregistrement dans la table bab_cal_resources
* type : type de l'agenda.
Agenda : 1
Agenda : 2
Agenda de ressources : 3

=== Table bab_cal_categories ===
contient les catégories d'événements
* id : identifiant de la catégorie
* name : nom de la catégorie
* description : description de la catégorie
* bgcolor : couleur héxa de la catégorie (ex : CC0000)

=== Table bab_cal_events ===
contient les événements des agendas (tous types d'agendas confondus). Cette table ne permet pas de savoir dans quels agendas sont publiés les événements car un événement peut faire partie de pluieurs agendas : voir table bab_cal_events_owners.
* id : identifiant de l'événement
* title : titre de l'événement
* description : description de l'événement
* location : lieu de l'événement
* start_date : date et heure de début de l'événement
* end_date : date et heure de fin de l'événement
* id_cat : identifiant de la catégorie d'événement
* id_creator : identifiant de l'auteur de l'événement
* hash : rempli uniquement lorsque l'événement est répétitif (ex : R_4697c6374e306b988eff36a868ff6f2c)
* color : couleur de l'événement (ex : FF0033)
* bprivate : indique si l'événement est privé. Valeur possible : Y ou N
* block : indique si l'événement est verrouillé. Valeur possible : Y ou N
* bfree : indique si l'événement est libre. Valeur possible : Y ou N
* date_modification : date de dernière modification de l'événement
* id_modifiedby : identifiant du dernier auteur modificateur
* uuid : identifiant unique de l'événement (utilisé pour des outils de synchronisation externe)

=== Table bab_cal_events_notes ===
contient les notes privées associées aux événements d'agendas par les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur
* note : contenu de la note

=== Table bab_cal_events_owners ===
lie les événements d'agendas (bab_cal_events) avec les agendas (bab_calendars)
* id_event : identifiant de l'événement
* id_cal : identifiant de l'agenda

=== Table bab_cal_events_reminders ===
contient les rappels d'événements pour les utilisateurs
* id_event : identifiant de l'événement
* id_user : identifiant de l'utilisateur qui veut le rappel
* day : nombre de jours avant l'événement quand le rappel doit se déclencher
* hour : nombre d'heures avant l'événement quand le rappel doit se déclencher
* minute : nombre de minutes avant l'événement quand le rappel doit se déclencher
* bemail : vaut Y si les rappels doivent être envoyés par e-mails (voir options dans config.php), sinon N
* processed : vaut Y si l'utilisateur a demandé à cacher le rappel de sa fenêtre, sinon N par défaut

=== Table bab_cal_public ===
contient les agendas collectifs
* id : identifiant de l'agenda
* name : nom de l'agenda
* description : description de l'agenda
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation

=== Table bab_cal_resources ===
contient les agendas de ressources
* id : identifiant de l'agenda
* name : nom de l'agenda
* description :
* id_dgowner : identifiant de la délégation dans laquelle se trouve l'agenda (0 si dans Tout le site)
* idsa : identifiant du schéma d'approbation
* availability_lock : vaut 1 si on veut empêcher la création d'événements en surbooking, sinon 0.

=== Table bab_cal_user_options ===
contient les options privés des utilisateurs sur l'ensemble des agendas

== Articles ==

=== Table bab_articles ===
contient les articles
* id : identifiant de l'article
* id_topic : identifiant du thème d'articles où se situe l'article
* id_author : identifiant de l'auteur de l'article
* date : date de création de l'article
* date_publication : date de publication de l'article
* date_archiving : date d'archivage de l'article
* date_modification : date de dernière modification de l'article
* title : titre de l'article
* head : introduction de l'article (obligatoire)
* body : corps de l'article
* archive : indique si l'article est une archive. Valeurs possibles : N ou Y
* lang : langue de l'article (fr, en...)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* ordering : entier indiquant l'ordre d'affichage de l'article dans le thème par rapport aux autres articles du thème
* id_modifiedby : identifiant du dernier auteur modificateur
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3

=== Table bab_articles_images ===
contient les images associées aux articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts ===
contient les brouillons d'articles (Rappel : avant d'être soumis ou approuvés, les textes sont des brouillons. Les brouillons se transforment en articles dès qu'ils sont soumis et approuvés)
* id : identifiant du brouillon
* id_author : identifiant de l'auteur du brouillon
* date_creation : date de création du brouillon
* date_modification : date de dernière modification du brouillon
* date_submission : date de soumission du brouillon
* date_publication : date de publication du brouillon
* date_archiving : date d'archivage du brouillon
* title : titre du brouillon
* head : introduction du brouillon (obligatoire)
* body : corps du brouillon
* lang : langue du brouillon (fr, en...)
* trash : indique si le brouillon est dans la corbeille ou pas. Valeurs possibles : N ou Y
* id_topic : identifiant du thème d'articles où se trouve le brouillon (peut être vide)
* restriction : liste d'identifiants de groupes séparés par des virgules (opérateur OU) ou par des & (opérateur ET). C'est la liste des groupes à restreindre pour la lecture de l'article.
* hpage_private : vaut Y si l'article est proposé pour les pages d'accueil privées
* hpage_public : vaut Y si l'article est proposé pour les pages d'accueil publiques
* notify_members : vaut Y l'option 'notifier les lecteurs' est cochée
* idfai : identifiant de l'instance en cours du schéma d'approbation
* result : statut d'approbation (type entier). Valeurs possibles : 0, 1, 2, 3
0 : statut par défaut si pas d'approbation en cours
1 : l'article brouillon est en attente d'approbation
2 : l'article brouillon est approuvé (Remarque : ce statut n'est jamais utilisé car un article brouillon approuvé se transforme en article)
3 : l'article brouillon a été refusé
* id_article : identifiant de l'article si le brouillon est une modification d'un article existant
* id_anonymous : identifiant de l'auteur si l'auteur n'est pas authentifié. C'est l'identifiant d'un enregistrement dans la table BAB_USERS_LOG_TBL.
* approbation : vaut 0, 1 ou 2
* update_datemodif : vaut Y si

=== Table bab_art_drafts_files ===
contient les fichiers joints aux brouillons d'articles
* id :
* id_draft : identifiant de l'article brouillon
* name : nom du fichier (Ex : gaston.jpg)
* description : description du fichier
* ordering : entier indiquant l'ordre d'affichage du fichier par rapport aux autres fichiers joints de l'article brouillon

=== Table bab_art_drafts_images ===
contient les images associées aux brouillons d'articles (on parle bien des images associées et pas des fichiers joints)
* id : identifiant de l'image
* idArticle : identifiant de l'article
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_art_drafts_notes ===
contient les commentaires des approbateurs qui ont refusés les articles brouillons (Pour le publicateur, les commentaires sont affichées en prévisualisation de l'article, depuis la liste des brouillons (lien Publication/onglet Mes Articles si l'article est en cours d'approbation))
* id : identifiant de la note
* id_draft : identifiant de l'article brouillon associé
* content : contenu texte de la note
* id_author : identifiant de l'auteur de la note
* date_note : date de création de la note

=== Table bab_art_drafts_tags ===
contient les tags (fonction Thésaurus) associés à des articles brouillons
* id_draft : identifiant de l'article brouillon
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_art_files ===
contient les fichiers joints des articles
* id : identifiant du fichier joint à l'article
* id_article : identifiant de l'article
* name :
* description : description du fichier joint
* index_status : statut de l'indexation. Valeur entière.
non indexé : 0
indexé : 2
en attente d'être indexé : 3
* ordering : entier indiquant l'ordre d'affichage du fichier joint avec les autres fichiers joints d'un même article

=== Table bab_art_log ===
contient l'historique des modifications d'articles
* id : identifiant de la modification
* id_article : identifiant de l'article
* id_author : identifiant de l'auteur de la modification
* date_log : date et heure de la modification
* action_log : statut de la modification. Valeurs possibles : lock, unlock, commit, refused, accepted.
Lorsqu'on saisit la raison de la modification avant de modifier un article, le statut est lock.
Lorsqu'on soumet un article, le statut est commit. Si l'article ne passe pas par approbation, il y a immédiatement un autre enregistrement avec le statut accepted. commit et accepted sont aussi utilisés lorsqu'on modifie un brouillon puis qu'on soumet.
Lorsqu'on modifie un article et qu'on l'enregistre (on ne le soumet pas), seul un enregistrement est créé : celui avec le statut lock et la raison de la modification.
Il n'y a pas d'enregistrements si on créé un article et qu'il ne doit pas être approuvé.
Lorsqu'on supprime un brouillon, le statut est unlock.
* art_log : description de la modification. Contient le texte saisit comme raison de la modification

=== Table bab_art_tags ===
contient les tags (fonction Thésaurus) associés à des articles
* id_art : identifiant de l'article
* id_tag : identifiant du tag (lié à la table bab_tags)

=== Table bab_comments ===
contient les commentaires des articles
* id : identifiant du commentaire
* id_parent : identifiant du commentaire parent
* id_article : identifiant de l'article associé au commentaire
* id_topic : identifiant du thème d'articles dans lequel est créé l'article
* id_author : auteur du commentaire
* id_last_editor : identifiant du dernier auteur modificateur
* date : date de création du commentaire
* last_update : date de la dernière modification du commentaire
* subject : titre du commentaire
* message : contenu texte du commentaire
* confirmed : Y si le commentaire est approuvé, N sinon
* name : nom de l'auteur du commentaire
* email : email de l'auteur du commentaire
* idfai : identifiant de l'instance du schéma d'approbation utilisé pour ce commentaire
* lang : langue du commentaire (fr, en...)
* article_rating : note attribuée à l'article. Valeurs possibles : 0, 1, 2, 3, 4, 5
0 : l'article n'est pas noté

=== Table bab_topcat_order ===
contient les numéros pour les tris d'affichage des catégories et des thèmes. Attention, sous une catégorie parente, il est possible d'ordonner les sous-catégories avec les sous-thèmes (il y a donc des mélanges d'où la colonne type).
Rappel : une catégorie est un conteneur de sous-catégories ou de thèmes.
* id : identifiant de l'ordre
* id_topcat : identifiant de la catégorie ou du thème que l'on veut ordonner
* type : 1 si l'ordre est définit pour une catégorie d'articles. 2 si l'ordre est défini pour un thème d'articles.
* ordering : entier indiquant l'ordre d'affichage de l'objet par rapport aux autres objets de la catégorie parente (id_parent)
* id_parent : identifiant de la catégorie d'articles parente d'idtopcat. C'est la catégorie dans laquelle on veut ordonner notre objet. Vaut 0 si l'objet qu'on veut trier est une catégorie de premier niveau (pas de catégorie parente).

=== Table bab_topics ===
contient les thèmes d'articles
* id : identifiant du thème
* category : nom du thème
* description : description du thème
* id_cat : identifiant de la catégorie dans laquelle se trouve le thème
* idsaart : identifiant du schéma d'approbation à la création d'articles
* idsacom : identifiant du schéma d'approbation des commentaires
* idsa_update : identifiant du schéma d'approbation à la modification des articles
* notify : Y si les auteurs peuvent notifier les lecteurs par email, N sinon
* lang : langue du thème (fr, en...)
* article_tmpl : nom du modèle d'articles
* display_tmpl : nom du patron d'affichage
* restrict_access : Y si les auteurs peuvent restreindre l'accès aux articles, N sinon
* allow_hpages : Y si on permet aux auteurs de proposer leurs articles pour les pages d'accueil, N sinon
* allow_pubdates : Y si on permet aux auteurs de spécifier des dates de publication, N sinon
* allow_attachments : Y si on permet aux auteurs de joindre des fichiers avec leurs articles, N sinon
* allow_update : entier indiquant si les auteurs peuvent modifier leurs articles. Valeurs possibles : 0, 1, 2
0 : les auteurs ne peuvent pas modifier leurs articles
1 : les auteurs peuvent modifier leurs articles, mais avec approbation
2 : les auteurs peuvent modifier leurs articles et sans approbation
* max_articles : nombre maximum d'articles sur la page des archives
* allow_manupdate : entier indiquant si les gestionnaires peuvent modifier les articles. Valeurs possibles : 0, 1, 2
0 : les gestionnaires ne peuvent pas modifier les articles
1 : les gestionnaires peuvent modifier les articles, mais avec approbation
2 : les gestionnaires peuvent modifier les articles et sans approbation
* auto_approbation : Y si on approuve automatiquement le contributeur dans le cas où il fait partie de la première étape du schéma d'approbation, N sinon
* busetags : Y si on utilise les mots-clés du thésaurus, N sinon
* allow_addImg : Y si on permet aux auteurs d'associer une image à un article
* allow_article_rating : Y si on permet aux auteurs des commentaires de noter les articles, N sinon

=== Table bab_topicscom_groups ===
Table de droits d'accès : groupes pouvant faire des commentaires sur le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsman_groups ===
Table de droits d'accès : groupes gestionnaires du thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsmod_groups ===
Table de droits d'accès : groupes pouvant modifier des articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicssub_groups ===
Table de droits d'accès : groupes pouvant soumettre de nouveaux articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topicsview_groups ===
Table de droist d'accès : groupes pouvant voir les articles dans le thème d'articles
* id :
* id_object :
* id_group :

=== Table bab_topics_categories ===
contient les catégories d'articles (conteneurs des thèmes d'articles)
* id : identifiant de la catégorie
* title : titre de la catégorie
* description : description de la catégorie
* enabled : vaut Y si la section de la catégorie est activée, N sinon
* template : nom du patron de section
* id_dgowner : identifiant de la délégation où se trouve la catégorie, 0 si dans tout le site
* optional : utilisation inconnue !!!
* id_parent : identifiant de la catégorie parente
* display_tmpl : nom du patron d'affichage

=== Table bab_topics_categories_images ===
contient les images associées aux catégories d'articles
* id : identifiant de l'image
* idCategory : identifiant de la catégorie d'articles
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)

=== Table bab_topics_images ===
contient les images associées aux thèmes d'articles
* id : identifiant de l'image
* idTopic : identifiant du thème
* name : nom du fichier image avec son extension (ex : gaston.jpg)
* relativePath : chemin relatif (par rapport au répertoire d'upload) de l'image sans le nom du fichier (ex : articles/DG0/articlesImg/1298/)