Requête sur les billets

Jean-Christian Denis — Thu, 13 Feb 2025 10:02:00 +0000

La version 2.33 de Dotclear modifie la gestion des status et ouvre les session coté publique apportant des modification dans les requêtes.

L'ouverture des statuts de billets de la version 2.33 de Dotclear oblige a modifier les requêtes liées aux billets, en effet il faut désormais tenir compte qu'il est possible d'avoir de nouveaux statuts encore inconnues jusqu'ici. Par exemple là ou il suffisait de tester si un billet avec un statut POST_PUBLISHED pour l'afficher, maintenant un nouveau statut POST_SUBSCRIBER amené par un plugin pourrait tout à fait avoir le droit d'être également affiché. Pour faciliter cette limite entre billet autorisé et billet restreint, les groupes de status ont une limite de niveau définie à partir de laquelle un billet est considéré comme restreint, c'est la propriété threshold. Elle peut être testé avec :

if (App::status()->post()->isRestricted($rs->post_status)) { }

Mais cela est loin d'être suffisant, la version 2.33 de Dotclear ouvre également les sessions coté publique. On peut alors imaginer qu'un billet sera restreint aux lecteurs lambda du blog mais autorisé aux lecteurs enregistrés coté publique. Le billet peut alors être restreint ou non suivant sont niveau mais également suivant le niveau de l'utilisateur.

Pour faciliter la gestion de ces requêtes complexes et pourvoir d'un coup accorder à nos besoins toutes les requêtes d'une page (il y en a pour les catégories de billets, les tags de billets, etc...) un nouveau behavior fait son apparition : coreBlogBeforeGetPostsAddingParameters. Il va permettre aux plugins d'interagir avec les requêtes de billets de manière globale. A travers ce behavior un plugin peut modifier les paramètres de requête : post_type, post_status, et comment_status. Le plugin va pouvoir ainsi ajouter son post_status à la requête si l'utilisateur est enregistré.

Le plugin d'exemple concret et simple RestrictedReading permet de comprendre la mise en œuvre de ces changements.
Voici le contenu de son fichier Prepend.php :

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

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

        // Ajout d'une nouvelle permission pour les uilisateurs
        App::auth()->setPermissionType(My::USER_PERMISSION, __('Restricted reading'));

        // Ajout d'un nouveau status pour les billets
        if (App::status()->post()->set(
            (new Status(My::POST_STATUS , My::id(), 'Restricted reading', 'Restricted reading (>1)', My::fileURL('icon.svg'))),
        )) {
            // Ajout du behavior de modification des requêtes de billets
            App::behavior()->addBehaviors([
                'coreBlogBeforeGetPostsAddingParameters' => self::coreBlogBeforeGetPostsAddingParameters(...),
            ]);

            return true;
        }

        return false;
    }

    /**
     * Utilisation du behavior pour l'ajout de l'autorisation d'afficher le billet si :
     * * Le billet a le status My::POST_STATUS 
     * * L'utilisateur est enregistré avec la permissions My::USER_PERMISSION
     */
    public static function coreBlogBeforeGetPostsAddingParameters(ArrayObject $params, string|null $arg = null): void
    {
        if (App::task()->checkContext('FRONTEND') && App::auth()->check(My::USER_PERMISSION, App::blog()->id()) === true) {
            if (!isset($params['post_status'])) {
                $params['post_status'] = [];
            }
            if (!is_array($params['post_status'])) {
                $params['post_status'] = [$params['post_status']];
            }

            $params['post_status'][] = My::POST_STATUS;
        }
    }

Grace à ce behavior tout le contenu de la page courante tiendra compte du statut du billet et des permissions de l'utilisateur.%%

Les status

Jean-Christian Denis — Thu, 13 Feb 2025 10:01:00 +0000

La version 2.33 de Dotclear modifie la gestion des status des utilisateurs, blogs, billets, commentaires.

Résumé

Dans les versions précédentes chaque entité utilisait des méthodes et valeurs dédiées et bloquées de status, tout ça éparpillé un peu partout. Depuis la version 2.33, tous ces status utilisent une structure commune et sont ouvert à l'ajout de nouveaux status. Cela a entrainé pas mal de modifications de requêtes et de scripts de vérification pour prendre en compte cette ouverture.

Nouvelles classes

De nouvelles classes regroupant les status d'un groupe sont donc accessibles depuis l'application :

Utilisateurs : App::status()->user()
Blogs : App::status()->blog()
Billets : App::status()->post()
Commentaires : App::status()->comment()

Ces classes contiennent une pile de status, qui sont maintenant des objets.
La classe d'un status contient les propriétés suivantes :

Un niveau level
Un identifiant id
Un nom name (et son pluriel plural_name)
Une icone icon (et sa version foncée icon_dark)
Une option hidden pour le cacher des sélections de formulaire

Pour connaitre toutes les méthodes disponibles pour les groupes de status, les classes sont dans :

src\Helper\Stack\Status (générique)
src\Helper\Stack\Statuses (générique)
src\Schema\Status\Blog.php
src\Schema\Status\Comment.php
src\Schema\Status\Post.php
src\Schema\Status\User.php

Les classes regroupant ces status vont faciliter leur gestion en intégrant tous les outils nécessaires comme les combo, les filtres, les colonnes de tableau, les actions... Le code de Dotclear s'en retrouve simplifié et plus harmonieux à sa lecture.

Utilisation

Récupérer le nom et l'image d'un status de blog :

$name  = App::status()->blog()->name((int) $rs->blog_status);
$image = App::status()->blog()->image((int) $rs->blog_status);

Tester si un billet a un status restreint :

if (App::status()->post()->isRestricted((int) $rs->post_status)) { }

Récupérer le combo d'action sur des commentaires :

echo (new Select('comment_status'))
    ->items(App::status()->comment()->combo())
    ->default((string) $rs->comment_status)
    ->label(new Label(__('Comment status:'), Label::IL_TF))
    ->render();

Exemple d'ajout d'un status aux utilisateurs depuis le plugin FrontendSession :

App::status()->user()->set((new Status(
    My::USER_PENDING , 
    My::id(), 
    'Pending registration', 
    'pending registration (>1)', 
    My::fileURL('icon.svg'))
));

La recherche de status se fait par identifiant ou par niveau sur la plupart des méthodes, ces 3 exemples retourneront le même objet :

$status_online = App::status()->blog()->get(1);
$status_online = App::status()->blog()->get(App::status()->blog()::ONLINE);
$status_online = App::status()->blog()->get('online');

Ces quelques exemples montrent l'harmonisation entre les différents status rencontrés dans Dotclear.
Parmis les changements qui risquent de poser problème à certains plugins, il y a la gestion des status dans les requêtes avec un nouveau behavior coreBlogBeforeGetPostsAddingParameters qui est détaillé dans un article de ce blog.

Dépréciés

Comme souvent, ces changements apportent leur lot de dépréciés.