Wiki

Ajouter un module dans HomeLanding

Sun, 12 Mar 2023 10:55:28 +0100

PHP

HTML

CSS

Cette procédure est applicable à partir de la version de PHPBoost

Pour la simplification du tutoriel, les exemples de scripts et noms des fichiers sont définis pour un module nommé Blog, il faudra donc adapter le nom et les requêtes à ceux du module ajouté.

Deux procédures d'ajout

Ajouter le module avant l'instalation de HomeLanding
Il sera ajouté et disponible dans la liste des modules compatibles dès l'installation de HomeLanding.

Ajouter le module après l'installation de HomeLanding
Il sera détecté automatiquement et une nouvelle page

Ajouter des éléments

apparait dans la configuration de HomeLanding, permettant d'ajouter le module dans la liste des modules compatibles.

Fichiers à ajouter dans HomeLanding

À quelques exceptions près, les scripts du module à ajouter 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 HomeLanding n'impactera pas les modifications apportées.
Pour les scripts ajoutés dans les sous-dossiers de

/HomeLanding/additional/

, la récupération des scripts se fait par une reconnaissance de présence de fichiers. Le nom de ces fichiers est arbitraire, seul compte leur contenu selon leur emplacement. Ainsi on pourra ajouter au choix

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

Déclaration de la compatibilité du module avec HomeLanding

Cela permet

d'ajouter automatiquement le module dans la liste des onglets du menu d'accueil
d'ajouter automatiquement le module dans la liste des onglets du menu de configuration
au module d'être détecté automatiquement comme nouveau module compatible s'il est installé après HomeLanding

Config.ini du module
Dans le fichier

/blog/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"

À ce stade, placez vous sur la page

Panneau de configuration
Modules
Page d'accueil
Configuration

Dans le menu du haut, cliquez sur

Ajouter des éléments

. Une fois sur cette page, passez aux étapes suivantes SANS VALIDER.

L'ajout des fichiers va rendre la page configuration inaccessible, d'où l'utilité de se rendre sur la page d'ajout, avant. Si vous êtes amenés à en sortir, vous pouvez la rejoindre avec l'adresse

/HomeLanding/admin/add

/HomeLanding/?url=/admin/add/

selon l'état de votre

url_rewriting

!! IMPORTANT !!

La suite de cette procédure prévoit l'affichage du contenu du module sans distinction de catégorie.
Pour ajouter un module qui permettra d'afficher séparément le contenu de ses catégories, il faut utiliser les scripts de l'exemple donné sur cette annexe

Déclaration du module dans l'initialisation de la liste des modules compatibles

/HomeLanding/additional/add/
Cette déclaration est nécessaire uniquement si le module HomeLanding est déjà installé.
Créer un fichier

/HomeLanding/additional/add/AdditionalAdd.php

Code PHP :


$module = new HomeLandingModule();
$module->set_module_id(HomeLandingBlog::MODULE_BLOG);
$module->set_phpboost_module_id(HomeLandingBlog::MODULE_BLOG);
$module->hide();
$modules[] = $module->get_properties();
?>

/HomeLanding/additional/init/
Cette déclaration est nécessaire si le module HomeLanding n'est pas déjà installé, ou s'il est amené à être réinstallé.
Créer un fichier

/HomeLanding/additional/add/AdditionalInit.php

Code PHP :


$module = new HomeLandingModule();
$module->set_module_id(HomeLandingBlog::MODULE_BLOG);
$module->set_phpboost_module_id(HomeLandingBlog::MODULE_BLOG);
$module->hide();
$modules[] = $module->get_properties();
?>

Formulaire pour le module

/HomeLanding/additional/form/
Les champs de formulaire pour le module dans la configuration de HomeLanding
Créer le fichier

/HomeLanding/additional/form/AdditionalForm.php

Code PHP :


if ($this->modules[HomeLandingBlog::MODULE_BLOG]->is_active())
    {
        $fieldset_blog = new FormFieldsetMultitabsHTML('admin_blog', $this->lang['homelanding.module.display'] . ModulesManager::get_module($this->modules[HomeLandingBlog::MODULE_BLOG]->get_module_id())->get_configuration()->get_name(),
            array('css_class' => 'tabs tabs-animation')
        );
        $form->add_fieldset($fieldset_blog);
        $fieldset_blog->add_field(new FormFieldCheckbox('blog_enabled', $this->lang['homelanding.show.full.module'], $this->modules[HomeLandingBlog::MODULE_BLOG]->is_displayed(),
            array(
                'class'=> 'custom-checkbox',
                'events' => array('click' => '
                    if (HTMLForms.getField("blog_enabled").getValue()) {
                        HTMLForms.getField("blog_limit").enable();
                    } else {
                        HTMLForms.getField("blog_limit").disable();
                    }'
                )
            )
        ));
        $fieldset_blog->add_field(new FormFieldNumberEditor('blog_limit', $this->lang['homelanding.items.number'], $this->modules[HomeLandingBlog::MODULE_BLOG]->get_elements_number_displayed(),
            array(
                'min' => 1, 'max' => 100,
                'hidden' => !$this->modules[HomeLandingBlog::MODULE_BLOG]->is_displayed()
            ),
            array(new FormFieldConstraintIntegerRange(1, 100))
        ));
}
?>

/HomeLanding/additional/save/
La sauvegarde des choix effectués dans le formulaire
Créer le fichier

/HomeLanding/additional/save/AdditionalSave.php

Code PHP :


