API des fonctionnalités

2008-10-27T12:48:21Z

Nouaya : /* Introduction */

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

'''Attention, cette API sera disponible à partir de ovidentia 6.7.0'''

== Introduction ==

L'API des fonctionnalités est utilisée pour partager du code entre différentes parties d'Ovidentia tel que le noyau et les modules. Dans Ovidentia, les fonctionnalités sont représentées sous forme d'un arbre visible par les administrateurs dans la page "Modules" sous l'onglet "Fonctionnalités".

== Proposer des fonctionnalités ==

Chaque fonctionnalité devra être nommée selon un "chemin" unique, par exemple "convertHtml/toPdf/openOffice", les caractères _ sont interdits dans le chemin.

Une fonction du noyau d'ovidentia permettra d'enregistrer un fichier php en tant que fonctionnalité, le fichier devra contenir une classe PHP nommée en utilisant la même chemin, par exemple :

<source lang="php">
class Func_ConvertHtml_ToPdf_OpenOffice extends bab_functionality {

}

</source>

Le nom de toutes les classes de fonctionnalité sont préfixées par Func_ le _ remplace le / dans le nom de la classe, l'objet devra hériter de la classe bab_functionality.

=== Installation ===

Au moment de l'installation ou du programme de reprise, il faut enregistrer la fonctionnalité dans ovidentia, exemple :

<source lang="php">
include_once $GLOBALS['babInstallPath'].'utilit/functionalityincl.php';

$func = new bab_functionalities();
$func->register('ConvertHtml/ToPdf/OpenOffice', $GLOBALS['babAddonPhpPath'].'convert.php');
</source>

La méthode register retourne un boolean, la valeur retournée sera false si la fonctionnalité n'a pas pu être enregistrée

Dans Ovidentia, un fichier "link.inc" sera créé dans un arbre de répertoire (sous le répertoire '''fonctionalities''' à la racine du site) avec pour contenu du code php pour inclure le fichier passé en 2ème paramètre.

De même, la méthode '''unregister()''' permet de désinstaller la fonctionnalité, le fichier de lien sera supprimé de l'arborescence.

<source lang="php">
include_once $GLOBALS['babInstallPath'].'utilit/functionalityincl.php';

$func = new bab_functionalities();
$func->unregister('ConvertHtml/ToPdf/OpenOffice');
</source>

Il existe deux [[API du gestionnaire d'événement|événements]] qui peuvent être utilisés lors de l'appel à '''bab_functionalities::register()''' et '''bab_functionalities::unregister()'''

* bab_eventFunctionalityRegistered
* bab_eventFunctionalityUnregistered

=== Héritage de fonctionnalités ===

Il est possible de créer une fonctionnalité qui hérite et utilise l'interface d'une autre fonctionnalité.

exemple : le module "convert" propose une fonctionnalité pour convertir du html

<source lang="php">

class Func_convertHtml extends bab_functionality {
function getDescription() {
return 'convertir du html vers un autre format';
}

function process($html) {
return NULL;
}
}

</source>

Dans un autre module "convertToPdf", on propose de convertir du html en pdf en utilisant openOffice. Pour que la fonctionnalité soit acceptée par le programme d'installation, l'objet hériter de l'objet parent.

<source lang="php">

bab_functionality::includefile('convertHtml');

class Func_ConvertHtml_ToPdf_OpenOffice extends Func_ConvertHtml {
function getDescription() {
return 'convertir du html en pdf';
}

function process($html) {

}
}

</source>

== Utiliser une fonctionnalité ==

La fonction du noyau bab_functionality::get('convertHtml/toPdf/openOffice'); effectuera une inclusion du fichier "convertHtml/toPdf/openOffice/link.inc" ensuite l'objet Func_convertHtml_toPdf_openOffice sera instancié.

Les niveaux supérieurs de l'arborescence seront complétés avec une copie du fichier link.inc si aucun fichier de lien n'est présent.

Un formulaire sera disponible pour d'administrateur afin de changer les fichiers interfaces des niveaux supérieurs pour redéfinir les fonctions par défaut dans le cas de sous-répertoires multiples.

Pour simplifier l'exécution des fonctions d'interface, le contexte du module ne sera pas recréé avant que la fonction soit appelée. Par conséquent, les variables globales de l'environnement du module ne devront pas être utilisées.

=== Fonctions ===

==== Obtenir les sous-répertoires d'une fonctionnalité ====

La liste des sous-fonctionnalités permet de proposer à l'utilisateur un choix, et ensuite effectuer un appel direct à la fonctionnalité en utilisant un chemin plus complet.

<source lang="php">

$array = bab_functionality::getFunctionalities('path');

</source>

==== Obtenir l'instance de l'objet ====

Par défaut, l'objet retourné pour une fonctionnalité est un [http://fr.wikipedia.org/wiki/Singleton_(patron_de_conception) singleton]

<source lang="php">

$singleton = bab_functionality::get('path');

</source>

Il est possible de passer un deuxième paramètre à la methode get() pour que l'instance retournée ne soit pas un singleton

<source lang="php">

$instance = bab_functionality::get('path', false);

</source>

==== inclure le fichier de la functionnalité ====

inclure le fichier de la fonctionnalité afin d'effectuer un héritage

<source lang="php">

bab_functionality::includefile('path');

</source>

=== Tester la présence d'un fonctionnalité ===

Dans le fichier addonini.php d'un module, il est possible de tester la présence d'un fonctionnalité comme un pré-requis, afin d'empêcher l'installation du module si la fonctionnalité n'est pas installée.

bab_functionality::get() retourne false si la fonctionnalité n'est pas trouvée, il est possible d'utiliser cette méthode avec un @ devant l'appel pour ne pas voir le notice déclenché et utiliser uniquement la valeur de retour.

Feuille de route

2008-10-07T14:52:26Z

Nouaya : /* Version 6.8.0 */

== Version 6.7.0 ==

{|class="prettytable" width="100%"
|| '''Description'''
| width="70"| '''État'''
|-
|| Intégration d'une API pour gérer le plan du site dans le noyau || En cours
|-
|| Intégration d'une API pour gérer des fonctionnalités externe (Voir l'article [[Communication entre les modules]]) || Fait
|-
|| Possibilité de tester la présence des fonctionnalités comme des prérequis pour l'installation d'un module ou du noyau || Fait
|-
|| Possibilité d'ajouter un script de prérequis personnalisés pour l'installation d'un module || Fait
|-
|| Controle de disponibilité pour empêcher le surbooking dans les agendas de ressources || Fait
|-
|| Ajout de catégories sur les délégations utilisables dans l'OVML || Fait
|-
|| Ajout du contener OVML OCRecentFaqQuestions || Fait
|-
|| Publication de l'API des articles ( Voir [[API Articles]]) || Fait
|-
|| ajout des types de congés avec les couleurs sur la visualisation d'un congé dans l'agenda || Fait
|-
|| ajout de la gestion des plusieurs périodes d'exclusion dans les droits de congés || Fait
|}

== Version 6.8.0 ==

{|class="prettytable" width="100%"
|| '''Description'''
| width="70"| '''État'''
|-
|| Intégration des skins en tant que modules || En cours
|-
|| Déléguer la saisie de certains champs de l'annuaire à des utilisateurs en utilisant les droits ACL.
Les utilisateurs ayant le droit de mettre à jour l'annuaire continueront à le faire sur tous les champs de l'annuaire.
Les utilisateurs ayant le droit de modification sur certains champs ne pourront pas modifier les autres champs de l'annuaire ( sauf s'ils ont le droit de modification sur l'annuaire ). Un utilisateur qui a le droit de modification sur un champ pourra le faire sur toutes les fiches annuaires des utilisateurs du portail.
|| Fait
|}

== Version 7.0.0 ==

{|class="prettytable" width="100%"
|| '''Description'''
| width="70"| '''État'''
|-
|| Modification de la version minimale requise de PHP (passage à PHP 5.1.0) || A faire
|-
|| Modification de la version minimale requise de MySQL (passage à MySQL 4.1.0) || A faire
|}

Feuille de route

2008-10-03T09:45:30Z

Nouaya : /* Version 6.8.0 */

== Version 6.7.0 ==

{|class="prettytable" width="100%"
|| '''Description'''
| width="70"| '''État'''
|-
|| Intégration d'une API pour gérer le plan du site dans le noyau || En cours
|-
|| Intégration d'une API pour gérer des fonctionnalités externe (Voir l'article [[Communication entre les modules]]) || Fait
|-
|| Possibilité de tester la présence des fonctionnalités comme des prérequis pour l'installation d'un module ou du noyau || Fait
|-
|| Possibilité d'ajouter un script de prérequis personnalisés pour l'installation d'un module || Fait
|-
|| Controle de disponibilité pour empêcher le surbooking dans les agendas de ressources || Fait
|-
|| Ajout de catégories sur les délégations utilisables dans l'OVML || Fait
|-
|| Ajout du contener OVML OCRecentFaqQuestions || Fait
|-
|| Publication de l'API des articles ( Voir [[API Articles]]) || Fait
|-
|| ajout des types de congés avec les couleurs sur la visualisation d'un congé dans l'agenda || Fait
|-
|| ajout de la gestion des plusieurs périodes d'exclusion dans les droits de congés || Fait
|}

