API de gestion d'un module
Sommaire
- 1 bab_getAddonInfosInstance()
- 2 Les méthodes de bab_addonInfos
- 2.1 getName()
- 2.2 getId()
- 2.3 getTarget()
- 2.4 getUrl()
- 2.5 getRelativePath()
- 2.6 getPhpPath()
- 2.7 getUploadPath()
- 2.8 getTemplatePath()
- 2.9 getImagesPath()
- 2.10 getOvmlPath()
- 2.11 getStylePath()
- 2.12 isValid()
- 2.13 hasAccessControl()
- 2.14 getAddonType()
- 2.15 isDeletable()
- 2.16 isAccessValid()
- 2.17 isInstalled()
- 2.18 isDisabled()
- 2.19 disable()
- 2.20 enable()
- 2.21 getIniVersion()
- 2.22 getDbVersion()
- 2.23 getDescription()
- 2.24 isUpgradable()
- 2.25 getTablesNames()
- 2.26 getImagePath()
- 2.27 upgrade()
- 2.28 delete()
- 2.29 getDependencies()
- 2.30 getDependences()
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
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
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
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
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
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
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
upgrade()
Mise a jour de la base du module
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
getDependences()
Liste des modules qui utilisent le module