if ($this->modules[HomeLandingBlog::MODULE_BLOG]->is_active())
    {
        if ($this->form->get_value('blog_enabled'))
        {
            $this->modules[HomeLandingBlog::MODULE_BLOG]->display();
            $this->modules[HomeLandingBlog::MODULE_BLOG]->set_elements_number_displayed($this->form->get_value('blog_limit'));
        }
        else
            $this->modules[HomeLandingBlog::MODULE_BLOG]->hide();
}
?>

/HomeLanding/additional/submit/
L'état d'affichage des champs après validation du formulaire.
Créer le fichier

/HomeLanding/additional/submit/AdditionalSubmit.php

Code PHP :


if ($this->modules[HomeLandingBlog::MODULE_BLOG]->is_active())
            {
                $this->form->get_field_by_id('blog_limit')->set_hidden(!$this->modules[HomeLandingBlog::MODULE_BLOG]->is_displayed());
}
?>

Récupération de données et templates

Deux cas de module sont possibles :

le module est un module "core" = module construit sur le tronc commun du "cœur" de PHPBoost mis en place depuis la version 6.0 (Actualités, Articles, Pages, Sondages).
le module est un module "base" = module construit sur la "base" originelle de construction d'un module.

Dans les deux cas il faut ajouter la variable d'affichage de template dans le template principal de HomeLanding :
/HomeLanding/templates/home.tpl
Si une mise à jour de PHPBoost ou du module Page d'accueil implique ce fichier, il faudra à nouveau reproduire cette modification
Chercher

// Additional modules

A la suite, ajouter

Code TPL :

# INCLUDE  BLOG #

Les modules "core"

/HomeLanding/additional/home/
Déclaration de la variable d'affichage du module
Créer un fichier

/HomeLanding/additional/home/AdditionalHome.php

Code PHP :


if ($this->modules[HomeLandingBlog::MODULE_BLOG]->is_displayed() && CategoriesAuthorizationsService::check_authorizations(Category::ROOT_CATEGORY, HomeLandingBlog::MODULE_BLOG)->read())
            $this->view->put('BLOG', HomeLandingDisplayItems::build_view(HomeLandingBlog::MODULE_BLOG));
?>

Les modules "base"

/HomeLanding/services/modules/
Récupération des données et déclaration du template du module
Créer le fichier

/HomeLanding/services/modules/HomeLandingBlog.class.php

Code PHP :


class HomeLandingBlog
{
const MODULE_BLOG = "blog";
public static function get_blog_view()
    {
        $now = new Date();
        $module_config = BlogConfig::load();
        $home_config   = HomeLandingConfig::load();
        $modules       = HomeLandingModulesList::load();
        $module_name   = self::MODULE_BLOG;
        $theme_id = AppContext::get_current_user()->get_theme();
        if (file_exists(PATH_TO_ROOT . '/templates/' . $theme_id . '/modules/HomeLanding/pagecontent/' . $module_name . '.tpl'))
            $view = new FileTemplate('/templates/' . $theme_id . '/modules/HomeLanding/pagecontent/' . $module_name . '.tpl');
        elseif (file_exists(PATH_TO_ROOT . '/HomeLanding/templates/pagecontent/' . $module_name . '.tpl'))
            $view = new FileTemplate('/HomeLanding/templates/pagecontent/' . $module_name . '.tpl');
        else
            $view = new FileTemplate('HomeLanding/pagecontent/items.tpl');
        $home_lang = LangLoader::get_module_langs('HomeLanding');
        $module_lang = LangLoader::get_module_langs($module_name);
        $view->add_lang(array_merge(LangLoader::get_all_langs(), $home_lang, $module_lang));
        $authorized_categories = CategoriesService::get_authorized_categories(Category::ROOT_CATEGORY, $module_config->is_summary_displayed_to_guests(), $module_name);
        $result = PersistenceContext::get_querier()->select('SELECT blog.*, member.*, cat.rewrited_name AS rewrited_name_cat
        FROM ' . PREFIX . 'blog blog
        LEFT JOIN ' . PREFIX . 'blog_cats cat ON cat.id = blog.id_category
        LEFT JOIN ' . DB_TABLE_MEMBER . ' member ON member.user_id = blog.author_user_id
        WHERE (published = 1 OR (published = 2 AND publishing_start_date < :timestamp_now AND (publishing_end_date > :timestamp_now OR publishing_end_date = 0))) AND id_category IN :authorized_categories
        ORDER BY blog.update_date DESC
        LIMIT :blog_limit', array(
            'authorized_categories' => $authorized_categories,
            'user_id' => AppContext::get_current_user()->get_id(),
            'timestamp_now' => $now->get_timestamp(),
            'blog_limit' => $modules[$module_name]->get_elements_number_displayed()
        ));
        $view->put_all(array(
            'C_NO_ITEM'       => $result->get_rows_count() == 0,
            'C_VIEWS_NUMBER'  => true,
            'C_GRID_VIEW'     => $module_config->get_display_type() == BlogConfig::GRID_VIEW,
            'C_TABLE_VIEW'    => $module_config->get_display_type() == BlogConfig::TABLE_VIEW,
            'MODULE_NAME'     => $module_name,
            'MODULE_POSITION' => $home_config->get_module_position_by_id($module_name),
            'ITEMS_PER_ROW'   => $module_config->get_items_per_row(),
            'L_MODULE_TITLE'  => ModulesManager::get_module($module_name)->get_configuration()->get_name(),
        ));
        while ($row = $result->fetch())
        {
            $item = new BlogItem();
            $item->set_properties($row);
            $view->assign_block_vars('items', array_merge($item->get_array_tpl_vars(), array(
                'C_SEVERAL_VIEWS' => $item->get_views_number() > 1,
            )));
        }
        $result->dispose();
        return $view;
    }
}
?>