== Version 6.8.0 ==

{|class="prettytable" width="100%"
|| '''Description'''
| width="70"| '''État'''
|-
|| Intégration des skins en tant que modules || En cours
|-
|| Déléguer la saisie de certains champs de l'annuaire à des utilisateurs en utilisant les droits ACL.
Les utilisateurs ayant le droit de mettre à jour l'annuaire continueront à le faire sur tous les champs de l'annuaire.
Les utilisateurs ayant le droit de modification sur certains champs ne pourront pas modifier les autres champs de l'annuaire ( sauf s'ils ont le droit de modification sur l'annuaire ). Un utilisateur qui a le droit de modification sur un champ pourra le faire sur toutes les fiches annuaires des utilisateurs du portail.
|| En cours
|}

== Version 7.0.0 ==

{|class="prettytable" width="100%"
|| '''Description'''
| width="70"| '''État'''
|-
|| Modification de la version minimale requise de PHP (passage à PHP 5.1.0) || A faire
|-
|| Modification de la version minimale requise de MySQL (passage à MySQL 4.1.0) || A faire
|}

Feuille de route

2008-03-17T06:31:01Z

Nouaya : /* Version 6.7.0 */

Feuille de route

2008-03-17T06:30:37Z

Nouaya : /* Version 6.7.0 */

API Articles

2008-03-15T08:27:44Z

Nouaya : Nouvelle page : Catégorie:Développement de modules == Introduction == Cette API permet de créer des catégories, des thèmes, des brouillons d'articles et des articles. Son utilisation néc...

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

