API des fonctionnalités - Historique des versions

Jeraiz : /* Introduction */

2009-05-22T09:19:33Z

‎Introduction

Paul le 10 février 2009 à 13:09

2009-02-10T13:09:08Z

Paul : /* Les librairies */

2008-12-08T09:22:56Z

‎Les librairies

Paul le 8 décembre 2008 à 09:21

2008-12-08T09:21:46Z

Paul le 8 décembre 2008 à 08:35

2008-12-08T08:35:03Z

Jeraiz : /* Utiliser une fonctionnalité */

2008-11-06T15:40:41Z

‎Utiliser une fonctionnalité

Paul : /* Proposer des fonctionnalités */

2008-11-05T15:44:46Z

‎Proposer des fonctionnalités

Paul : /* Installation */

2008-11-05T15:42:35Z

‎Installation

Paul : /* Utiliser une fonctionnalité */

2008-11-05T15:41:00Z

‎Utiliser une fonctionnalité

Paul : /* Tester la présence d'une fonctionnalité */

2008-11-05T15:37:12Z

‎Tester la présence d'une fonctionnalité

← Version précédente		Version du 22 mai 2009 à 09:19
Ligne 6 :		Ligne 6 :


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

	== Proposer des librairies ==		== Proposer des librairies ==

@@ Ligne 1 : / Ligne 1 : @@
 [[Catégorie:Développement de modules]]
-'''Cette API est disponible à partir de Ovidentia 6.7.0'''
+{{Information|Cette API est disponible à partir de Ovidentia 6.7.0}}
 == Introduction ==

← Version précédente		Version du 8 décembre 2008 à 09:22
Ligne 162 :		Ligne 162 :
	=== Les librairies ===		=== Les librairies ===

−	Voir la liste des librairies ~~dans~~ la ~~catégorie~~ : [[:Catégorie:Documentation des librairies]].	+	Voir la liste des librairies sur la page : [[:Catégorie:Documentation des librairies]].

@@ Ligne 6 : / Ligne 6 : @@
-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".
+L'API des librairies est utilisée pour partager du code entre différentes parties d'Ovidentia tel que le noyau et les modules. Dans Ovidentia, les librairies 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 ==
+== Proposer des librairies ==
 Chaque fonctionnalité devra être nommée selon un "chemin" unique, par exemple "convertHtml/toPdf/openOffice", les caractères _ sont interdits dans le chemin.
@@ Ligne 21 : / Ligne 21 : @@
 </source>
-Le nom de toutes les classes de fonctionnalité sont préfixées par <code>Func_</code>, dans le nom de la classe, le _ remplace le / , l'objet devra hériter de la classe <code>bab_functionality</code>.
+Le nom de toutes les classes de librairies sont préfixées par <code>Func_</code>, dans le nom de la classe, le _ remplace le / , l'objet devra hériter de la classe <code>bab_functionality</code>.
 === Installation ===
-Au moment de l'installation ou du programme de reprise, il faut enregistrer la fonctionnalité dans ovidentia, exemple :
+Au moment de l'installation ou du programme de reprise, il faut enregistrer l'objet dans Ovidentia, exemple :
 <source lang="php">
@@ Ligne 34 : / Ligne 34 : @@
 </source>
-La méthode register retourne un boolean, la valeur retournée sera false si la fonctionnalité n'a pas pu être enregistrée
+La méthode register retourne un boolean, la valeur retournée sera false si la librairie 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 <code>unregister()</code> permet de désinstaller la fonctionnalité, le fichier de lien sera supprimé de l'arborescence.
+De même, la méthode <code>unregister()</code> permet de désinstaller la librairie, le fichier de lien sera supprimé de l'arborescence.
@@ Ligne 54 : / Ligne 54 : @@
 * bab_eventFunctionalityUnregistered