/HomeLanding/additional/home/
Déclaration de la variable d'affichage du module dans le template principal de HomeLanding
Créer un fichier

/HomeLanding/additional/home/AdditionalHome.php

Code PHP :


if ($this->modules[HomeLandingBlog::MODULE_BLOG]->is_displayed() && CategoriesAuthorizationsService::check_authorizations(Category::ROOT_CATEGORY, HomeLandingBlog::MODULE_BLOG)->read())
            $this->view->put('BLOG', HomeLandingBlog::get_blog_view(HomeLandingBlog::MODULE_BLOG));
?>

/HomeLanding/templates/pagecontent/
Si les variables de templates du modules sont identiques aux variables de templates communes à tous les modules, le fichier.tpl /HomeLanding/templates/pagecontent/item.tpl peut être utilisé et il n'y a donc pas besoin de template spécifique pour ce module

Sinon, ou si on veut utiliser un template différent, il faut créer un fichier tpl au nom de la constante du module,

/HomeLanding/templates/pagecontent/blog.tpl

dans lequel il faut à minima déclarer la variable de position pour pouvoir placer le module où l'on veut sur la page d'accueil:

Code TPL :

<div class="sub-section" style="order: {MODULE_POSITION};">
...
</div>

Au final, un seul des fichiers originels de HomeLanding est modifié: /

/HomeLanding/templates/home.tpl

. Il faudra donc en faire une sauvegarde avant d'appliquer une future mise à jour de HomeLanding et réappliquer les modifications sur ce fichier

Une astuce consiste à surcharger

home.tpl

dans le thème utilisé

templates
+Nom_Du_Theme
++modules
+++HomeLanding
++++home.tpl

Finaliser l'ajout du module

Maintenant que tous les fichiers sont créés, il faut ajouter le module via la configuration de HomeLanding sur la page

Ajouter des éléments

Vous pouvez maintenant

Valider

HomeLanding - Page d'accueil

Fri, 04 Nov 2022 18:08:06 +0100

Tutoriels d'utilisation de HomeLanding, Page d'accueil

Liste des modules intégrés par défaut:
Modules officiels

Articles
Actualités
Calendrier
Forum
Galerie
Liens web
Livre d'or
Multimédia
Téléchargements

Modules communautaires

Derniers commentaires
Petites annonces
Flux RSS
Recettes
Vidéo

Extra

Actualités épinglées
Menu de navigation "one page"
Édito
Carrousel

Ajouter un module avec catégories séparées

Thu, 20 Jan 2022 06:13:50 +0100

Ce tutoriel une annexe à Ajouter un module dans HomeLanding

Philosophie

L'idée est de considérer une catégorie comme module dans HomeLanding, mais dépendant de son module parent.
Il faut donc déclarer l'ajout d'une ou plusieurs catégories en même temps que l'ajout du module.

Dans cet exemple, on ajoute un module Blog avec la possibilité d'afficher le contenu exclusif de 2 de ses catégories.
Comme dans le tutoriel précédent, les scripts sont à adapter au module ajouté.

Déclaration du module dans l'initialisation de la liste des modules compatibles

/HomeLanding/additional/add/AdditionalAdd.php :


$module = new HomeLandingModule();
$module->set_module_id(HomeLandingBlog::MODULE_BLOG);
$module->set_phpboost_module_id(HomeLandingBlog::MODULE_BLOG);
$module->hide();
$modules[] = $module->get_properties();
$module = new HomeLandingModuleCategory();
$module->set_module_id(HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT);
$module->set_phpboost_module_id(HomeLandingBlog::MODULE_BLOG);
$module->hide();
$modules[] = $module->get_properties();
$module = new HomeLandingModuleCategory();
$module->set_module_id(HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT);
$module->set_phpboost_module_id(HomeLandingBlog::MODULE_BLOG);
$module->hide();
$modules[] = $module->get_properties();
?>

/HomeLanding/additional/init/AdditionalInit.php :


$module = new HomeLandingModule();
$module->set_module_id(self::MODULE_BLOG);
$module->set_phpboost_module_id(self::MODULE_BLOG);
$module->hide();
$modules[] = $module->get_properties();
$module = new HomeLandingModuleCategory();
$module->set_module_id(self::MODULE_BLOG_OUTINGS_CAT);
$module->set_phpboost_module_id(self::MODULE_BLOG);
$module->hide();
$modules[] = $module->get_properties();
$module = new HomeLandingModuleCategory();
$module->set_module_id(self::MODULE_BLOG_VOYAGES_CAT);
$module->set_phpboost_module_id(self::MODULE_BLOG);
$module->hide();
$modules[] = $module->get_properties();
?>

Formulaire

/HomeLanding/additional/form/AdditionalForm.php :


