Introduction et configuration-Intégrer un bloc dans un module-Tutorials

Intégrer un bloc dans un module

Development 8260

Author

Gregory

Publication

12/17/2020

Update

12/17/2020

Rating: 0.0 (0 vote)

Level

Advanced

Apprenez à intégrer un bloc dans un Module XOOPS.

Ce tutoriel vous expliquera les différentes étapes nécessaires pour que XOOPS puisse utiliser le bloc provenant de votre module.

You do not have access to all of this tutorial.
To access all the pages (), you must be a member of the site.
Registration is therefore compulsory but free!

Introduction et configuration Les fichiers à créer Le fichier de gestion du bloc (.php) Le fichier template (.tpl) Astuce pour afficher les options

XOOPS dispose d'une gestion de blocs.
Chaque module peut donc proposer du contenu qui sera affiché dans un bloc.

Pour que XOOPS détecte votre bloc vous devez commencer par le déclarer dans le fichier de configuration de votre module :

nom-du-module

xoops_version.php

Il faut ajouter le code suivant pour la déclaration du bloc :

 $modversion['blocks'][] = array( 
    'file'        => 'nom-du-module_nom-du-fichier-block-php.php', 
    'name'        => _MI_NOM-DU-MODULE_BLOCK_NOM-DU-BLOCK, 
    'description' => _MI_NOM-DU-MODULE_BLOCK_NOM-DU-BLOCK_DESC, 
    'show_func'   => 'block_nom-du-module_show', 
    'edit_func'   => 'block_nom-du-module_edit', 
    'options'     => 'option-1|option-2|option-3|...', 
    'template'    => 'nom-du-module_nom-du-block.tpl' 
);

'file' => 'nom-du-module_nom-du-fichier-block-php.php',

Permet d'indiquer le nom du fichier php qui va être appelé lors de l'affichage du bloc et de son édition.

'name' => _MI_NOM-DU-MODULE_BLOCK_NOM-DU-BLOCK ,

Permet d'indiquer le nom du bloc.
Il faut déclarer cette constante dans le fichier :

nom-du-module

language

english

modinfo.php

Il faut faire cette opération autant de fois qu'il existe de dossier de langue pour votre module.

'description' => _MI_NOM-DU-MODULE_BLOCK_NOM-DU-BLOCK_DESC,

Permet de donner une description du bloc.
La déclaration de la constante s'effectue de la même façon que pour name.

'show_func' => 'block_nom-du-module_show',

Permet d'indiquer le nom de la fonction qui sera appelée lors de l'affichage du bloc.
La fonction est située dans le fichier php déclaré à la ligne file.

'edit_func' => 'block_nom-du-module_edit',

Permet d'indiquer le nom de la fonction qui sera appelée lors de l'édition du bloc.
La fonction est située dans le fichier php déclaré à la ligne file.

'options' => 'option-1|option-2|option-3|...',

Permet d'indiquer les valeurs par défaut des options du bloc.
Il faut séparer les valeurs par le caractère "|".

'template' => 'nom-du-module_nom-du-block.tpl'

Permet d'indiquer le nom du template qui sera appelé pour afficher les informations issues du fichier php déclaré à la ligne file (fonction 'show_func').