== Introduction ==
Cette API permet de créer des catégories, des thèmes, des brouillons d'articles et des articles.
Son utilisation nécessite l'inclusion du fichier '''artapi.php''' comme ceci:
:'''require_once $GLOBALS['babInstallPath'].'utilit/artapi.php';'''

===bab_addTopicsCategory()===
Cette fonction permet de créer une catégorie d'articles.
Retourne l'ID de la catégorie créée. Sinon '''false'''.
:'''function bab_addTopicsCategory($name, $description, $benabled, $template, $disptmpl, $topcatid, $dgowner=0)'''
* '''$name''' :
*: Libellé de la catégorie d'articles
* '''$description''' :
*: Description de la catégorie d'articles
* '''$benabled''' :
*: Active ou non ('Y'/'N')
* '''$template''' :
*: Nom du template de la section
* '''$disptmpl''' :
*: Nom du template d'affichage
* '''$topcatid''' :
*: ID de la catégorie d'articles parent
* '''$dgowner''' :
*: ID de la délégation. Par défaut O.

===bab_addTopic()===
Cette fonction permet de créer un thème d'articles.
Retourne l'ID de la catégorie créée. Sinon '''false'''.
:'''bab_addTopic($name, $description, $idCategory, &$error, $topicArr = array())'''
* '''$name''' :
*: Libellé du thème d'articles
* '''$description''' :
*: Description du thème d'articles
* '''$idCategory''' :
*: ID de la catégorie d'articles à laquelle sera attaché le thème
* '''$error''' :
*: Variable passée par référence et, en cas d'erreur, initialisée par le système avec un libellé d'erreur
* '''$topicArr''' :
*: Tableau associatif permettant de spécifier d'autres paramètres pour initialiser le thème
** ''"idsaart"'' :
**: ID du schéma d'approbation des articles. Si pas d'approbation 0. ( Par défaut 0 )
** ''"idsacom"'' :
**: ID du schéma d'approbation des commentaires. Si pas d'approbation 0. ( Par défaut 0 )
** ''"idsa_update"'' :
**: ID du schéma d'approbation de modification des articles. Si pas d'approbation 0. ( Par défaut 0 )
** ''"notify"'' :
**: 'Y' si on souhaite la notification des membres. 'N' sinon. ( Par défaut 'N' )
** ''"lang"'' :
**: Langue de l'article. ( Par défaut la langue courante est utilisée )
** ''"article_tmpl"'' :
**: Template d'article. ( Par défaut aucun )
** ''"display_tmpl"'' :
**: Template d'affichage. ( Par défaut aucun )
** ''"restrict_access"'' :
**: 'Y' si on souhaite activer la restriction d'articles. 'N' sinon. ( Par défaut 'N' )
** ''"allow_hpages"'' :
**: 'Y' si on souhaite permettre aux auteurs de proposer leurs articles pour les pages d'accueil. 'N' sinon. ( Par défaut 'N' )
** ''"allow_pubdates"'' :
**: 'Y' si on souhaite permettre aux auteurs de spécifier une date de publication. 'N' sinon. ( Par défaut 'N' )
** ''"allow_attachments"'' :
**: 'Y' si on souhaite permettre aux auteurs de joindre des documents à leurs articles. 'N' sinon. ( Par défaut 'N' )
** ''"allow_update"'' :
**: 'Y' si on souhaite permettre aux auteurs de modifier leurs articles. 'N' sinon. ( Par défaut 'N' )
** ''"allow_manupdate"'' :
**: 'Y' si on souhaite permettre aux gestionnaires de modifier leurs articles. 'N' sinon. ( Par défaut 'N' )
** ''"max_articles"'' :
**: Nombre d'articles à afficher sur une page.( Par défaut 10 )
** ''"auto_approbation"'' :
**: 'Y' si on souhaite que le système approuve automatiquement les auteurs s'ils font partie du schéma d'approbation. 'N' sinon. ( Par défaut 'N' )
** ''"busetags"'' :
**: 'Y' si on souhaite l'utilisation des mots clés. 'N' sinon. ( Par défaut 'N' )

===bab_addArticleDraft()===
Cette fonction permet de créer un brouillon d'un article.
L'article n'est pas soumis. Pour le soumettre il afut appeler la fonction '''bab_submitArticleDraft()'''
Retourne l'ID du brouillon. Sinon '''0'''.
:'''function bab_addArticleDraft( $title, $head, $body, $idTopic, &$error, $articleArr=array())'''
* '''$title''' :
*: Titre de l'article
* '''$head''' :
*: Introduction de l'article
* '''$body''' :
*: Sujet de l'article
* '''$idTopic''' :
*: ID du thème d'articles auquel appartiendra le brouillon d'article
* '''$error''' :
*: Variable passée par référence et, en cas d'erreur, initialisée par le système avec un libellé d'erreur
* '''$articleArr''' :
*: Tableau associatif permettant de spécifier d'autres paramètres pour initialiser le brouillon
** ''"id_author"'' :
**: ID de l'auteur. ( Par défaut ID de l'utilisateur courant )
** ''"lang"'' :
**: Langue de l'article. ( Par défaut la langue courante est utilisée )
** ''"date_submission"'' :
**: Date de soumission au format '''YYYY-MM-DD HH:MM:SS'''.( Par défaut pas de date )
** ''"date_archiving"'' :
**: Date d'archivage au format '''YYYY-MM-DD HH:MM:SS'''.( Par défaut pas de date )
** ''"date_publication"'' :
**: Date de publication au format '''YYYY-MM-DD HH:MM:SS'''.( Par défaut pas de date )
** ''"hpage_private"'' :
**: 'Y' si on souhaite que l'article sera proposé en page d'accueil privée une fois soumis. 'N' sinon. ( Par défaut 'N' )
** ''"hpage_public"'' :
**: 'Y' si on souhaite que l'article sera proposé en page d'accueil public une fois soumis. 'N' sinon. ( Par défaut 'N' )
** ''"notify_members"'' :
**: 'Y' si on souhaite que les membres soient notifiés une fois l'article publié. 'N' sinon. ( Par défaut 'N' )
** ''"update_datemodif"'' :
**: 'Y' si on souhaite que la date de modification de l'article soit mise à jour. 'N' sinon. ( Par défaut 'N' )

===bab_addArticle()===
Cette fonction permet de créer un article et de le soumettre.
Retourne ''true'' en cas de succès. Sinon ''false''.
:'''function bab_addArticle( $title, $head, $body, $idTopic, &$error, $articleArr=array())'''
* '''$title''' :
*: Titre de l'article
* '''$head''' :
*: Introduction de l'article
* '''$body''' :
*: Sujet de l'article
* '''$idTopic''' :
*: ID du thème d'articles auquel appartiendra l'article
* '''$error''' :
*: Variable passée par référence et, en cas d'erreur, initialisée par le système avec un libellé d'erreur
* '''$articleArr''' :
*: Tableau associatif permettant de spécifier d'autres paramètres pour initialiser l'article
** ''"id_author"'' :
**: ID de l'auteur. ( Par défaut ID de l'utilisateur courant )
** ''"lang"'' :
**: Langue de l'article. ( Par défaut la langue courante est utilisée )
** ''"date_submission"'' :
**: Date de soumission au format '''YYYY-MM-DD HH:MM:SS'''.( Par défaut pas de date )
** ''"date_archiving"'' :
**: Date d'archivage au format '''YYYY-MM-DD HH:MM:SS'''.( Par défaut pas de date )
** ''"date_publication"'' :
**: Date de publication au format '''YYYY-MM-DD HH:MM:SS'''.( Par défaut pas de date )
** ''"hpage_private"'' :
**: 'Y' si on souhaite que l'article sera proposé en page d'accueil privée une fois soumis. 'N' sinon. ( Par défaut 'N' )
** ''"hpage_public"'' :
**: 'Y' si on souhaite que l'article sera proposé en page d'accueil public une fois soumis. 'N' sinon. ( Par défaut 'N' )
** ''"notify_members"'' :
**: 'Y' si on souhaite que les membres soient notifiés une fois l'article publié. 'N' sinon. ( Par défaut 'N' )
** ''"update_datemodif"'' :
**: 'Y' si on souhaite que la date de modification de l'article soit mise à jour. 'N' sinon. ( Par défaut 'N' )

===bab_submitArticleDraft()===
Cette fonction permet de soumettre un article brouillon.
Retourne ''true'' en cas de succès. Sinon ''false''.
:'''function bab_addArticle( $idDraft)'''
* '''$idDraft''' :
*: ID du brouillon d'article

===bab_getTopicTitle()===
Retourne le nom d'un thème d'articles. Si le thème n'existe pas, la fonction retourne une chaîne vide
:'''function bab_getTopicTitle($id)'''
* '''$id''' :
*: ID du thème

===bab_getTopicDescription()===
Retourne la description d'un thème d'articles. Si la catégorie n'existe pas, la fonction retourne une chaîne vide
* '''$id''' :
:'''function bab_getTopicDescription($id)'''
*: ID du thème

===bab_getTopicCategoryTitle()===
Retourne le nom d'une catégorie de thèmes d'articles. Si la catégorie n'existe pas, la fonction retourne une chaîne vide
:'''function bab_getTopicCategoryTitle($id)'''
* '''$id''' :
*: ID de la catégorie d'articles

===bab_getTopicCategoryDescription()===
Retourne la description d'une catégorie de thèmes d'articles. Si la catégorie n'existe pas, la fonction retourne une chaîne vide
:'''function bab_getTopicCategoryDescription($id)'''
* '''$id''' :
*: ID de la catégorie d'articles

===bab_getArticleTitle()===
Retourne le titre d'un article. Si l'article n'existe pas, la fonction retourne une chaîne vide
:'''function bab_getArticleTitle($id)'''
* '''$id''' :
*: ID de l'article

===bab_getArticleDate()===
Retourne la date d'un article. Si l'article n'existe pas, la fonction retourne une chaîne vide
:'''function bab_getArticleDate($id)'''
* '''$id''' :
*: ID de l'article

===bab_getArticleAuthor()===
Retourne le nom complet de l'auteur de l'article. Si l'article n'existe pas, la fonction retourne une chaîne vide.
Si l'auteur est un utilisateur anonyme, la fonction retourne '''Anonymous''' traduit dans la langue courante.
:'''function bab_getArticleAuthor($id)'''
* '''$id''' :
*: ID de l'article

===bab_getCommentTitle()===
Retourne le titre d'un commentaire. Si le commentaire n'existe pas, la fonction retourne une chaîne vide.
:'''function bab_getCommentTitle($id)'''
* '''$id''' :
*: ID du commentaire

Accueil

2008-03-15T07:20:54Z

Nouaya : /* Documentation des API */

Addon tutorial

2008-03-07T13:02:14Z

Nouaya : Nouvelle page : Catégorie:Développement de modules = Introduction = Le but de ce guide est donner une initiation au développement d'un module pour Ovidentia. Il est destiné à des utilisate...

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

= Introduction =
Le but de ce guide est donner une initiation au développement d'un module pour Ovidentia.
Il est destiné à des utilisateurs ayant déjà des connaissances en PHP et des développements de site PHP.
Avant de commencer vérifier que vous avez un serveur web avec le support PHP activé et qu'une version d'OVIDENTIA est installé. Si ce n'est pas fait vous pouvez télécharger une version sur le site communautaire http://www.ovidentia.org/ Ovidentia.org.

= Création d'un nouvel module =
Nous allons, pour le besoin du tutorial, développer un module qui permet de créer des nouvelles et de les afficher sur la page d'accueil.

Une nouvelle est composée d'un titre et d'un texte.

A une nouvelle est associée une date de publication et un auteur, c'est à dire l'utilisateur qui a soumis la nouvelle.

Lorsqu'un utilisateur publie une nouvelle, celle-ci n'est pas immédiatement publiée. Des utilisateurs approbateurs approuvent ou refusent la nouvelle. Si elle est approuvée, elle est publiée. Sinon elle est supprimée.

Le droit d'ajouter des nouvelles sera octroyé uniquement à certains groupes d'utilisateurs.
== Création des répertoires ==
Créer un répertoire ''newsaddon'' dans le répertoire ''ovidentia/addon'' de votre installation d'Ovidentia.

Dans ce répertoire, créer les trois fichiers php suivants:

* addonini.php
* base.php
* init.php

Editer le fichier addonini.php et y insérer le code suivant:
<pre>
<nowiki>;<?php/*</nowiki>
<nowiki>[general]</nowiki>
name="newsaddon"
version=1.0
description="News addon"
delete=1
longdesc="Addon des nouvelles"
db_prefix="newsaddon_"
ov_version="6.7.0"
php_version="4.1.2"
mysql_version="3.23"
author="Your name ( Your compagny )"
<nowiki>*/?></nowiki>
</pre>
Editer le fichier base.php et y insérer le code suivant:
<pre>
<nowiki><?php</nowiki>
exit;
?>
</pre>
Enfin éditer le fichier init.php et insérer dedans le code suivant:
<pre>
<nowiki><?php</nowiki>
require_once 'base.php';
function newsaddon_getAdminSectionMenus(&$url, &$text)
{
return false;
}

function newsaddon_getUserSectionMenus(&$url, &$text)
{
return false;
}

function newsaddon_onSectionCreate(&$title, &$content)
{
return false;
}

function newsaddon_upgrade($version_base,$version_ini)
{
return true;
}

function newsaddon_onDeleteAddon()
{
return true;
}
?>
</pre>

A ce stade vous avez un module fonctionnel mais qui n'affiche rien et ne fait aucun traitement particulier.

Nous détaillerons le contenu des fichiers créés plus tard. Pour le moment nous allons voir comment administrer, supprimer ou télécharger notre nouveau module.

== Administration du module ==
En tant qu'administrateur du site, à partir de la section «''''' Administration '''''», cliquez sur le menu «''''' Modules '''''».

Le système affiche la liste des modules présents.

On remarque que dans la liste figure notre nouveau module «''''' newsaddon '''''».

Cette interface vous permet de gérer les modules. En particulier, elle permet:

* De donner les droits sur le module
* De télécharger le module
* De supprimer le module
* Installer le module

'''Droits sur le module'''

Cliquez sur le lien « Droits » pour désigner le ou les groupes des utilisateurs qui peuvent utiliser le module.

Nous verrons plus tard comment le module peut surcharger ces droits pour restreindre l'accès à des sous groupes.

Pour notre exemple, donnez le droit à tous les utilisateurs enregistrés en utilisant le formulaire ACL ( Access Control Level ) affiché.

'''Télécharger le module'''

Si vous souhaitez créer un ZIP de votre module pour le fournir à vos clients ou pour l'installer sur un autre site Ovidentia, cliquer sur l'image sous forme de disquette.

Le système créé une archive ZIP du nom de l'addon et du numéro de version.

Dans notre exemple, le système proposera de télécharger l'archive « '''''newsaddon-1-0.zip''''' »

'''Supprimer le module'''

Si vous souhaitez supprimer le module, cliquer sur l'icône de suppression.

Le système vous demandera de confirmer la suppression.

'''ATTENTION''': avant de procéder à la suppression, sauvegardez votre module en téléchargeant l'archive comme indiqué ci dessus.

'''Installer le module'''

Pour installer un module, cliquez sur le lien «''''' Déposer '''''» et charger l'archive.

Une fois l'archive installée, cliquez sur l'icône de mise à jour pour procéder à l'installation définitive.

== Description des fichiers ==
'''Fichier addonini.php'''

Le fichier addonini.php est un fichier de configuration et contient les rubriques suivantes:

{| class="prettytable"
| <center>'''Entrée'''</center>
| <center>'''Description'''</center>

|-
| name
| Nom du module

|-
| version
| La version du module

|-
| description
| Description courte du module

|-
| delete
| 1 : si on souhaite autoriser la suppression du module

0: sinon

|-
| longdesc
| Description longue du module

|-
| db_prefix
| Le préfix utilisé pour les tables MySQL du module. Lors de la suppression du module, OVIDENTIA supprimera également de la base de données les tables dont le nom commencent par ce préfixe.

|-
| ov_version
| Version minimale requise d'Ovidentia

|-
| php_version
| Version requise de PHP

|-
| mysql_version
| Version requise de la base de données MySQL

|-
| author
| Auteur du module

|}

'''Fichier base.php'''

Ce fichier sert de sécurité et empêche l'accès direct au module sans passer par le noyau Ovidentia.

Il contient qu'une seule instruction :

exit;

'''Fichier init.php'''

Tout module doit contenir ce fichier.

La fonction suivante ajoute une entrée dans la section «''' Administrateur '''»:
<pre>
function xxx_getAdminSectionMenus(&$url, &$text)
{
return false;
}
</pre>

( xxx est le nom du module )

Si votre module a besoin d'un menu dans la section « Administration » pour permettre aux administrateurs de le configurer, Ovidentia vous donne une chance d'insérer ce menu par l'intermédiaire de cette fonction. Votre module doit initialiser les paramètres passés par références $url ( URL du menu ) et $text ( texte à afficher pour le menu ).

Cette fonction retourne ''false'' si le module n'a pas d'entrée à jouter et retourne ''true'' si le module veut ajouter une entrée.

Exemple:
<pre>
function newsaddon_getAdminSectionMenus(&$url, &$text)
{
static $j=0;
if($j==0)
{
$text = 'News Addon';
<nowiki>$url = $GLOBALS['babAddonUrl']."admin";</nowiki>
$j++;
return true;
}
return false;
}
</pre>

Editez le fichier init.php et modifier la fonction comme ci-dessus.

Rafraîchissez la page et vous verrez qu'une entrée est venue s'ajouter à la section «''' Administration '''»

'''ATTENTION''': Cette fonction et les suivantes ne doivent pas générer d'affichage sur la page Web ( affichage de formulaire ou autre ) et doivent retourner assez rapidement à l'appelant.

De la même manière vous pouvez ajouter un menu dans la section «''' Utilisateur '''». Pour cela utilisez la fonction:
<pre>
function xxx_getUserSectionMenus(&$url, &$text)
{
return false;
}
</pre>
Dans notre exemple ceci donne:
<pre>
function newsaddon_getUserSectionMenus(&$url, &$text)
{
static $j=0;
if($j==0)
{
$text = 'News Addon';
<nowiki>$url = $GLOBALS['babAddonUrl']."user";</nowiki>
$j++;
return true;
}
return false;
}
</pre>

Si vous rafraîchissez la page du navigateur, vous verrez qu'une entrée est venue s'ajouter à la section «''' Utilisateur'''»

Si vous cliquez sur ces liens, le navigateur affichera des erreurs PHP parce que les fichiers admin.php et user.php n'existent pas. Pour éviter ces erreurs, créer deux fichiers user.php et admin.php dans le même répertoire que celui où se trouve le fichier init.php:

admin.php:
<pre>
<nowiki><?php</nowiki>
require_once 'base.php';
?>
</pre>

user.php:
<pre>
<nowiki><?php</nowiki>
require_once 'base.php';
?>
</pre>
Des fois le module a besoin de créer une section comme les sections «''' Administrateur '''» ou «''' Utilisateur '''» afin de regrouper tous les menus dont il a besoin. C'est là que la fonction suivante vient en aide:
<pre>
function newsaddon_onSectionCreate(&$title, &$content)
{
return false;
}
</pre>
Cette fonction retourne '''''false''''' si le module ne créé pas de section et '''''true''''' dans le cas contraire.

Dans ce cas le module initialise la variable '''''$title''''' avec le titre de la section et la variable '''''$content''''' avec le contenu de la section.

La fonction:
<pre>
function newsaddon_onDeleteAddon()
{
return true;
}
</pre>
est appelée quand Ovidentia est sur le point de supprimer le module. Cette fonction permet au module de procéder à des nettoyages du système ( suppression de fichiers, répertoires temporaires ... créés par le module ).

Enfin la fonction:
<pre>
function newsaddon_upgrade($version_base,$version_ini)
{
return true;
}
</pre>

est appelée par Ovidentia lors d'une mise à jour de votre module.

Le premier paramètre est la version actuelle du module et le deuxième paramètre est la version définie dans le fichier addonini.php.

( Pour plus de détails, au sujet de cette fonction, voir [[Développement d'un programme de mise à jour]])

== Les variables du modules ==
Ovidentia met à la disposition de chaque module des variables pour faciliter leur implémentation. Il s'agit par exemple de l'url d'accès au module, du nom du module, des répertoires d'installation du module etc ...

Ovidentia identifie chaque module par son nom et lui attribut un ID unique.

Par exemple dans notre cas le module s'appelle '''newsaddon''' et son '''ID''' est 1 ( peut être différent sur votre installation ). Dans ce cas les variables disponibles à notre module sont:

{| class="prettytable"
| <center>'''Variable'''</center>
| <center>'''Description'''</center>

|-
| $babAddonUrl
| L'url d'accès au module

[http://localhost/index.php?tg=addon/2/ http://localhost/index.php?tg=addon/1/]

|-
| $babAddonPhpPath
| Chemin vers les fichiers PHP

« ovidentia/adons/newsaddon »

|-
| $babAddonTarget
| Utilisé dans les formulaires comme action du tag « form »

« addon/1 »

|-
| $babAddonHtmlPath
| Chemin vers les fichiers templates ( voir ci dessous )

addons/newsaddon/

|-
| $babAddonFolder
| Nom du répertoire du module

newsaddon

|-
| $babAddonUpload
| Chemin du répertoire de stockage du module

$babUploadPath.'addons/newsaddon'

|}

== Les variables globales d'Ovidentia ==
Ovidentia met à la disposition des modules certaines variables utiles:

{| class="prettytable"
| <center>'''Variable'''</center>
| <center>'''Description'''</center>

|-
| $BAB_SESS_LOGGED
| Cette variable permet au module de savoir si l'utilisateur courant est authentifié ( ''true'' ) ou c'est un utilisateur anonyme ( ''false'' )

|-
| $BAB_SESS_USER
| Contient le nom complet de l'utilisateur courant.

Vide si l'utilisateur est anonyme

|-
| $BAB_SESS_NICKNAME
| Contient l'identifiant de l'utilisateur courant.

Vide si l'utilisateur est anonyme

|-
| $BAB_SESS_USERID
| Contient l'ID de l'utilisateur courant.

Vide si l'utilisateur est anonyme

|-
| $BAB_SESS_EMAIL
| Contient l'adresse email de l'utilisateur courant.

Vide si l'utilisateur est anonyme

|-
| $babInstallPath
| Contient le chemin du répertoire où le noyau Ovidentia est installé.

Le chemin est relatif au répertoire racine du site.

|-
| $babSkin
| Contient le nom du skin courant

|-
| $babSkinPath
| Contient le chemin du répertoire du skin

$babInstallPath."skins/".$babSkin."/"

|-
| $babCssPath
| Chemin vers le répertoire du CSS

“skins/".$babSkin."/styles/name of file choosen by user.css".

|-
| $babScriptPath
| Chemin du répertoire des scripts

$babInstallPath."scripts/"

|-
| $babLanguage
| Le langage courant

|-
| $babStyle
| Nom du fichier CSS utilisé avec l'extension css

|-
| $babSiteName
| Nom du site tel que configuré dans le fichier config.php

|-
| $babUrl
| URL d'accès au site

[http://localhost/ http://localhost]

|-
| $babDB
| Une instance de la classe de gestion de la base de données

|-
| $babBody
| Une instance de la classe de gestion de la page Ovidentia

|}

== Gestion des langues ==
Si vous avez besoin de gérer plusieurs langues pour votre module, vous devez utilisez la fonction:

bab_translate($str, $addonname)

où $str est la chaîne à traduire et $addonname le nom de votre module.

Dans notre exemple, on utilisera la fonction comme ceci:

<nowiki>bab_translate($str, $GLOBALS['babAddonFolder']);</nowiki>

De plus il est nécessaire de créer un répertoire du nom de votre module sous le répertoire « lang/addons » de votre installation.

Pour chaque langue créer un fichier « lang-xx.xml » où xx est la langue.

Dans notre cas on créera le fichier lang-fr.xml pour gérer les traductions en français. Le contenu de ce fichier est structuré comme suit:
<pre>
<nowiki><fr></nowiki>
<nowiki><string id="Interpretation">Interprétation</string></nowiki>
<nowiki><string id="Display the result in popup">Afficher le résultat en popup</string></nowiki>
<nowiki><string id="Result:">Résultat :</string></nowiki>
<nowiki><string id="Help">Aide</string></nowiki>
<nowiki></fr></nowiki>
</pre>
== Gestion des erreurs ==
Pour afficher un message d'erreur à destination de l'utilisateur, Ovidentia met à la disposition des modules la fonction:
<pre>
$babBody->addError($message);
</pre>
L'appel à cette fonction avec un message affiche ce dernier en rouge pour attirer l'attention de l'utilisateur.

Par exemple editer le fichier user.php et insérer le code suivant:
<pre>
<nowiki><?php</nowiki>
require_once 'base.php';
$babBody->addError('Ceci est un avertissement !');
?>
</pre>
En cliquant sur le menu de la section « Utilisateur », le système affiche le message d'erreur.

Essayez maintenant ceci:
<pre>
<nowiki><?php</nowiki>
require_once 'base.php';
$babBody->addError('Ceci est un avertissement !');
echo 'ceci est un texte';
?>
</pre>
Que remarque-t-on? Le texte est affiché tout en haut de la page et non pas en dessous de l'avertissement !

Afin d'afficher correctement des données, utilisez la fonction:
<pre>
$babBody->babEcho($str);
</pre>
Editez le fichier user.php et modifiez le comme ceci:

<nowiki><?php</nowiki>
require_once 'base.php';
$babBody->addError('Ceci est un avertissement !');
$babBody->babEcho( 'ceci est un texte' );
?>

Maintenant le texte est bien affiché en dessous de l'avertissement.

= Module de nouvelles =

== Base de données ==
Nous allons stocker nos nouvelles dans la base de données avec un schéma comme celui-ci:

{| class="prettytable"
| <center>'''Champ'''</center>
| <center>'''Type'''</center>
| <center>'''Null?'''</center>
| <center>'''Notes'''</center>

|-
| id
| Integer
| Non
| Primary key, Autoincrement

|-
| news_title
| Varchar(255)
| Non
|

|-
| news_body
| Text
| Non
|

|-
| news_datetime
| Datetime
| Non
|

|-
| news_author
| Integer
| Oui
|

|}

En utilisant phpMyAdmin, créer une table en utilisant la requête suivante:

CREATE TABLE `newsaddon_news` (
`id` INT( 11 ) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY ,
`news_title` VARCHAR( 255 ) NOT NULL ,
`news_body` TEXT NOT NULL ,
`news_datetime` DATETIME NOT NULL ,
`news_author` int(11) unsigned NOT NULL default '0'
)

Pour que votre module puisse créer cette table lors de son installation, vous devez éditer le fichier init.php et modifier la fonction '''upgrade()''' comme ceci:

function newsaddon_upgrade($version_base,$version_ini)
{
global $babDB;
if ( !bab_isTable("newsaddon_news"))
{
$res = $babDB->db_query("
CREATE TABLE `newsaddon_news` (
`id` INT( 11 ) UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY ,
`news_title` VARCHAR( 255 ) NOT NULL ,
`news_body` TEXT NOT NULL ,
`news_datetime` DATETIME NOT NULL ,
`news_author` int(11) unsigned NOT NULL default '0'
)");
}
return true;
}

La variable globale '''''$babDB''''' permet d'accéder à l'objet gérant la base de données.

La fonction''''' bab_isTable()''''' permet de vérifier si la table n'existe pas déjà dans la base de données ( voir [[Développement d'un programme de mise à jour]] )

== Formulaire de création d'une nouvelle ==
Pour permettre à l'utilisateur de créer une nouvelle, il nous faut créer :

* un menu pour accéder à cette fonctionnalité
* un formulaire de création

'''Création du menu'''

Éditez le fichier user.php et modifier comme suit:

<nowiki><?php </nowiki>
require_once "base.php";
<nowiki>$babBody->addItemMenu("add", bab_translate("Add", $GLOBALS["babAddonFolder"]),$GLOBALS["babAddonUrl"]."user&idx=add"); </nowiki>
?>

La fonction

function addItemMenu($id, $txt, $url, $enabled=true)

permet d'ajouter une entrée dans le menu de la page d'OVIDENTIA. Cette fonction prend comme paramètres :

{| class="prettytable"
| <center>'''Paramètres'''</center>
| <center>'''Description'''</center>

|-
| $id
| Est un identifiant de l'entrée du menu

|-
| $txt
| Texte à afficher dans l'entrée du men

|-
| $url
| URL du lien

|-
| $enabled
| Si '''''true''''' l'entrée est active.

'''''false''''' si on souhaite que l'entrée soit désactivée

|}

Sauvegarder et tester votre module.

On voit bien que le menu contient maintenant une entrée «''' Ajouter '''» et si vous cliquer dessus rien ne se passe. C'est normal, l'action n'est pas gérée.

'''Ajout d'un titre'''