if ($this->modules[HomeLandingBlog::MODULE_BLOG]->is_active())
{
// Full module
    $fieldset_blog = new FormFieldsetMultitabsHTML('admin_blog',  $this->lang['homelanding.module.display'] . ModulesManager::get_module($this->modules[HomeLandingBlog::MODULE_BLOG]->get_module_id())->get_configuration()->get_name(),
        array('css_class' => 'tabs tabs-animation')
    );
    $form->add_fieldset($fieldset_blog);
    $fieldset_blog->add_field(new FormFieldCheckbox('blog_enabled', $this->lang['homelanding.show.full.module'], $this->modules[HomeLandingBlog::MODULE_BLOG]->is_displayed(),
        array(
            'class'=> 'custom-checkbox',
            'events' => array('click' => '
                if (HTMLForms.getField("blog_enabled").getValue()) {
                    HTMLForms.getField("blog_limit").enable();
                } else {
                    HTMLForms.getField("blog_limit").disable();
                }'
            )
        )
    ));
    $fieldset_blog->add_field(new FormFieldNumberEditor('blog_limit', $this->lang['homelanding.items.number'], $this->modules[HomeLandingBlog::MODULE_BLOG]->get_elements_number_displayed(),
        array(
            'min' => 1, 'max' => 100,
            'hidden' => !$this->modules[HomeLandingBlog::MODULE_BLOG]->is_displayed()
        ),
        array(new FormFieldConstraintIntegerRange(1, 100))
    ));
// Outings cat
    $fieldset_blog->add_field(new FormFieldSpacer('blog_outings_cat_separator', ''));
    $fieldset_blog->add_field(new FormFieldCheckbox('blog_outings_cat_enabled', $this->lang['homelanding.display.category'], $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed(),
        array(
            'class'=> 'custom-checkbox',
            'description' => $this->lang['homelanding.category.blog.outings.cat.clue'],
            'events' => array('click' => '
                if (HTMLForms.getField("blog_outings_cat_enabled").getValue()) {
                    HTMLForms.getField("blog_outings_cat").enable();
                    HTMLForms.getField("blog_outings_subcategories_content_displayed").enable();
                    HTMLForms.getField("blog_outings_cat_limit").enable();
                    HTMLForms.getField("blog_outings_cat_char").enable();
                } else {
                    HTMLForms.getField("blog_outings_cat").disable();
                    HTMLForms.getField("blog_outings_subcategories_content_displayed").disable();
                    HTMLForms.getField("blog_outings_cat_limit").disable();
                    HTMLForms.getField("blog_outings_cat_char").disable();
                }'
            )
        )
    ));
    $fieldset_blog->add_field(CategoriesService::get_categories_manager(HomeLandingBlog::MODULE_BLOG)->get_select_categories_form_field('blog_outings_cat', $this->lang['homelanding.choose.category'], $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->get_id_category(), new SearchCategoryChildrensOptions(),
        array('hidden' => !$this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed())
    ));
    $fieldset_blog->add_field(new FormFieldCheckbox('blog_outings_subcategories_content_displayed', $this->lang['homelanding.display.sub.categories'], $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_subcategories_content_displayed(),
        array(
            'class'=> 'custom-checkbox',
            'hidden' => !$this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed())
    ));
    $fieldset_blog->add_field(new FormFieldNumberEditor('blog_outings_cat_limit', $this->lang['homelanding.items.number'], $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->get_elements_number_displayed(),
        array(
            'min' => 1, 'max' => 100,
            'hidden' => !$this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed()
        ),
        array(new FormFieldConstraintIntegerRange(1, 100))
    ));
    $fieldset_blog->add_field(new FormFieldNumberEditor('blog_outings_cat_char', $this->lang['homelanding.characters.limit'], $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->get_characters_number_displayed(),
        array(
            'min' => 1, 'max' => 512,
            'hidden' => !$this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed()
        ),
        array(new FormFieldConstraintIntegerRange(1, 512))
    ));
// Outings cat
    $fieldset_blog->add_field(new FormFieldSpacer('blog_voyages_cat_separator', ''));
    $fieldset_blog->add_field(new FormFieldCheckbox('blog_voyages_cat_enabled', $this->lang['homelanding.display.category'], $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed(),
        array(
            'class'=> 'custom-checkbox',
            'description' => $this->lang['homelanding.category.blog.voyages.cat.clue'],
            'events' => array('click' => '
                if (HTMLForms.getField("blog_voyages_cat_enabled").getValue()) {
                    HTMLForms.getField("blog_voyages_cat").enable();
                    HTMLForms.getField("blog_voyages_subcategories_content_displayed").enable();
                    HTMLForms.getField("blog_voyages_cat_limit").enable();
                    HTMLForms.getField("blog_voyages_cat_char").enable();
                } else {
                    HTMLForms.getField("blog_voyages_cat").disable();
                    HTMLForms.getField("blog_voyages_subcategories_content_displayed").disable();
                    HTMLForms.getField("blog_voyages_cat_limit").disable();
                    HTMLForms.getField("blog_voyages_cat_char").disable();
                }'
            )
        )
    ));
    $fieldset_blog->add_field(CategoriesService::get_categories_manager(HomeLandingBlog::MODULE_BLOG)->get_select_categories_form_field('blog_voyages_cat', $this->lang['homelanding.choose.category'], $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->get_id_category(), new SearchCategoryChildrensOptions(),
        array('hidden' => !$this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed())
    ));
    $fieldset_blog->add_field(new FormFieldCheckbox('blog_voyages_subcategories_content_displayed', $this->lang['homelanding.display.sub.categories'], $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_subcategories_content_displayed(),
        array(
            'class'=> 'custom-checkbox',
            'hidden' => !$this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed())
    ));
    $fieldset_blog->add_field(new FormFieldNumberEditor('blog_voyages_cat_limit', $this->lang['homelanding.items.number'], $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->get_elements_number_displayed(),
        array(
            'min' => 1, 'max' => 100,
            'hidden' => !$this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed()
        ),
        array(new FormFieldConstraintIntegerRange(1, 100))
    ));
    $fieldset_blog->add_field(new FormFieldNumberEditor('blog_voyages_cat_char', $this->lang['homelanding.characters.limit'], $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->get_characters_number_displayed(),
        array(
            'min' => 1, 'max' => 512,
            'hidden' => !$this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed()
        ),
        array(new FormFieldConstraintIntegerRange(1, 512))
    ));
}
?>

