API de gestion d'un module : Différence entre versions

De OviWiki
Aller à : navigation, rechercher
(→‎bab_getAddonInfosInstance())
(→‎getTarget())
 
(10 révisions intermédiaires par le même utilisateur non affichées)
Ligne 14 : Ligne 14 :
  
 
Retourne le nom du module
 
Retourne le nom du module
 +
 +
Voir la variable "name" dans le fichier INI : [[Variables du fichier addonini]]
  
 
===getId()===
 
===getId()===
Ligne 23 : Ligne 25 :
 
Retourne le début du paramètre TG
 
Retourne le début du paramètre TG
  
−
exemple addon/159
+
exemple : <code>addon/159</code>
  
 
===getUrl()===
 
===getUrl()===
Ligne 29 : Ligne 31 :
 
Retourne l'url du module
 
Retourne l'url du module
  
−
exemple : index.php?tg=addon/159/
+
exemple : <code>index.php?tg=addon/159/</code>
  
 
===getRelativePath()===
 
===getRelativePath()===
Ligne 58 : Ligne 60 :
  
 
Retourne le chemin vers le répertoire style du module
 
Retourne le chemin vers le répertoire style du module
 +
 +
 +
===getConfigurationUrl()===
 +
 +
Retourne l'url de la page de configuration du module accessible a l'administrateur ou <code>NULL</code> si aucune page spécifique n'a été paramétrée dans le fichier addonini.
 +
  
 
===isValid()===
 
===isValid()===
Ligne 66 : Ligne 74 :
  
 
Permet de tester si des droits d'accès peuvent être appliquées sur le module
 
Permet de tester si des droits d'accès peuvent être appliquées sur le module
 +
 +
Voir la variable "addon_access_control" dans le fichier INI : [[Variables du fichier addonini]]
  
 
===getAddonType()===
 
===getAddonType()===
Ligne 102 : Ligne 112 :
  
 
Retourne la version du module tel que stoquée dans le fichier INI du module
 
Retourne la version du module tel que stoquée dans le fichier INI du module
 +
 +
Voir la variable "version" dans le fichier INI : [[Variables du fichier addonini]]
  
 
===getDbVersion()===
 
===getDbVersion()===
Ligne 110 : Ligne 122 :
  
 
Retourne la description stoquée dans le fichier INI du module
 
Retourne la description stoquée dans le fichier INI du module
 +
 +
Voir la variable "description" dans le fichier INI : [[Variables du fichier addonini]]
  
 
===isUpgradable()===
 
===isUpgradable()===
Ligne 117 : Ligne 131 :
 
===getTablesNames()===
 
===getTablesNames()===
  
−
Retourne un tableau avec la liste des tables utilisées, en fonction de l'attribut db_prefix du fichier INI
+
Retourne un tableau avec la liste des tables utilisées, en fonction de l'attribut db_prefix du fichier INI : [[Variables du fichier addonini]]
  
 
===getImagePath()===
 
===getImagePath()===
Ligne 125 : Ligne 139 :
 
un fichier jpg, png ou gif de résolution 200x150px
 
un fichier jpg, png ou gif de résolution 200x150px
  
 +
Voir la variable "image" dans le fichier INI : [[Variables du fichier addonini]]
 +
 +
 +
===getIconPath()===
 +
 +
retourne le chemin vers une icône associée au module ou icône par défaut si il n'y en a pas de défini.
 +
 +
un fichier jpg, png ou gif de résolution 48x48px
 +
 +
Voir la variable "icon" dans le fichier INI : [[Variables du fichier addonini]]
  
 
===upgrade()===
 
===upgrade()===
Ligne 130 : Ligne 154 :
 
Mise a jour de la base du module
 
Mise a jour de la base du module
  
 +
La méthode lance la fonction de mise à jour du module et retourne <code>TRUE</code> si la mise à jour c'est effectuée correctement ou si le module est déjà à jour et <code>FALSE</code> dans le cas contraire.
 +
 +
 +
Pour plus d'informations sur la fonction de mise à jour [[Fichiers spécifiques des modules#addonname_upgrade($version_base,$version_ini)| voir la documentation]]
  
 
===delete()===
 
===delete()===
Ligne 139 : Ligne 167 :
 
</source>
 
</source>
  
−
en cas d'erreur, la variable $msgerror sera renseignée
+
en cas d'erreur, la variable <code>$msgerror</code> sera renseignée
  
 
===getDependencies()===
 
===getDependencies()===
  
 
Liste des modules utilisés par le module
 
Liste des modules utilisés par le module
 +
 +
