DotclearWatch / Blog - Mot-clé - backend

Fichier Config d'un module

Jean-Christian Denis — Sun, 16 Jul 2023 14:03:00 +0100

Le fichier Config.php, placé dans le dossier src du module, simplifie la gestion de sa configuration.

Le fichier Config.php fait partie du processus reconnu par le gestionnaire de modules, il est donc automatiquement pris en compte dans l'administration si il existe.

Il est placé dans le sous dossier src du module,
Il contient une classe du nom de Config,
Il est dans l'espace de nom PHP Dotclear\Plugin\monPlugin ou Dotclear\Theme\monTheme,
La classe doit étendre la classe Process,
Les 3 méthodes init() et process() et render() sont utilisées,

Cette classe simplifie la gestion de la configuration d'un module dans le sens où la partie construction de la page est déjà effectuée par le gestionnaire de modules. Seul le traitement des valeurs et le contenu du formulaire sont à la charge de la classe Config. Un lien vers cette page sera ajouté à la liste de plugins ou sur les thèmes de la page de gestion d'apparence du blog. Un lien sera également ajouté en bas de page principale de gestion du plugin si elle existe.

Exemple complet du fichier config du thème customCSS de la distribution :

<?php
namespace Dotclear\Theme\customCSS;

use dcCore;
use Dotclear\Core\Backend\Notices;
use Dotclear\Core\Process;
use Dotclear\Helper\File\Path;
use Dotclear\Helper\Html\Html;
use Dotclear\Helper\L10n;
use Exception;
use form;

class Config extends Process
{
    public static function init(): bool
    {
        if (My::checkContext(My::CONFIG)) {
            My::l10n('main');
            dcCore::app()->admin->css_file = Path::real(dcCore::app()->blog->public_path) . '/custom_style.css';

            if (!is_file(dcCore::app()->admin->css_file) && !is_writable(dirname(dcCore::app()->admin->css_file))) {
                throw new Exception(
                    sprintf(
                        __('File %s does not exist and directory %s is not writable.'),
                        dcCore::app()->admin->css_file,
                        dirname(dcCore::app()->admin->css_file)
                    )
                );
            }
            self::status(true);
        }

        return self::status();
    }

    public static function process(): bool
    {
        if (!self::status()) {
            return false;
        }

        if (isset($_POST['css'])) {
            @$fp = fopen(dcCore::app()->admin->css_file, 'wb');
            fwrite($fp, $_POST['css']);
            fclose($fp);

            Notices::message(__('Style sheet upgraded.'), true, true);
        }

        return true;
    }

    public static function render(): void
    {
        if (!self::status()) {
            return;
        }

        $css_content = is_file(dcCore::app()->admin->css_file) ? file_get_contents(dcCore::app()->admin->css_file) : '';

        echo
        '<p class="area"><label>' . __('Style sheet:') . '</label> ' .
        form::textarea('css', 60, 20, Html::escapeHTML($css_content)) . '</p>';
    }
}

Le contenu de ce document a été écrit suivant le code de la version 2.27 de Dotclear.

Fichier Backend d'un module

Jean-Christian Denis — Sun, 16 Jul 2023 13:36:00 +0100

Le fichier Backend.php, placé dans le dossier src du module, permet de préparer le nécessaire à son fonctionnement pour sa partie administration.

Le fichier Backend.php fait partie du processus reconnu par le gestionnaire de modules, il est donc automatiquement pris en compte dans l'administration si il existe.

Il est placé dans le sous dossier src du module,
Il contient une classe du nom de Backend,
Il est dans l'espace de nom PHP Dotclear\Plugin\monPlugin ou Dotclear\Theme\monTheme,
La classe doit étendre la classe Process,
Seules les méthodes init() et process() sont utilisées,

Généralement cette classe est utilisée pour préparer des variables nécessaires au fonctionnement du module, ajouter ses menus, favoris, behaviors, pour la partie administration des blogs.