Pour ajouter un titre, modifiez le fichier user.php comme suit:

<nowiki><?php </nowiki>
require_once "base.php";
<nowiki>$babBody->title = bab_translate("Add new", $GLOBALS['babAddonFolder']);</nowiki>
<nowiki>$babBody->addItemMenu("add", bab_translate("Add", $GLOBALS["babAddonFolder"]),$GLOBALS["babAddonUrl"]."user&idx=add"); </nowiki>
?>

'''Création du formulaire d'ajout d'une nouvelle'''

La création du formulaire consiste en la création d'un fichier HTML contenant le template du formulaire et du code PHP pour afficher ce template.

En premier créer un répertoire ''newsaddon ''sous le répertoire ''ovidentia/skins/ovidentia/templates/addons'' et ajoutez y le fichier ''user.html''. Enfin éditez ce dernier et insérer le code suivant:

<nowiki> </nowiki>
<nowiki><form name="newsadd" method="post" action="{ babPhpSelf }"> </nowiki>
<nowiki><input type="hidden" name="tg" value="{ babAddonTarget }/user" > </nowiki>
<nowiki><table align="center" border="0" cellpadding="2" cellspacing="0" width="50%"> </nowiki>
<nowiki><tbody> </nowiki>
<nowiki><tr> </nowiki>
<nowiki><td class="BabLoginCadreBackground" align="center" valign="middle"> </nowiki>
<nowiki><table align="center" border="0" cellpadding="5" cellspacing="0" width="100%"> </nowiki>
<nowiki><tbody> </nowiki>
<nowiki><tr> </nowiki>
<nowiki><td class="BabLoginMenuBackground" align="right" nowrap="nowrap" valign="middle">{ titlelabel }:</td> </nowiki>
<nowiki><td class="BabLoginMenuBackground" valign="middle"> </nowiki>
<nowiki><input name="newstitle" size="50" maxlength="255" value="" type="text"> </nowiki>
<nowiki></td> </nowiki>
<nowiki></tr> </nowiki>
<nowiki><tr> </nowiki>
<nowiki><td class="BabLoginMenuBackground" align="right" valign="middle">{ bodylabel }:</td> </nowiki>
<nowiki><td class="BabLoginMenuBackground" valign="middle"> </nowiki>
<nowiki><textarea name="newsbody" cols="50" rows="10"></textarea> </nowiki>
<nowiki></td> </nowiki>
<nowiki></tr> </nowiki>
<nowiki><tr> </nowiki>
<nowiki><td class="BabLoginMenuBackground" nowrap="nowrap"> </td> </nowiki>
<nowiki><td class="BabLoginMenuBackground" valign="middle"> </nowiki>
<nowiki><input name="baddnews" value="{ addlabel }" type="submit"> </nowiki>
<nowiki><br> </nowiki>
<nowiki></td> </nowiki>
<nowiki></tr> </nowiki>
<nowiki></tbody></table> </nowiki>
<nowiki></td> </nowiki>
<nowiki></tr> </nowiki>
<nowiki></tbody></table> </nowiki>
<nowiki></form> </nowiki>
<nowiki></nowiki>