/HomeLanding/additional/save/AdditionalSave.php :


// Full module
    if ($this->form->get_value('blog_enabled'))
    {
        $this->modules[HomeLandingBlog::MODULE_BLOG]->display();
        $this->modules[HomeLandingBlog::MODULE_BLOG]->set_elements_number_displayed($this->form->get_value('blog_limit'));
    }
    else
        $this->modules[HomeLandingBlog::MODULE_BLOG]->hide();
// Outings cat
    if ($this->form->get_value('blog_outings_cat_enabled'))
    {
        $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->display();
        if (!$this->form->field_is_disabled('blog_outings_cat'))
            $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->set_id_category($this->form->get_value('blog_outings_cat')->get_raw_value());
        if ($this->form->get_value('blog_outings_subcategories_content_displayed'))
            $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->display_subcategories_content();
        else
            $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->hide_subcategories_content();
        $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->set_elements_number_displayed($this->form->get_value('blog_outings_cat_limit'));
        $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->set_characters_number_displayed($this->form->get_value('blog_outings_cat_char'));
    }
    else
        $this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->hide();
// Voyages cat
    if ($this->form->get_value('blog_voyages_cat_enabled'))
    {
        $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->display();
        if (!$this->form->field_is_disabled('blog_voyages_cat'))
            $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->set_id_category($this->form->get_value('blog_voyages_cat')->get_raw_value());
        if ($this->form->get_value('blog_voyages_subcategories_content_displayed'))
            $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->display_subcategories_content();
        else
            $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->hide_subcategories_content();
        $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->set_elements_number_displayed($this->form->get_value('blog_voyages_cat_limit'));
        $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->set_characters_number_displayed($this->form->get_value('blog_voyages_cat_char'));
    }
    else
        $this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->hide();
?>

/HomeLanding/additional/submit/AdditionalSubmit.php :


if ($this->modules[HomeLandingBlog::MODULE_BLOG]->is_active())
{
    $this->form->get_field_by_id('blog_limit')->set_hidden(!$this->modules[HomeLandingBlog::MODULE_BLOG]->is_displayed());
    $this->form->get_field_by_id('blog_outings_cat')->set_hidden(!$this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed());
    $this->form->get_field_by_id('blog_outings_subcategories_content_displayed')->set_hidden(!$this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed());
    $this->form->get_field_by_id('blog_outings_cat_limit')->set_hidden(!$this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed());
    $this->form->get_field_by_id('blog_outings_cat_char')->set_hidden(!$this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed());
    $this->form->get_field_by_id('blog_voyages_cat')->set_hidden(!$this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed());
    $this->form->get_field_by_id('blog_voyages_subcategories_content_displayed')->set_hidden(!$this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed());
    $this->form->get_field_by_id('blog_voyages_cat_limit')->set_hidden(!$this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed());
    $this->form->get_field_by_id('blog_voyages_cat_char')->set_hidden(!$this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed());
}
?>

Pour un module "core"

/HomeLanding/additional/home/AdditionalHome.php :


if ($this->modules[HomeLandingBlog::MODULE_BLOG]->is_displayed() && CategoriesAuthorizationsService::check_authorizations(Category::ROOT_CATEGORY, HomeLandingBlog::MODULE_BLOG)->read())
    $this->view->put('BLOG', HomeLandingDisplayItems::build_view(HomeLandingBlog::MODULE_BLOG));
if ($this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed() && CategoriesAuthorizationsService::check_authorizations($this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->get_id_category(), HomeLandingBlog::MODULE_BLOG)->read())
    $this->view->put('BLOG_OUTINGS_CAT', HomeLandingDisplayItems::build_view(HomeLandingBlog::MODULE_BLOG, HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT));
if ($this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed() && CategoriesAuthorizationsService::check_authorizations($this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->get_id_category(), HomeLandingBlog::MODULE_BLOG)->read())
    $this->view->put('BLOG_VOYAGES_CAT', HomeLandingDisplayItems::build_view(HomeLandingBlog::MODULE_BLOG, HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT));
?>

Pour un module "base"

/HomeLanding/additional/home/AdditionalHome.php :


if ($this->modules[HomeLandingBlog::MODULE_BLOG]->is_displayed() && CategoriesAuthorizationsService::check_authorizations(Category::ROOT_CATEGORY, HomeLandingBlog::MODULE_BLOG)->read())
    $this->view->put('BLOG', HomeLandingDisplayItems::get_blog_view(HomeLandingBlog::MODULE_BLOG));
if ($this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->is_displayed() && CategoriesAuthorizationsService::check_authorizations($this->modules[HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT]->get_id_category(), HomeLandingBlog::MODULE_BLOG)->read())
    $this->view->put('BLOG_OUTINGS_CAT', HomeLandingDisplayItems::get_outings_cat_view_view(HomeLandingBlog::MODULE_BLOG, HomeLandingBlog::MODULE_BLOG_OUTINGS_CAT));
if ($this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->is_displayed() && CategoriesAuthorizationsService::check_authorizations($this->modules[HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT]->get_id_category(), HomeLandingBlog::MODULE_BLOG)->read())
    $this->view->put('BLOG_VOYAGES_CAT', HomeLandingDisplayItems::get_voyages_cat_view(HomeLandingBlog::MODULE_BLOG, HomeLandingBlog::MODULE_BLOG_VOYAGES_CAT));
?>

/HomeLanding/services/modules/HomeLandingBlog.class.php :