La méthode retourne un tableau avec en clef le nom du module et en valeur un booléen qui indique si le lien de dépendance est satisfait ou non
  
 
===getDependences()===
 
===getDependences()===
  
 
Liste des modules qui utilisent le module
 
Liste des modules qui utilisent le module
 +
 +
La méthode retourne un tableau avec en clef le nom du module et en valeur un booléen qui indique si le lien de dépendance est satisfait ou non

Version actuelle en date du 9 juillet 2009 à 08:29

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.

La fonction retourne FALSE si le module n'existe pas dans la table bab_addons du noyau

Les méthodes de bab_addonInfos

getName()

Retourne le nom du module

Voir la variable "name" dans le fichier INI : Variables du fichier addonini

getId()

Retourne l'ID du module tel qu'enregistré dans la table bab_addons

getTarget()

Retourne le début du paramètre TG

exemple : addon/159

getUrl()

Retourne l'url du module

exemple : index.php?tg=addon/159/

getRelativePath()

Retourne le chemin relatif du module par rapport à un emplacement dans Ovidentia : addons/nom_du_module

getPhpPath()

Retourne le chemin vers les fichiers php du module

getUploadPath()

Retourne le chemin vers le répertoire d'upload du module

getTemplatePath()

Retourne le chemin vers le répertoire template du module

getImagesPath()

Retourne le chemin vers le répertoire images du module

getOvmlPath()

Retourne le chemin vers le répertoire ovml du module

getStylePath()

Retourne le chemin vers le répertoire style du module


getConfigurationUrl()

Retourne l'url de la page de configuration du module accessible a l'administrateur ou NULL si aucune page spécifique n'a été paramétrée dans le fichier addonini.


isValid()

Permet de tester tout les paramètres du fichier INI du module

hasAccessControl()

Permet de tester si des droits d'accès peuvent être appliquées sur le module

Voir la variable "addon_access_control" dans le fichier INI : Variables du fichier addonini

getAddonType()

Retourne le type du module en chaîne de caractère :

  • THEME : module contenant une charte graphique pour Ovidentia
  • EXTENSION : module contenant une application venant s'intégrer dans les menus d'Ovidentia
  • LIBRARY : module fournissant des fonctionnalités utilisées par d'autres modules ou le noyau (bibliothèque de fonctions)

isDeletable()

Permet de tester si le module est supprimable

isAccessValid()

Permet de tester si le module est accessible pour l'utilisateur en cours

isInstalled()

Permet de tester si le module est installé ou non

isDisabled()

Permet de tester si le module est désactivé ou non

disable()

Désactiver le module

enable()

Activer le module

getIniVersion()

Retourne la version du module tel que stoquée dans le fichier INI du module

Voir la variable "version" dans le fichier INI : Variables du fichier addonini

getDbVersion()

Retourne la version du module tel que stoquée dans la base de donnés

getDescription()

Retourne la description stoquée dans le fichier INI du module

Voir la variable "description" dans le fichier INI : Variables du fichier addonini

isUpgradable()

Permet de tester si le module doit être mis à jour

getTablesNames()

Retourne un tableau avec la liste des tables utilisées, en fonction de l'attribut db_prefix du fichier INI : Variables du fichier addonini

getImagePath()

retourne le chemin vers une image associée au module ou NULL si il n'y a pas d'image

un fichier jpg, png ou gif de résolution 200x150px

Voir la variable "image" dans le fichier INI : Variables du fichier addonini


getIconPath()

retourne le chemin vers une icône associée au module ou icône par défaut si il n'y en a pas de défini.

un fichier jpg, png ou gif de résolution 48x48px

Voir la variable "icon" dans le fichier INI : Variables du fichier addonini

upgrade()

Mise a jour de la base du module

La méthode lance la fonction de mise à jour du module et retourne TRUE si la mise à jour c'est effectuée correctement ou si le module est déjà à jour et FALSE dans le cas contraire.


Pour plus d'informations sur la fonction de mise à jour voir la documentation

delete()

Supprimer le module

<source lang="php"> $addon->delete(&$msgerror); </source>

en cas d'erreur, la variable $msgerror sera renseignée

getDependencies()

Liste des modules utilisés par le module

La méthode retourne un tableau avec en clef le nom du module et en valeur un booléen qui indique si le lien de dépendance est satisfait ou non

getDependences()

Liste des modules qui utilisent le module

La méthode retourne un tableau avec en clef le nom du module et en valeur un booléen qui indique si le lien de dépendance est satisfait ou non

Récupérée de « https://wiki.ovidentia.fr/index.php?title=API_de_gestion_d%27un_module&oldid=4561 »