Exemple du fichier Backend.php du plugin aboutConfig de la distribution :

<?php
declare(strict_types=1);

namespace Dotclear\Plugin\aboutConfig;

use Dotclear\Core\Backend\Menus;
use Dotclear\Core\Process;

class Backend extends Process
{
    public static function init(): bool
    {
        return self::status(My::checkContext(My::BACKEND));
    }

    public static function process(): bool
    {
        if (self::status()) {
            My::addBackendMenuItem(Menus::MENU_SYSTEM);
        }

        return self::status();
    }
}

Le contenu de ce document a été écrit suivant le code de la version 2.27 de Dotclear.

Gestion d'URL d'administration

Jean-Christian Denis — Thu, 13 Jul 2023 23:08:00 +0100

La version 2.27 de Dotclear embarque des changements côté URL, dont certains non rétro compatibles.

Déprécié

Avec le passage aux espaces de noms PHP, la classe dcAdminURL devient Dotclear\Core\Backend\Url.
Et son instance se déplace également de dcCore::app()->adminurl vers dcCore::app()->admin->url.
A noter que grâce au plugins dcProxyV1, les anciens noms restent accessibles.

Obsolète

Dûe à la mise en place de la nouvelle structure de l'application, l'utilisation des URLs écrites directement est proscrite. C'est à dire que partout où un plugin écrivait 'plugin.php?p=monPlugin' le code ne fonctionnera plus. Il faut impérativement utiliser le gestionnaire d'URL dcCore::app()->admin->url et ses méthodes.

<?php
// dcCore::app()->adminurl->get('admin.plugin.monPlugin', ['var' => 1]);
dcCore::app()->admin->url->get('admin.plugin.monPlugin', ['var' => 1]);
// ou encore mieux
My::manageURL(['var' => 1]);

// Http::redirect('plugin.php?p=monPlugin&var=1);
dcCore::app()->admin->url->redirect('admin.plugin.monPlugin', ['var' => 1]);
// ou encore mieux
My::redirect(['var' => 1]);

Pourquoi ? Parce que l'ajout du Process en cours est fait automatiquement par ce biais. Le code ci-dessus renverra l'URL /index.php?process=Plugin&p=monPlugin&var=1.

Nouveauté

Une nouvelle URL débarque dans le gestionnaire, celle de déconnexion, elle permet de se déconnecter de l'interface d'administration même en cas de plantage d'un plugin ou d'un thème. Son identifiant est 'admin.logout'. Si vous souhaitez par exemple déconnecter l'utilisateur depuis votre script il suffit de faire dcCore::app()->redirect('admin.logout');.

Pour des raisons d'uniformisation, l'identifiant d'URL 'admin.popup_posts' sera a terme remplacé par 'admin.popup.posts' et un autre nouvel identifiant 'admin.help.charte' peu utilisé est ajouté.

Attention

Ce n'est pas tout, en rapport au gestionnaire d'URL et à la nouvelle structure de l'application, certains formulaires ne fonctionneront pas comme il faut. En effet les formulaires utilisant la method GET ne peuvent embarquer dans l'URL le process, du moins il le perd en chemin ! (Merci monsieur HTML) Il faut donc impérativement ajouter un champ caché contenant process=xxx ou xxx est l'identifiant de la page qu'il souhaite atteindre enregistré dans le gestionnaire d'URL. Exemple pour la page principale d'un plugin il faudra ajouter dans le formulaire new Form\Hidden('process', 'Plugin'); ou form::hidden('process', 'Plugin'); ou '<input type="hidden" name="process" value="Plugin" />'. Dans la majorité des cas, les formulaires utilisant la méthode POST, ainsi que les filtres de listes tiennent compte du process.

A noter que la classe My d'aide des modules propose des méthodes simplifiant l'accès aux URLs du module.

Le contenu de ce document a été écrit suivant le code de la version 2.27 de Dotclear.