Fichiers spécifiques des modules : Différence entre versions

De OviWiki
Aller à : navigation, rechercher
(→‎Variables du fichier INI)
(→‎addonini.php)
 
(20 révisions intermédiaires par 2 utilisateurs non affichées)
Ligne 6 : Ligne 6 :
  
  
−
=== Sections du fichier INI ===
+
'''<nowiki>
 +
[general]</nowiki>''' : Variables de configuration
  
−
<nowiki>
+
Voir la liste des variables disponibles : [[Variables du fichier addonini]]
−
[general]</nowiki> : Variables de configuration
+
  
−
<nowiki>
 
−
[addons]</nowiki> : dépendances entre les modules
 
  
−
<nowiki>
 
−
[recommendations]</nowiki> : Variables de configuration pour le module mais non bloquante pour l'installation
 
  
−
=== Variables du fichier INI ===
+
'''<nowiki>
 +
[recommendations]</nowiki>''' : Variables de configuration pour le module mais non bloquante pour l'installation
  
 +
Voir la liste des variables disponibles : [[Variables du fichier addonini]]
  
−
{|class="prettytable"
+
 
−
|-
+
'''<nowiki>
−
|| '''Nom de la variable''' || '''Description''' || '''Disponible depuis la version'''
+
[addons]</nowiki>''' : dépendances entre les modules
−
|-
+
 
−
|| name="addonname" || Nom du module || 5.0.0
+
Dans cette section il faut mettre le nom d'un module en nom de variable et le numéro de version minimale en valeur
−
|-
+
 
−
|| version="1.0" || Version du module || 4.0.0
+
Exemple :
−
|-
+
 
−
|| description="" || Description qui s'affiche dans la liste des modules sur la page réservée à l'administrateur || 5.0.0
+
<source lang="php">
−
|-
+
[addons]
−
|| longdesc="" || Description longue || 5.0.0
+
jquery=1.5
−
|-
+
</source>
−
|| db_prefix="gds_" || préfixe utilisé pour le nom des tables dans la base mysql d'Ovidentia (le préfixe sera utilisé lors de la suppression du module) || 5.0.0
+
 
−
|-
+
 
−
|| delete="1" || <nowiki>1|0</nowiki> autoriser la suppression du module (défaut 0) || 5.0.0
+
'''<nowiki>
−
|-
+
[functionalities]</nowiki>''' : dépendances entre les fonctionnalités
−
|| addon_access_control="1" || <nowiki>1|0</nowiki> activer ou désactiver le contrôle d'accès par l'administrateur sur le module (défaut 1) || 6.6.90
+
 
−
|-
+
Dans cette section, il faut mettre le nom d'un fonctionnalité et comme valeur "Available" ou "Recommended", il est nécessaire de mettre le chemin complet de la fonctionnalité dans le nom de la variable.
−
|| ov_version="6.6.0" || Version minimale d'ovidentia pour que le module fonctionne || 5.0.0
+
 
−
|-
+
Exemple :
−
|| php_version="5.0" || Version minimale de php pour que le module fonctionne  || 5.0.0
+
 
−
|-
+
<source lang="php">
−
|| mysql_version="5.0" || Version minimale de mysql pour que le module fonctionne || 5.0.0
+
[functionalities]
−
|-
+
LibFileManagement="Available"
−
|| upload_directory="Available" || Tester si il existe un répertoire d'upload correctement configuré || 6.0.0
+
</source>
−
|-
+
−
|| author="Nom Prénom ( mail@exemple.com )" || Nom de l'auteur et éventuellement son adresse mail || 4.0.0
+
−
|-
+
−
|| mod_expect="Available" || Tester la présence du module expect || 6.6.90
+
−
|-
+
−
|}
+
  
 
==history.txt==
 
==history.txt==
Ligne 56 : Ligne 48 :
 
Ce fichier est optionnel, il permet de saisir l'historique des modifications
 
Ce fichier est optionnel, il permet de saisir l'historique des modifications
  
−
==init.php==
+
== init.php ==
 +
 
 +
Ce fichier contient les fonctions nécessaires pour relier le module au noyau d'Ovidentia. Toutes les fonction sont préfixées par le nom du module (le nom du répertoire)
 +
 
 +
=== addonname_getAdminSectionMenus(&$url, &$text) ===
 +
 
 +
Insérer un lien dans la section administration
 +
 
 +
Cette fonction sera remplacée par l'API du plan de site dans une future version d'Ovidentia
 +
 
 +
Exemple:
 +
<source lang="php">
 +
function newsaddon_getAdminSectionMenus(&$url, &$text)
 +
{
 +
      static $j=0;
 +
      if($j==0)
 +
      {   
 +
      $text = 'News Addon';
 +
      $url = $GLOBALS['babAddonUrl']."admin";
 +
      $j++;
 +
      return true;
 +
      }
 +
      return false;
 +
}
 +
</source>
 +
 
 +
=== addonname_getUserSectionMenus(&$url, &$text) ===
 +
 
 +
Insérer un lien dans la section utilisateur
 +
 
 +
Cette fonction sera remplacée par l'API du plan de site dans une future version d'Ovidentia.
 +
 
 +
Exemple:
 +
<source lang="php">
 +
function newsaddon_getUserSectionMenus(&$url, &$text)
 +
{
 +
      static $j=0;
 +
      if($j==0)
 +
      {   
 +
          $text = 'News Addon';
 +
          $url = $GLOBALS['babAddonUrl']."user";
 +
          $j++;
 +
          return true;
 +
      }
 +
return false;
 +
}
 +