-=== Héritage de fonctionnalités ===
+=== Héritage des librairies ===
-Il est possible de créer une fonctionnalité qui hérite et utilise l'interface d'une autre fonctionnalité.
+Il est possible de créer un objet qui hérite et utilise l'interface d'une autre librairie.
@@ Ligne 75 : / Ligne 75 : @@
 </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.
+Dans un autre module "convertToPdf", on propose de convertir du html en pdf en utilisant openOffice. Pour que l'objet de librairie soit acceptée par le programme d'installation, l'objet doit hériter de l'objet parent.
@@ Ligne 96 : / Ligne 96 : @@
 </source>
-== Utiliser une fonctionnalité ==
+== Utiliser une librairie ==
 La fonction du noyau <code>bab_functionality::get('convertHtml/toPdf/openOffice');</code> effectuera une inclusion du fichier "convertHtml/toPdf/openOffice/link.inc" ensuite l'objet <code>Func_convertHtml_toPdf_openOffice</code> sera instancié.
@@ Ligne 111 : / Ligne 111 : @@
-==== Obtenir les sous-répertoires d'une fonctionnalité ====
+==== Obtenir les sous-librairies d'un objet ====
 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.
@@ Ligne 141 : / Ligne 141 : @@
-==== inclure le fichier de la functionnalité ====
+==== inclure le fichier de l'objet librairie ====
 inclure le fichier de la fonctionnalité afin d'effectuer un héritage
@@ Ligne 151 : / Ligne 151 : @@
 </source>
-=== Tester la présence d'une fonctionnalité ===
+=== Tester la présence d'une librairie ===
@@ Ligne 157 : / Ligne 157 : @@
 <code>bab_functionality::get()</code> 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.

@@ Ligne 1 : / Ligne 1 : @@
 [[Catégorie:Développement de modules]]
-'''Attention, cette API sera disponible à partir de ovidentia 6.7.0'''
+'''Cette API est disponible à partir de Ovidentia 6.7.0'''
 == Introduction ==

← Version précédente		Version du 6 novembre 2008 à 15:40
Ligne 99 :		Ligne 99 :

	La fonction du noyau <code>bab_functionality::get('convertHtml/toPdf/openOffice');</code> effectuera une inclusion du fichier "convertHtml/toPdf/openOffice/link.inc" ensuite l'objet <code>Func_convertHtml_toPdf_openOffice</code> sera instancié.		La fonction du noyau <code>bab_functionality::get('convertHtml/toPdf/openOffice');</code> effectuera une inclusion du fichier "convertHtml/toPdf/openOffice/link.inc" ensuite l'objet <code>Func_convertHtml_toPdf_openOffice</code> sera instancié.
		+	Si la fonctionnalité n'existe pas, la fonction bab_functionality::get() retournera la valeur false.

	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.		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.

@@ Ligne 38 : / Ligne 38 : @@
 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.
+De même, la méthode <code>unregister()</code> permet de désinstaller la fonctionnalité, le fichier de lien sera supprimé de l'arborescence.
@@ Ligne 49 : / Ligne 49 : @@
-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()'''
+Il existe deux [[API du gestionnaire d'événement|événements]] qui peuvent être utilisés lors de l'appel à <code>bab_functionalities::register()</code> et <code>bab_functionalities::unregister()</code>
 * bab_eventFunctionalityRegistered

@@ Ligne 98 : / Ligne 98 : @@
 == 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é.
+La fonction du noyau <code>bab_functionality::get('convertHtml/toPdf/openOffice');</code> effectuera une inclusion du fichier "convertHtml/toPdf/openOffice/link.inc" ensuite l'objet <code>Func_convertHtml_toPdf_openOffice</code> 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.
+Un formulaire est 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.
+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. Pour pallier à ce problème, il faut utiliser l'[[API de gestion d'un module]]

← Version précédente		Version du 5 novembre 2008 à 15:37
Ligne 153 :		Ligne 153 :


−	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.	+	Dans le fichier [[Fichiers spécifiques des modules#addonini.php\|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.

	<code>bab_functionality::get()</code> 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.		<code>bab_functionality::get()</code> 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.