Développement d'un programme de mise à jour : Différence entre versions
(→bab_setUpgradeLogMsg($addon_name, $message, $uid = '')) |
m (→<nowiki>bab_setUpgradeLogMsg($addon_name, $message, $uid = '')</nowiki>) |
||
| Ligne 35 : | Ligne 35 : | ||
Permet d'enregistrer un message personalisé dans le log de mise à jour (table bab_upgrade_messages) | Permet d'enregistrer un message personalisé dans le log de mise à jour (table bab_upgrade_messages) | ||
| + | |||
| + | $uid est un identifiant unique optionnel en chaîne de caractère qui peut être renseigné pour identifier un message. | ||
=== bab_getUpgradeLogMsg($addon_name, $uid) === | === bab_getUpgradeLogMsg($addon_name, $uid) === | ||
Version du 15 janvier 2008 à 10:17
Sommaire
Programme de mise à jour du noyau
lors de chaque mise à jour, la fonction ovidentia_upgrade($version_base,$version_ini) est appelée, il faut qu'elle retourne TRUE pour que la mise à jour soit acceptée.
La fonction se trouve dans le fichier upgrade.php
Programme de mise à jour d'un module
le principe est identique pour les module, la fonction doit être dans le fichier init.php et s'appelle addon_upgrade($version_base,$version_ini) ou addon est le nom du module
Outils à utiliser dans le programme de reprise
Paramètres
- $version_base : le numéro de version stoqué dans la base de donnés
- $version_ini : le numéro de version stoqué dans les fichiers (fichier ini)
lors de la mise à jour, le numéro de version $version_ini est généralement supérieur à $version_base
$babBody->addError($message)
Les messages d'erreur doivent être enregistrés avec la fonction $babBody->addError, il faut ensuite retourner FALSE pour que la mise à jour ne soit pas acceptée
bab_isTable($table)
test l'existence d'une table
bab_isTableField($table, $field)
test l'existence d'un champ de table
bab_setUpgradeLogMsg($addon_name, $message, $uid = '')
Permet d'enregistrer un message personalisé dans le log de mise à jour (table bab_upgrade_messages)
$uid est un identifiant unique optionnel en chaîne de caractère qui peut être renseigné pour identifier un message.
bab_getUpgradeLogMsg($addon_name, $uid)
Permet de récupérer un message enregistré au préalable avec la fonction bab_setUpgradeLogMsg.
Cette fonction permet de vérifier si une tâche à été effectuée ou non.