class HomeLandingBlog
{
    const MODULE_BLOG = 'blog';
    const MODULE_BLOG_OUTINGS_CAT = 'blog_outings_cat';
    const MODULE_BLOG_VOYAGES_CAT = 'blog_voyages_cat';
    public static function get_blog_outings_cat_view()
    {
        $now = new Date();
        $module_config = BlogConfig::load();
        $home_config   = HomeLandingConfig::load();
        $modules       = HomeLandingModulesList::load();
        $module_name   = self::MODULE_BLOG;
        $module_cat    = self::MODULE_BLOG_OUTINGS_CAT;
        $theme_id = AppContext::get_current_user()->get_theme();
        if (file_exists(PATH_TO_ROOT . '/templates/' . $theme_id . '/modules/HomeLanding/pagecontent/' . $module_cat . '.tpl'))
            $view = new FileTemplate('/templates/' . $theme_id . '/modules/HomeLanding/pagecontent/' . $module_cat . '.tpl');
        elseif (file_exists(PATH_TO_ROOT . '/HomeLanding/templates/pagecontent/' . $module_cat . '.tpl'))
            $view = new FileTemplate('/HomeLanding/templates/pagecontent/' . $module_cat . '.tpl');
        else
            $view = new FileTemplate('HomeLanding/pagecontent/items.tpl');
        $home_lang = LangLoader::get('common', 'HomeLanding');
        $module_lang = LangLoader::get('common', $module_name);
        $view->add_lang(array_merge($home_lang, $module_lang, LangLoader::get('common-lang')));
        $categories_id = $modules[$module_cat]->is_subcategories_content_displayed() ? CategoriesService::get_authorized_categories($modules[$module_cat]->get_id_category(), $module_config->is_summary_displayed_to_guests(), $module_name) : array($modules[$module_cat]->get_id_category());
        $result = PersistenceContext::get_querier()->select('SELECT blog.*, member.*
        FROM ' . PREFIX . 'blog  blog
        LEFT JOIN ' . DB_TABLE_MEMBER . ' member ON member.user_id = blog.author_user_id
        WHERE (published = 1 OR (published = 2 AND publishing_start_date < :timestamp_now AND (publishing_end_date > :timestamp_now OR publishing_end_date = 0))) AND id_category IN :categories_id
        ORDER BY blog.update_date DESC
        LIMIT :blog_cat_limit', array(
            'user_id' => AppContext::get_current_user()->get_id(),
            'timestamp_now' => $now->get_timestamp(),
            'categories_id' => $categories_id,
            'blog_cat_limit' => $modules[$module_cat]->get_elements_number_displayed()
        ));
        $category = CategoriesService::get_categories_manager($module_name)->get_categories_cache()->get_category($modules[$module_cat]->get_id_category());
        $view->put_all(array(
            'C_NO_ITEM'       => $result->get_rows_count() == 0,
            'C_CATEGORY'      => true,
            'C_VIEWS_NUMBER'  => true,
            'C_LIST_VIEW'     => $module_config->get_display_type() == BlogConfig::LIST_VIEW,
            'C_GRID_VIEW'     => $module_config->get_display_type() == BlogConfig::GRID_VIEW,
            'C_TABLE_VIEW'    => $module_config->get_display_type() == BlogConfig::TABLE_VIEW,
            'MODULE_POSITION' => $home_config->get_module_position_by_id($module_cat),
            'MODULE_NAME'     => $module_name,
            'ITEMS_PER_ROW'   => $module_config->get_items_per_row(),
            'L_MODULE_TITLE'  => ModulesManager::get_module($module_name)->get_configuration()->get_name() . ': ' . $category->get_name(),
        ));
        while ($row = $result->fetch())
        {
            $item = new BlogItem();
            $item->set_properties($row);
            $view->assign_block_vars('items', array_merge($item->get_array_tpl_vars(), array(
                'C_SEVERAL_VIEWS' => $item->get_views_number() > 1,
            )));
        }
        $result->dispose();
        return $view;
    }
    public static function get_blog_voyages_cat_view()
    {
        $now = new Date();
        $module_config = BlogConfig::load();
        $home_config   = HomeLandingConfig::load();
        $modules       = HomeLandingModulesList::load();
        $module_name   = HomeLandingConfig::MODULE_BLOG;
        $module_cat    = HomeLandingConfig::MODULE_BLOG_VOYAGES_CAT;
        $theme_id = AppContext::get_current_user()->get_theme();
        if (file_exists(PATH_TO_ROOT . '/templates/' . $theme_id . '/modules/HomeLanding/pagecontent/' . $module_cat . '.tpl'))
            $view = new FileTemplate('/templates/' . $theme_id . '/modules/HomeLanding/pagecontent/' . $module_cat . '.tpl');
        elseif (file_exists(PATH_TO_ROOT . '/HomeLanding/templates/pagecontent/' . $module_cat . '.tpl'))
            $view = new FileTemplate('/HomeLanding/templates/pagecontent/' . $module_cat . '.tpl');
        else
            $view = new FileTemplate('HomeLanding/pagecontent/items.tpl');
        $home_lang = LangLoader::get('common', 'HomeLanding');
        $module_lang = LangLoader::get('common', $module_name);
        $view->add_lang(array_merge($home_lang, $module_lang, LangLoader::get('common-lang')));
        $categories_id = $modules[$module_cat]->is_subcategories_content_displayed() ? CategoriesService::get_authorized_categories($modules[$module_cat]->get_id_category(), $module_config->is_summary_displayed_to_guests(), $module_name) : array($modules[$module_cat]->get_id_category());
        $result = PersistenceContext::get_querier()->select('SELECT blog.*, member.*
        FROM ' . PREFIX . 'blog  blog
        LEFT JOIN ' . DB_TABLE_MEMBER . ' member ON member.user_id = blog.author_user_id
        WHERE (published = 1 OR (published = 2 AND publishing_start_date < :timestamp_now AND (publishing_end_date > :timestamp_now OR publishing_end_date = 0))) AND id_category IN :categories_id
        ORDER BY blog.update_date DESC
        LIMIT :blog_cat_limit', array(
            'user_id' => AppContext::get_current_user()->get_id(),
            'timestamp_now' => $now->get_timestamp(),
            'categories_id' => $categories_id,
            'blog_cat_limit' => $modules[$module_cat]->get_elements_number_displayed()
        ));
        $category = CategoriesService::get_categories_manager($module_name)->get_categories_cache()->get_category($modules[$module_cat]->get_id_category());
        $view->put_all(array(
            'C_NO_ITEM'       => $result->get_rows_count() == 0,
            'C_CATEGORY'      => true,
            'C_VIEWS_NUMBER'  => true,
            'C_LIST_VIEW'     => $module_config->get_display_type() == BlogConfig::LIST_VIEW,
            'C_GRID_VIEW'     => $module_config->get_display_type() == BlogConfig::GRID_VIEW,
            'C_TABLE_VIEW'    => $module_config->get_display_type() == BlogConfig::TABLE_VIEW,
            'MODULE_POSITION' => $home_config->get_module_position_by_id($module_cat),
            'MODULE_NAME'     => $module_name,
            'ITEMS_PER_ROW'   => $module_config->get_items_per_row(),
            'L_MODULE_TITLE'  => ModulesManager::get_module($module_name)->get_configuration()->get_name() . ': ' . $category->get_name(),
        ));
        while ($row = $result->fetch())
        {
            $item = new BlogItem();
            $item->set_properties($row);
            $view->assign_block_vars('items', array_merge($item->get_array_tpl_vars(), array(
                'C_SEVERAL_VIEWS' => $item->get_views_number() > 1,
            )));
        }
        $result->dispose();
        return $view;
    }
    public static function get_blog_view()
    {
        $now = new Date();
        $module_config = BlogConfig::load();
        $home_config   = HomeLandingConfig::load();
        $modules       = HomeLandingModulesList::load();
        $module_name   = HomeLandingConfig::MODULE_BLOG;
        $theme_id = AppContext::get_current_user()->get_theme();
        if (file_exists(PATH_TO_ROOT . '/templates/' . $theme_id . '/modules/HomeLanding/pagecontent/' . $module_name . '.tpl'))
            $view = new FileTemplate('/templates/' . $theme_id . '/modules/HomeLanding/pagecontent/' . $module_name . '.tpl');
        elseif (file_exists(PATH_TO_ROOT . '/HomeLanding/templates/pagecontent/' . $module_name . '.tpl'))
            $view = new FileTemplate('/HomeLanding/templates/pagecontent/' . $module_name . '.tpl');
        else
            $view = new FileTemplate('HomeLanding/pagecontent/items.tpl');
        $home_lang = LangLoader::get('common', 'HomeLanding');
        $module_lang = LangLoader::get('common', $module_name);
        $view->add_lang(array_merge($home_lang, $module_lang, LangLoader::get('common-lang')));
        $authorized_categories = CategoriesService::get_authorized_categories(Category::ROOT_CATEGORY, $module_config->is_summary_displayed_to_guests(), $module_name);
        $result = PersistenceContext::get_querier()->select('SELECT blog.*, member.*, cat.rewrited_name AS rewrited_name_cat
        FROM ' . PREFIX . 'blog blog
        LEFT JOIN ' . PREFIX . 'blog_cats cat ON cat.id = blog.id_category
        LEFT JOIN ' . DB_TABLE_MEMBER . ' member ON member.user_id = blog.author_user_id
        WHERE (published = 1 OR (published = 2 AND publishing_start_date < :timestamp_now AND (publishing_end_date > :timestamp_now OR publishing_end_date = 0))) AND id_category IN :authorized_categories
        ORDER BY blog.update_date DESC
        LIMIT :blog_limit', array(
            'authorized_categories' => $authorized_categories,
            'user_id' => AppContext::get_current_user()->get_id(),
            'timestamp_now' => $now->get_timestamp(),
            'blog_limit' => $modules[$module_name]->get_elements_number_displayed()
        ));
        $view->put_all(array(
            'C_NO_ITEM'       => $result->get_rows_count() == 0,
            'C_VIEWS_NUMBER'  => true,
            'C_GRID_VIEW'     => $module_config->get_display_type() == BlogConfig::GRID_VIEW,
            'C_TABLE_VIEW'    => $module_config->get_display_type() == BlogConfig::TABLE_VIEW,
            'MODULE_NAME'     => $module_name,
            'MODULE_POSITION' => $home_config->get_module_position_by_id($module_name),
            'ITEMS_PER_ROW'   => $module_config->get_items_per_row(),
            'L_MODULE_TITLE'  => ModulesManager::get_module($module_name)->get_configuration()->get_name(),
        ));
        while ($row = $result->fetch())
        {
            $item = new BlogItem();
            $item->set_properties($row);
            $view->assign_block_vars('items', array_merge($item->get_array_tpl_vars(), array(
                'C_SEVERAL_VIEWS' => $item->get_views_number() > 1,
            )));
        }
        $result->dispose();
        return $view;
    }
}
?>

