Ajouter un module dans HomeLanding - Wiki

Cet article a été mis à jour, vous consultez ici une archive de cet article!

Dernière mise à jour : 01/09/2021 à 08h32

Table des matières

Déclaration de HomeLanding dans le module
Fichiers à ajouter dans HomeLanding
Fichiers à modifier dans HomeLanding
Ajouter un module quand HomeLanding est déjà installé

Cette procédure est applicable à partir de la version 6.0 de PHPBoost
= à faire avant d'installer HomeLanding

Déclaration de HomeLanding dans le module

Cela permet d'ajouter automatiquement le module dans la liste des onglets du menu d'accueil de HomeLanding
/nom_du_module/config.ini
Ajouter

"homelanding"

dans la liste des

features

du module.
Si l'option

features

n'existe pas dans le config.ini du module, il suffit de l'ajouter.

Code TEXT :

features = "homelanding"

Fichiers à ajouter dans HomeLanding

Certains scripts sont à déclarer dans des fichiers séparés, qui sont automatiquement chargés dans le bon fichier de HomeLanding et au bon endroit. Ainsi une éventuelle mise à jour de ce dernier n'impactera pas les modifications apportées pour l'ajout du/des modules.

/additional/

Au choix

ajouter un fichier unique dans chaque sous-dossier et y déclarer tous les modules à ajouter
ajouter un fichier par module à ajouter dans chaque sous-dossier

Les sous-dossiers

/additional/form

Les champs de formulaire pour le module dans la configuration de HomeLanding

/additional/home

Définition et insertion des variables de template d'affichage du module

/additional/init

Déclaration du module dans l'initialisation de HomeLanding

/additional/save

Enregistrement des données du formulaire du module dans la config de HomeLanding

/additional/submit

Enregistrement de l'état des champs du formulaire après validation (champs cachés ou affichés)

/services/modules (si non néomodule)

Déclaration des données à récupérer pour le module et déclaration de son template

/templates/pagecontent (si non néomodule)

Template du module

Fichiers à modifier dans HomeLanding

à re-modifier en cas de mise à jour de HomeLanding

phpboost/HomeLandingConfig.class.php

Déclaration des constantes définissant le module

Code PHP :

// constante du module
const MODULE_NOM_DU_MODULE = 'nom_du_module';
// Si le module possède une limitation d'affichage par catégorie
const MODULE_NOM_DU_MODULE_CATEGORY = 'nom_du_module_category';

lang/[pays]/common.php

Variables de langue nécessaires au module

Code PHP :

// Si le module possède une limitation d'affichage par catégorie
// page position des éléments
$lang['homelanding.module.nom_du_module_category'] = 'Nom_du_module - catégories';
// dans le menu d'accueil
$lang['homelanding.category.nom_du_module_category'] = 'Nom_du_module';

templates/home

Déclaration de l'affichage du module

Code PHP :

# NOM_DU_MODULE #

Ajouter un module quand HomeLanding est déjà installé

Ajouter dans /phpboost/HomeLangingSetup.class.php - fonction publique upgrade()

Code PHP :

if (!isset($modules[HomeLandingConfig::MODULE_NOM_DU_MODULE]))
{
    $new_modules_list = array();
    $module = new HomeLandingModule();
    $module->set_module_id(HomeLandingConfig::MODULE_NOM_DU_MODULE);
    $module->set_phpboost_module_id(HomeLandingConfig::MODULE_NOM_DU_MODULE);
    $module->hide();
    $new_modules_list[] = $module->get_properties();
    foreach ($modules as $module)
    {
        $new_modules_list[] = $module;
    }
    HomeLandingModulesList::save($new_modules_list);
    HomeLandingConfig::save();
}

puis modifier le numéro de version de HomeLanding