Fichiers spécifiques des modules
Sommaire
- 1 addonini.php
- 2 history.txt
- 3 init.php
- 3.1 addonname_getAdminSectionMenus(&$url, &$text)
- 3.2 addonname_getUserSectionMenus(&$url, &$text)
- 3.3 addonname_onSectionCreate(&$title, &$content)
- 3.4 addonname_searchinfos()
- 3.5 addonname_searchresults($q1, $q2, $option, $pos, $nb_result)
- 3.6 addonname_upgrade($version_base,$version_ini)
- 3.7 addonname_onDeleteAddon()
- 4 ovml.php
addonini.php
Fichier contenant les paramètres du module
Sections du fichier INI
[general] : Variables de configuration
[addons] : dépendances entre les modules
[recommendations] : Variables de configuration pour le module mais non bloquante pour l'installation
Variables du fichier INI
Ces variables peuvent êtres mises dans la section "general" ou dans la section "recommendations"
| Nom de la variable | Description | Depuis la version |
| name="addonname" | Nom du module | 5.0.0 |
| version="1.0" | Version du module | 4.0.0 |
| description="" | Description qui s'affiche dans la liste des modules sur la page réservée à l'administrateur | 5.0.0 |
| longdesc="" | Description longue | 5.0.0 |
| author="Nom Prénom ( mail@exemple.com )" | Nom de l'auteur et éventuellement son adresse mail | 4.0.0 |
| 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" | 1|0 autoriser la suppression du module (défaut 0) | 5.0.0 |
| addon_access_control="1" | 1|0 activer ou désactiver le contrôle d'accès par l'administrateur sur le module (défaut 1) | 6.6.90 |
| register_globals="Off" | Tester la valeur de la variable register_globals de php | 5.8.7 |
| ov_version="6.6.0" | Version minimale d'ovidentia pour que le module fonctionne | 5.8.1 |
| php_version="5.0" | Version minimale de php pour que le module fonctionne | 5.8.1 |
| mysql_version="5.0" | Version minimale de mysql pour que le module fonctionne | 5.8.7 |
| mysql_character_set_database="latin1" | Vérifier le code de caractère par défaut de mysql au niveau de la base | 6.6.0 |
| mysql_collation_database="latin1_swedish_ci" | Vérifier la collation par défaut de mysql au niveau de la base | 6.6.0 |
| mysql_max_allowed_packet=15M | Vérifier la valeur minimale de la variable max_allowed_packet de mysql | 6.6.0 |
| mysql_sql_mode="Undefined" | Vérifier la variable sql_mode n'est pas définie | 6.6.0 |
| upload_directory="Available" | Tester si il existe un répertoire d'upload correctement configuré | 5.8.7 |
| upload_max_file_size=30M | Vérifier la taille maximale d'un fichier téléchargé vers le serveur | 5.8.7 |
| lang_directory="Available" | Vérifier que le répertoire lang à la racine du site est accessible en écriture | 5.8.7 |
| images_directory="Available" | Vérifier que le répertoire images à la racine du site est accessible en écriture | 5.8.7 |
| mod_expect="Available" | Tester la présence du module expect de php | 6.6.90 |
| mod_mysql="Available" | Tester la présence du module mysql de php | 5.8.7 |
| mod_zlib="Available" | Tester la présence du module zlib de php | 5.8.7 |
| mod_xml="Available" | Tester la présence du module xml de php | 5.8.7 |
| mod_calendar="Available" | Tester la présence du module calendar de php | 5.8.7 |
| mod_ldap="Available" | Tester la présence du module ldap de php | 5.8.7 |
| mod_imap="Available" | Tester la présence du module imap de php | 5.8.7 |
| mod_gd2="Available" | Tester la présence du module gd de php en version 2 minimum | 5.8.7 |
| mod_mcrypt="Available" | Tester la présence du module mcrypt de php | 5.8.7 |
| mod_gettext="Available" | Tester la présence du module gettext de php | 5.8.7 |
| mod_pdf="Available" | Tester la présence du module pdf de php | 5.8.7 |
| mod_ftp="Available" | Tester la présence du module ftp de php | 5.8.7 |
| mod_curl="Available" | Tester la présence du module curl de php | 5.8.7 |
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
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
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)
Fonction appellée lors de l'installation du module.
Voir l'article : Développement d'un programme de mise à jour
addonname_onDeleteAddon()
Fonction appellée lors de la suppression du module
ovml.php
Ce fichier permet d'implémenter des containers OVML spécifiques au module
Documentation: Implémentation de containers OVML dans un module