Afin de nommer les catégories sur les différentes pages, il faut créer un nouveau fichier de langue qui est chargé automatiquement dès lors qu'il existe

/HomeLanding/lang/french/additional.php :

/additional.php]
/**
 * @copyright   © 2005-2021 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Firstname LASTNAME 
 * @version     PHPBoost 6.0 - last update: YYYY MM DD
 * @since       PHPBoost 5.0 - YYYY MM DD
*/
####################################################
#                      French                      #
####################################################
//  Additional
//page des positionnements
$lang['homelanding.module.blog_outings_cat']    = 'blog - sorties';
$lang['homelanding.module.blog_voyages_cat']   = 'blog - voyages';
// page princpale d'affichage
$lang['homelanding.category.blog_outings_cat']  = 'blog';
$lang['homelanding.category.blog_voyages_cat'] = 'blog';
?>

à réitérer dans le dossier english pour la traduction, si besoin.

Enfin, on ajoute les variables de templates au seul fichier originel modifié (qu'il faudra remoidifer en cas de mis à jour de HomeLanding)

/HomeLanding/templates/home.tpl :


# INCLUDE  BLOG #
# INCLUDE  BLOG_OUTINGS_CAT #
# INCLUDE  BLOG_VOYAGES_CAT #

Utilisation de HomeLanding

Mon, 15 Nov 2021 07:20:47 +0100

Présentation et installation

Ce module permet d'afficher une page d'accueil regroupant les derniers items de chaque module officiel de PHPBoost grâce à une page d'administration. Vous pourrez choisir en quelques clics quels seront les modules à afficher, dans quel ordre et le nombre d'items pour chaque module. Vous y trouverez également la possibilité d'ajouter un édito et un carrousel d'image.
la présentation graphique de chaque module est définie en fonction des réglages effectués dans la configuration de chaque module (affichage en liste, mosaïque, tableau, etc.)

Installation

Ce module s'installe comme tout autre module dans PHPBoost :
au choix:

Téléchargez et décompressez l'archive, envoyez le dossier HomeLanding sur votre FTP à la racine du site puis installez-le via l'ajout de module de l'administration ;
Téléchargez l'archive, puis utilisez le formulaire d'ajout de module.

Une fois le module installé, rendez vous dans la configuration générale et choisissez-le comme "Page de démarrage".

Configuration

La configuration du module se trouve dans l'onglet Contenu de l'administration.
Toute modification doit être validée en bas de page de la configuration.

Affichage du titre de la page et des emplacements de menus

Vous pouvez définir un titre spécifique à la page.

Selon la configuration de votre site (une, deux ou trois colonnes) vous avez la possibilité de masquer tout ou partie de ces emplacements sur la page d'accueil.

un menu qui permet de naviguer dans la page d'accueil peut être activé. La liste des items est définie automatiquement en fonction des modules déclarés et de leur ordre.

Le carrousel

Une fois activé, le carrousel vous permet d'ajouter autant d'images que vous voulez, ainsi qu'une description qui les accompagne (optionnelle).
On peut déclarer un lien sur la description vers une adresse.
Des options sont également prévues pour gérer le défilement des images : vitesse de défilement, durée d'affichage de chaque image, affichage de flèches de navigation, blocage du défilement au survol des images, choix du type d'affichage des miniatures de navigation (images ou points).

L'édito

Cette option vous permet d'afficher un texte libre géré par le RichTextEditor

Les derniers commentaires

Cette option permet d'afficher les derniers commentaires postés sur votre site, avec gestion du nombre de commentaires à afficher ainsi que du nombre de caractères par commentaires.

Les Modules

La gestion d'un module n'est visible que s'il est installé et activé.

Articles

Affichage des derniers items du module et/ou affichage d'une seule catégorie avec la possibilité de configurer l'affichage de ses sous-catégories.

Calendrier

Affichage des derniers événements du calendrier. Seuls les événements à venir sont affichés.

Contact

Affichage du formulaire d'envoi de message du module et la map google si elle est déclarée dans le module.

Téléchargements

Affichage des derniers items du module et/ou affichage d'une seule catégorie avec la possibilité de configurer l'affichage de ses sous-catégories.

Flux RSS

Affichage des items de flux les plus récents, tous flux confondus

Forum

Affichage des derniers messages postés dans le forum.

Galerie

Affichage des dernières images de la galerie. En front, le clic sur une image renvoie vers sa catégorie.

Livre d'or

Affichage des derniers messages postés dans le livre d'or.

Multimédia

Affichage des derniers items du module.

News

Affichage des derniers items du module et/ou affichage d'une seule catégorie avec la possibilité de configurer l'affichage de ses sous-catégories.

Liens web

Affichage des derniers items du module et/ou affichage d'une seule catégorie avec la possibilité de configurer l'affichage de ses sous-catégories.
Seuls les liens "partenaires" sont affichés.

Wiki

Ajouter un module dans HomeLanding

Deux procédures d'ajout

Fichiers à ajouter dans HomeLanding

Déclaration de la compatibilité du module avec HomeLanding

Déclaration du module dans l'initialisation de la liste des modules compatibles

Formulaire pour le module

Récupération de données et templates

Les modules "core"

Les modules "base"

Finaliser l'ajout du module

HomeLanding - Page d'accueil

Ajouter un module avec catégories séparées

Philosophie

Déclaration du module dans l'initialisation de la liste des modules compatibles

Formulaire

Pour un module "core"

Pour un module "base"

Utilisation de HomeLanding

Présentation et installation

Installation

Configuration

Affichage du titre de la page et des emplacements de menus

Un menu "d'accueil"

Le carrousel

L'édito

Les derniers commentaires

Les Modules

Articles

Calendrier

Contact

Téléchargements

Flux RSS

Forum

Galerie

Livre d'or

Multimédia

News

Liens web