Un fichier template contient du code HTML et peut contenir plusieurs templates. Chaque template commence par :

<nowiki> </nowiki>

et se termine par

<nowiki> </nowiki>

où xxxxxx est le nom du template.

Les variables d'un template sont toujours sous la forme

{ myvariable }

Le nom de la variable et du template ne doivent pas contenir d'espace.

Pour afficher ce template, vous devez créer une classe PHP, l'instancier et appeler la fonction:

bab_printTemplate($class, $file, $template);

où:

* $class est l'instance de la classe PHP qui contient les variables du template
* $file est le nom du fichier qui contient le template
* $template est le nom du template.

'''Affichage du formulaire'''

Maintenant que notre template est créé nous allons écrire le code PHP pour l'afficher. Pour cela éditez le fichier user.php et modifiez le comme suit:
<pre>
<nowiki><?php</nowiki>
require_once 'base.php';

function displayAddNewsForm()
{
global $babBody;

class displayAddNewsFormClass
{
function displayAddNewsFormClass()
{
<nowiki>$this->bodylabel = bab_translate("Body", $GLOBALS['babAddonFolder']);</nowiki>
<nowiki>$this->titlelabel = bab_translate("Title", $GLOBALS['babAddonFolder']);</nowiki>
<nowiki>$this->addlabel = bab_translate("Add", $GLOBALS['babAddonFolder']);</nowiki>
}

}

$obj= new displayAddNewsFormClass();
<nowiki>$babBody->babecho( bab_printTemplate($obj,$GLOBALS['babAddonHtmlPath']."user.html", "newsaddform"));</nowiki>
}