</source>
 +
 
 +
=== addonname_onSectionCreate(&$title, &$content) ===
 +
 
 +
Créer une section
 +
 
 +
=== addonname_searchinfos() ===
 +
 
 +
Insérer une entrée dans le moteur de recherche d'Ovidentia
 +
 
 +
=== addonname_searchresults($q1, $q2, $option, $pos, $nb_result) ===
 +
 
 +
Afficher des résultats lors d'une recherche dans Ovidentia
 +
 
 +
=== addonname_upgrade($version_base,$version_ini) ===
 +
 
 +
* $version_base : Numéro de version dans la table <code>bab_addons</code> d'Ovidentia, la variable contiens une chaîne vide si c'est une nouvelle installation.
 +
* $version_ini : Numéro de version dans le [[Variables du fichier addonini|fichier INI]] du module.
 +
 
 +
Fonction appelée lors de l'installation du module. Elle doit retourner <code>TRUE</code> si la mise à jour c'est effectuée correctement ou <code>FALSE</code> si le module ne doit pas être activé. Uniquement dans le cas ou cette fonction retourne <code>TRUE</code>, le numéro de version du module dans Ovidentia sera mis a jour avec celui du fichier INI du module.
 +
 
 +
Voir l'article : [[Développement d'un programme de mise à jour]]
 +
 
 +
=== addonname_onDeleteAddon() ===
  
−
Ce fichier contiens les fonctions nécessaires pour relier le module au noyau d'Ovidentia
+
Fonction appelée lors de la suppression du module. Si la fonction devra retourner <code>TRUE</code> pour que la suppression puisse s'effectuer.
  
 
==ovml.php==
 
==ovml.php==
  
−
Ce fichier permet d'implémenter des contener OVML spécifiques au module
+
Ce fichier permet d'implémenter des containers OVML spécifiques au module
  
 
Documentation: [[Implémentation de containers OVML dans un module]]
 
Documentation: [[Implémentation de containers OVML dans un module]]

Version actuelle en date du 12 juin 2009 à 08:57


addonini.php

Fichier contenant les paramètres du module


[general] : Variables de configuration

Voir la liste des variables disponibles : Variables du fichier addonini


[recommendations] : Variables de configuration pour le module mais non bloquante pour l'installation

Voir la liste des variables disponibles : Variables du fichier addonini


[addons] : dépendances entre les modules

Dans cette section il faut mettre le nom d'un module en nom de variable et le numéro de version minimale en valeur

Exemple :

<source lang="php"> [addons] jquery=1.5 </source>


[functionalities] : dépendances entre les fonctionnalités

Dans cette section, il faut mettre le nom d'un fonctionnalité et comme valeur "Available" ou "Recommended", il est nécessaire de mettre le chemin complet de la fonctionnalité dans le nom de la variable.

Exemple :

<source lang="php"> [functionalities] LibFileManagement="Available" </source>

history.txt

Ce fichier est optionnel, il permet de saisir l'historique des modifications

init.php

Ce fichier contient les fonctions nécessaires pour relier le module au noyau d'Ovidentia. Toutes les fonction sont préfixées par le nom du module (le nom du répertoire)

addonname_getAdminSectionMenus(&$url, &$text)

Insérer un lien dans la section administration

Cette fonction sera remplacée par l'API du plan de site dans une future version d'Ovidentia

Exemple: <source lang="php"> 

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

</source>

addonname_getUserSectionMenus(&$url, &$text)

Insérer un lien dans la section utilisateur

Cette fonction sera remplacée par l'API du plan de site dans une future version d'Ovidentia.

Exemple: <source lang="php"> 

function newsaddon_getUserSectionMenus(&$url, &$text)
{
     static $j=0;
     if($j==0)
     {    
          $text = 'News Addon';
          $url = $GLOBALS['babAddonUrl']."user";
          $j++;
          return true;
     }
return false;
}

</source>

addonname_onSectionCreate(&$title, &$content)

Créer une section

addonname_searchinfos()

Insérer une entrée dans le moteur de recherche d'Ovidentia

addonname_searchresults($q1, $q2, $option, $pos, $nb_result)

Afficher des résultats lors d'une recherche dans Ovidentia

addonname_upgrade($version_base,$version_ini)

  • $version_base : Numéro de version dans la table bab_addons d'Ovidentia, la variable contiens une chaîne vide si c'est une nouvelle installation.
  • $version_ini : Numéro de version dans le fichier INI du module.

Fonction appelée lors de l'installation du module. Elle doit retourner TRUE si la mise à jour c'est effectuée correctement ou FALSE si le module ne doit pas être activé. Uniquement dans le cas ou cette fonction retourne TRUE, le numéro de version du module dans Ovidentia sera mis a jour avec celui du fichier INI du module.

Voir l'article : Développement d'un programme de mise à jour

addonname_onDeleteAddon()

Fonction appelée lors de la suppression du module. Si la fonction devra retourner TRUE pour que la suppression puisse s'effectuer.

ovml.php

Ce fichier permet d'implémenter des containers OVML spécifiques au module

Documentation: Implémentation de containers OVML dans un module

Récupérée de « https://wiki.ovidentia.fr/index.php?title=Fichiers_spécifiques_des_modules&oldid=4447 »