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

De OviWiki
Aller à : navigation, rechercher
m (→‎addonini.php)
(→‎addonini.php)
 
(6 révisions intermédiaires par un autre utilisateur non affichées)
Ligne 6 : Ligne 6 :
  
  
−
<nowiki>
+
'''<nowiki>
−
[general]</nowiki> : Variables de configuration
+
[general]</nowiki>''' : Variables de configuration
  
 
Voir la liste des variables disponibles : [[Variables du fichier addonini]]
 
Voir la liste des variables disponibles : [[Variables du fichier addonini]]
Ligne 13 : Ligne 13 :
  
  
−
<nowiki>
+
'''<nowiki>
−
[recommendations]</nowiki> : Variables de configuration pour le module mais non bloquante pour l'installation
+
[recommendations]</nowiki>''' : Variables de configuration pour le module mais non bloquante pour l'installation
  
 
Voir la liste des variables disponibles : [[Variables du fichier addonini]]
 
Voir la liste des variables disponibles : [[Variables du fichier addonini]]
  
  
−
<nowiki>
+
'''<nowiki>
−
[addons]</nowiki> : dépendances entre les modules
+
[addons]</nowiki>''' : 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
 
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 :
  
−
<nowiki>
+
<source lang="php">
−
[functionalities]</nowiki> : dépendances entre les fonctionalités
+
[addons]
 +
jquery=1.5
 +
</source>
 +
 
 +
 
 +
'''<nowiki>
 +
[functionalities]</nowiki>''' : 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.
 
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==
 
==history.txt==
Ligne 43 : Ligne 57 :
  
 
Cette fonction sera remplacée par l'API du plan de site dans une future version d'Ovidentia
 
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) ===
 
=== addonname_getUserSectionMenus(&$url, &$text) ===
Ligne 48 : Ligne 78 :
 
Insérer un lien dans la section utilisateur
 
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
+
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) ===
 
=== addonname_onSectionCreate(&$title, &$content) ===
Ligne 64 : Ligne 110 :
 
=== addonname_upgrade($version_base,$version_ini) ===
 
=== addonname_upgrade($version_base,$version_ini) ===
  
−
Fonction appellée lors de l'installation du module.
+
* $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]]
 
Voir l'article : [[Développement d'un programme de mise à jour]]
Ligne 70 : Ligne 119 :
 
=== addonname_onDeleteAddon() ===
 
=== addonname_onDeleteAddon() ===
  
−
Fonction appellée lors de la suppression du module
+
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==

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 »