<nowiki>$babBody->addItemMenu("add", bab_translate("Add", $GLOBALS['babAddonFolder']), $GLOBALS['babAddonUrl']."user&idx=add");</nowiki>
displayAddNewsForm();
?>
</pre>

Sauvegardez et testez votre module. En cliquant sur le lien de la section «''' Utilisateur '''», le module affiche le formulaire de création d'un nouvelle.

'''Enregistrement de la nouvelle'''

Il faut sauvegarder la nouvelle dans la base de données. Pour cela modifier le fichier '''user.php''' comme suit:

<nowiki><?php</nowiki>
require_once 'base.php';

function displayAddNewsForm()
{
global $babBody;
class displayAddNewsFormClass
{
function displayAddNewsFormClass()
{
<nowiki>$this->bodylabel = bab_translate("Body", $GLOBALS['babAddonFolder']);</nowiki>
<nowiki>$this->titlelabel = bab_translate("Title", $GLOBALS['babAddonFolder']);</nowiki>
<nowiki>$this->addlabel = bab_translate("Add", $GLOBALS['babAddonFolder']);</nowiki>
}
}

$obj= new displayAddNewsFormClass();
<nowiki>$babBody->babecho( bab_printTemplate($obj,$GLOBALS['babAddonHtmlPath']."user.html", "newsaddform"));</nowiki>
}

function recordNews()
{
global $babBody, $babDB;
<nowiki>if( !empty($_POST['newstitle']) && !empty($_POST['newsbody']) )</nowiki>
{
<nowiki>$babDB->db_query("insert into newsaddon_news (news_title, news_body, news_datetime, news_author) values ('".$babDB->db_escape_string($_POST['newstitle'])."','".$babDB->db_escape_string($_POST['newsbody'])."',now(),'".$GLOBALS['BAB_SESS_USERID']."')");</nowiki>
}
else
{
<nowiki>$babBody->addError(bab_translate("All fields are required!", $GLOBALS['babAddonFolder']));</nowiki>
}
}

<nowiki>if( isset($_POST['baddnews']))</nowiki>
{
recordNews();
}

<nowiki>$babBody->title = bab_translate("Add new", $GLOBALS['babAddonFolder']);</nowiki>
<nowiki>$babBody->addItemMenu("add", bab_translate("Add", $GLOBALS['babAddonFolder']), $GLOBALS['babAddonUrl']."user&idx=add");</nowiki>
displayAddNewsForm();
?>

Maintenant les utilisateurs peuvent ajouter autant de nouvelles qu'ils le souhaitent. EN utilisant phpMyAdmin, vous pouvez le vérifier en affichant le contenu de la table '''''newsaddon_news'''''.

Peut être souhaitez-vous restreindre la création des nouvelles uniquement à certains groupes d'Ovidentia au lieu de laisser l'ensemble des utilisateurs le faire. Dans ce cas il faut utiliser les ACL ( Access Control List ) pour donner le droit de création uniquement à certains groupes.

'''Droits de création de nouvelle'''

Tout d'abord nous allons créer une table dans la base de données pour stocker ces droits. En utilisant phpMyAdmin, créer la table en utilisant la requête suivante:

CREATE TABLE newsaddon_newsadd_groups (
id int(11) unsigned NOT NULL auto_increment,
id_object int(11) unsigned DEFAULT '0' NOT NULL,
id_group int(11) unsigned DEFAULT '0' NOT NULL,
PRIMARY KEY (id));

où:

{| class="prettytable"
| <center>'''Champ'''</center>
| <center>'''Type'''</center>
| <center>'''Null?'''</center>
| <center>'''Notes'''</center>

|-
| id
| Integer
| Non
| Primary key, Autoincrement

|-
| id_object
| Integer
| Non
|

|-
| id_group
| Integer
| Non
|

|}

Afin qu'Ovidentia puisse gérer les droits à votre place, il est nécessaire de respecter le noms des champs et de nommer votre table xxxx_groups.

Le champ id_object sert à Ovidentia pour stocker l'ID de l'objet sur lequel vous souhaitez gérer des droits. Par exemple, ça peut être l'ID de toute donnée stockée dans la base de données.

Les autres champs sont gérés complètement par Ovidentia.

Dans notre cas, nous souhaitons gérer les droits sur la création des nouvelles. Ce n'est pas un objet de la base de données et nous n'avons donc pas d'ID. Pas de problème, nous allons définir un ID nous même pour cette fonctionnalité, par exemple 1000. Vous pouvez choisir un tout autre nombre.

Editez le fichier admin.php et modifiez le comme ci-dessous:

<nowiki><?php</nowiki>
require_once 'base.php';
include_once $babInstallPath."admin/acl.php";

<nowiki>if( isset($_POST['updateaccess']))</nowiki>
{
maclGroups();
<nowiki>$babBody->addError( bab_translate("Update done", $GLOBALS['babAddonFolder']));</nowiki>
}

<nowiki>$macl = new macl($GLOBALS['babAddonTarget']."/admin", 'idx_value', 1000, 'updateaccess');</nowiki>
<nowiki>$macl->addtable( 'newsaddon_newsadd_groups',bab_translate("Who can add news?", $GLOBALS['babAddonFolder']));</nowiki>
$macl->filter(0,0,1,1,1);
$macl->babecho();
?>

La classe '''''macl''''' prend en charge, à la place de votre module, la gestion des droits de l'affichage, au choix des groupes jusqu'à l'enregistrement dans la base de données.

A cette classe nous avons passé l'ID 1000 que nous avons choisi précédement et la variable ''''''updateaccess'''''' qui nous sera retournée dans le tableau $_POST une fois le formulaire des droits soumis.

Pour de plus de détails sur l'utilisation des ACL consultez la rubrique [[Access Control List]]

Maintenant que les droits sont octroyés pour la création des nouvelles, modifions le fichier user.php afin qu'il vérifie si l'utilisateur a ou non le droit de créer une nouvelle. Pour cela on affichera le menu « Ajouter » que si l'utilisateur a le droit d'ajouter une nouvelle:

...

<nowiki>if( isset($_POST['baddnews']))</nowiki>
{
recordNews();
}

if( bab_isAccessValid('newsaddon_newsadd_groups', 1000))
{
<nowiki>$babBody->title = bab_translate("Add new", $GLOBALS['babAddonFolder']);</nowiki>
<nowiki>$babBody->addItemMenu("add", bab_translate("Add", $GLOBALS['babAddonFolder']), $GLOBALS['babAddonUrl']."user&idx=add");</nowiki>
displayAddNewsForm();
}

La fonction bab_isAccessValid() permet de vérifier les droits d'accès de l'utilisateur courant en utilisant une table des droits et l'ID d'un objet:

bab_isAccessValid($table, $ID)

Mais ce n'est pas suffisant, il faudrait que lors de l'enregistrement de la nouvelle dans la base de données, on vérifie que l'utilisateur qui a soumis le formulaire de création est un utilisateur autorisé. Modifiez la fonction recordNews() comme ceci:

function recordNews()
{
global $babBody, $babDB;
if( bab_isAccessValid('newsaddon_newsadd_groups', 1000))
{
<nowiki>if( !empty($_POST['newstitle']) && !empty($_POST['newsbody']) )</nowiki>
{
<nowiki>$babDB->db_query("insert into newsaddon_news (news_title, news_body, news_datetime, news_author) values ('".$babDB->db_escape_string($_POST['newstitle'])."','".$babDB->db_escape_string($_POST['newsbody'])."',now(),'".$GLOBALS['BAB_SESS_USERID']."')");</nowiki>
}
else
{
<nowiki>$babBody->addError(bab_translate("All fields are required!", $GLOBALS['babAddonFolder']));</nowiki>
}
}
else
{
<nowiki>$babBody->addError(bab_translate("You don't have rights to add news!", $GLOBALS['babAddonFolder']));</nowiki>
}
}

== Affichage de la liste des nouvelles ==
Afin d'afficher la liste des nouvelles, nous allons modifier le fichier user.php pour y intégrer une nouvelle entrée '''Liste''' au menu. Lorsque l'utilisateur clique sur le lien de la section '''Utilisateur''' on affichera la page contenant la liste des nouvelles et s'il est autorisé à créer des nouvelles, il aura une autre entrée dans le menu pour le faire.
<pre>
...
if( isset($_POST['baddnews']))
{
recordNews();
}

$idx = bab_rp('idx', 'list');

switch($idx)
{
case 'add':
$babBody->addItemMenu("list", bab_translate("List", $GLOBALS['babAddonFolder']), $GLOBALS['babAddonUrl']."user&idx=list");
if( bab_isAccessValid('newsaddon_newsadd_groups', 1000))
{
$babBody->title = bab_translate("Add new", $GLOBALS['babAddonFolder']);
$babBody->addItemMenu("add", bab_translate("Add", $GLOBALS['babAddonFolder']), $GLOBALS['babAddonUrl']."user&idx=add");
displayAddNewsForm();
}
break;
case 'list':
default:
$babBody->addItemMenu("list", bab_translate("List", $GLOBALS['babAddonFolder']), $GLOBALS['babAddonUrl']."user&idx=list");
if( bab_isAccessValid('newsaddon_newsadd_groups', 1000))
{
$babBody->addItemMenu("add", bab_translate("Add", $GLOBALS['babAddonFolder']), $GLOBALS['babAddonUrl']."user&idx=add");
}
break;
}

$babBody->setCurrentItemMenu($idx);
?>
</pre>

La fonction '''bab_rp()''' permet de récupérer les variables des tableaux $_GET et $_POST ( voir [[Règles de codage]] )

En fonction de la valeur de la variable $idx on accède soit à la liste des nouvelles ('''''list''''') soit au formulaire de création d'une nouvelle ( '''''add''''' ).

La fonction '''setCurrentItemMenu()''' permet de désactiver l'entrée courante du menu.

'''Création du template de la liste'''

Editez le fichier user.html et insérer à la fin le code HTML suivant:
<pre>

<table align="center" border="0" cellpadding="2" cellspacing="0" width="95%">
<tbody><tr>
<td align="center" valign="middle">
<table align="center" border="0" cellpadding="5" cellspacing="0" width="100%">
<tbody><tr>
<td class="BabSiteAdminTitleFontBackground" nowrap="nowrap" valign="middle" width="30%">{ titlelabel }</td>
<td class="BabSiteAdminTitleFontBackground" valign="middle">{ bodylabel }</td>
</tr>
<tr>
<td nowrap="nowrap" valign="middle"></td>
<td valign="middle"></td>
</tr>
</tbody></table>
</td>
</tr>
</tbody></table>

</pre>

'''Affichage de la liste'''

Et modifiez le fichier '''user.php''' pour inclure la fonction qui affiche ce template:
<pre>
...
case 'list':
default:
$babBody->addItemMenu("list", bab_translate("List", $GLOBALS['babAddonFolder']), $GLOBALS['babAddonUrl']."user&idx=list");
displayListNews();
if( bab_isAccessValid('newsaddon_newsadd_groups', 1000))
...
</pre>

et ajouter l'implémentation de la fonction '''displayListNews()''':
<pre>
function displayListNews()
{
global $babBody;
class displayListNewsFormClass
{
function displayListNewsFormClass()
{
$this->bodylabel = bab_translate("Body", $GLOBALS['babAddonFolder']);
$this->titlelabel = bab_translate("Title", $GLOBALS['babAddonFolder']);
}
}
$obj= new displayListNewsFormClass();
$babBody->babecho( bab_printTemplate($obj,$GLOBALS['babAddonHtmlPath']."user.html", "newslist"));
}
</pre>

Si vous testez votre module, vous remarquez que pour le moment on affiche un tableau vide. Pour afficher la liste des nouvelles il faut interroger la base de données pour avoir la liste et les afficher en utilisant le template. C'est ce que nous allons faire.

Tout d'abord, on va récupérer la liste des nouvelles de la base de données.
Modifier la fonction '''displayListNewsForm()''' comme suit:
<pre>
function displayListNews()
{
global $babBody;
class displayListNewsFormClass
{
function displayListNewsFormClass()
{
global $babDB;
$this->bodylabel = bab_translate("Body", $GLOBALS['babAddonFolder']);
$this->titlelabel = bab_translate("Title", $GLOBALS['babAddonFolder']);

$this->res = $babDB->db_query("select * from newsaddon_news");
$this->count = $babDB->db_num_rows($this->res);
}

function nextrow()
{
global $babDB;
static $k=0;
if( $k < $this->count)
{
$arr = $babDB->db_fetch_array($this->res);
$this->newstitle = $arr['news_title'];
$this->newsbody = $arr['news_body'];
$k++;
return true;
}
else
{
return false;
}
}
}
$obj= new displayListNewsFormClass();
$babBody->babecho( bab_printTemplate($obj,$GLOBALS['babAddonHtmlPath']."user.html", "newslist"));
}</pre>

et le template ainsi:

<pre>

<table align="center" border="0" cellpadding="2" cellspacing="0" width="95%">
<tbody><tr>
<td align="center" valign="middle">
<table align="center" border="0" cellpadding="5" cellspacing="0" width="100%">
<tbody><tr>
<td class="BabSiteAdminTitleFontBackground" nowrap="nowrap" valign="middle" width="30%">{ titlelabel }</td>
<td class="BabSiteAdminTitleFontBackground" valign="middle">{ bodylabel }</td>
</tr>

<tr>
<td nowrap="nowrap" valign="middle">{ newstitle }</td>
<td valign="middle">{ newsbody }</td>
</tr>

</tbody></table>
</td>
</tr>
</tbody></table>

</pre>

Vous remarquez que pour afficher les nouvelles, on fait appel, dans le template, à la forme:
<pre>

...

</pre>

Le moteur de template d'Ovidentia fait appel à la fonction '''nextrow()''' définie dans la classe et affiche ce qu'il y'a entre ces deux tags tant que cette fonction retourne ''true''. La fonction '''nextrow()''' à son tour parcoure le résultat de la requête SQL et initialise les variables.

Enregistrer les modifications et tester le module.

Maintenant qu'on a affiché la liste des nouvelles, on va modifier l'affichage afin d'utiliser une couleur de fond pour alterner les nouvelles.
Pour cela, éditez d'abord le fichier des templates '''user.html''' et modifiez le comme suit:
<pre>

<table align="center" border="0" cellpadding="2" cellspacing="0" width="95%">
<tbody><tr>
<td align="center" valign="middle">
<table align="center" border="0" cellpadding="5" cellspacing="0" width="100%">
<tbody><tr>
<td class="BabSiteAdminTitleFontBackground" nowrap="nowrap" valign="middle" width="30%">{ titlelabel }</td>
<td class="BabSiteAdminTitleFontBackground" valign="middle">{ bodylabel }</td>
</tr>


<tr bgcolor="red">

<tr>


<td nowrap="nowrap" valign="middle">{ newstitle }</td>
<td valign="middle">{ newsbody }</td>
</tr>

</tbody></table>
</td>
</tr>
</tbody></table>

</pre>

La structure :
<pre>

...

...

</pre>

permet d'afficher une partie de template selon la valeur d'une variable, ici '''bred'''.
Cette variable doit être initialisée dans le contructeur à '''''true''''' et doit changer d'état à chaque affichage d'une nouvelle:

<pre>
...// dans le constructeur
$this->bred = true;
...
...

// dans la fonction nextrow()
$this->bred = !$this->bred;

</pre>

==Utilisation des schémas d'approbation==
[EN COURS DE REDACTION]

==Utilisation de l'OVML==
[EN COURS DE REDACTION]

2008-02-26T07:35:29Z

Nouaya : /* Les fonctions d'Ovidentia */

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

== Introduction ==

Un module d'Ovidentia est une archive qui peut être distribuée et qui améliore les fonctionnalités du portail. Les méthodes de développement utilisées dans les modules sont les mêmes que celles du noyau ; de ce fait, les modules utilisent les fonctions disponibles dans le noyau (moteur de templates, gestion des droits ...)

Les templates d'Ovidentia représentent l'outil qui permet de séparer le code PHP du code HTML ; la gestion des skins d'ovidentia est basée sur ce principe. Les modules sont généralement développés en utilisant cette technologie.

Ce document est un guide qui fourni au développeur toutes les étapes nécessaires à la construction d'un module basique. Le lecteur doit être familiarisé au préalable avec les notions de développement PHP, HTML et CSS.

== Structure du module ==

Pour créer un module, il faut créer les répertoires nécessaires dans l'arborescence d'Ovidentia en utilisant un nom unique pour le module. Pour connaître la disposition des répertoires autorisés dans un module, consultez la page [[Structure des répertoires d'un module]]

Dans le répertoire contenant les fichiers php (programs), il existe des fichiers avec des noms imposés :

* [[Fichiers spécifiques des modules#addonini.php|addonini.php]]
* [[Fichiers spécifiques des modules#ovml.php|ovml.php]]
* [[Fichiers spécifiques des modules#history.txt|history.txt]]
* [[Fichiers spécifiques des modules#init.php|init.php]]

== Gestion de la base de données ==

Le lien avec le serveur de base de données MySQL se fait au travers d'un objet php '''bab_database'''.Le client '''mysql''' de php n'est pas utilisé directement. Cet objet propose quelques fonctions supplémentaires décrites dans la documentation ci-dessous :

* [[Documentation de l'objet bab_database]]

== Les fonctions d'Ovidentia ==

Les fonctions disponibles pour les modules se trouvent dans les fichiers utilit/addonapi.php. Consulter [[API noyau/module]].
Les fonctions des autres fichiers, qui ne sont pas spécifiées dans ce wiki comme disponibles pour les modules, ne doivent pas être utilisées. Elles sont sujettes à modification ou suppression dans les futures versions d'Ovidentia.

== Les variables globales ==

Lors du développement dans le contexte d'un module, certaines variables globales peuvent êtres utilisées.

* [[Liste des variables globales pour les modules]]

== Templates ==

Le moteur de template est une fonction qui permet la fusion d'un fichier HTML avec des balises spécifiques dit "template" avec un object php.

* [[Exemple d'utilisation de la fonction bab_printTemplate()]]
* [[Syntaxe des templates]]
* [[Nouveau moteur de templates]]

== Droits d'accès ==

Les modules peuvent utiliser l'interface ACL qui est visible dans les fonctions de base d'Ovidentia. Cela permet d'assigner des droits d'accès à un élément en fonction des groupes d'utilisateurs du portail.

* Voir la documentation : [[Access Control List]]

== Utiliser des fonctions avancées d'Ovidentia ==

=== Le gestionnaire d'événements ===

Le gestionnaire d'événements est un outil qui permet de s'enregistrer lors de l'installation du module afin d'être notifié de l'exécution de certaines actions ou à l'inverse, prévenir d'autres modules.

* [[API du gestionnaire d'événement]]
* [[Communication entre les modules]] (Technologie à l'étude)

=== Proposer un service OVML ===

L'implémentation de conteneurs OVML dans un module qui permet de proposer sur la page d'accueil du portail la possibilité d'afficher les derniers éléments publiés dans le module.

* [[Implémentation de containers OVML dans un module]]

=== Envoyer des e-mails ===

Pour envoyer des emails de notification en utilisant la configuration du portail, il faut inclure le fichier de la fonction email d'Ovidentia avec cette syntaxe :

include_once $babInstallPath."utilit/mailincl.php";

Ensuite, la fonction bab_mail() permet d'obtenir une instance de l'objet nécessaire à l'envoi des e-mails.