phil/content-bundle

phil/content-bundle enregistre le contenu d'un site Symfony avec Doctrine. Un contenu est une racine et ses lignes de dimension : une ligne par locale, par étape (draft ou live) et par version, plus une ligne non localisée pour les valeurs que partagent toutes les locales. Sur ce stockage, le bundle publie les brouillons vers l'étape en ligne, fige ce qu'il a publié et crée la version suivante pour la prochaine modification. Il tient une table de routes qui répond aux anciens slugs par des redirections permanentes. Il sert le contenu en ligne par un contrôleur qui produit le rendu des gabarits Twig de l'application, donne ses pages au plan du site, écrit des flux Atom et signe des liens d'aperçu vers les brouillons. Le texte d'un brouillon garde le balisage dans lequel son auteur écrit — Markdown, BBCode, MediaWiki, DokuWiki, Creole, HTML, texte brut, UJO ou un format qu'apporte un module complémentaire —; la publication le convertit en UJO (Universal JSON Output), le format de document par blocs de phil/ujo, enregistré avec son HTML sur la ligne en ligne. Le contenu s'écrit depuis une administration reliée à un tableau de bord EasyAdmin, depuis la console, depuis PHP ou depuis une migration Doctrine, par ContentManager. Une publication qui ferait perdre une partie du texte de l'auteur est refusée tant que le rédacteur ne l'a pas acceptée. Chaque page qui passe en ligne ou hors ligne répartit PagePublished ou PageRetired de phil/publishing, que le plan du site, un cache ou un signal peuvent suivre. Les modifications d'un auteur s'enregistrent d'elles-mêmes, en privé, à côté du brouillon, et des brouillons nommés gardent des variantes. Un genre peut n'avoir qu'un seul contenu — la page d'accueil —, ou garder lisible chaque publication, datée — une page « maintenant ». Les contenus publiés alimentent un index de recherche de phil/search-bundle, et phil/scheduled-transitions-bundle les publie à un moment fixé.

Ce qu'il ne fait pas : aucune médiathèque (une image d'extrait est une référence que l'application résout), aucun modèle d'utilisateur, d'étiquette, de catégorie ou de sécurité, aucun aperçu en direct ni lien de partage privé, aucun moteur de recherche propre, et aucune chaîne de repli qu'il déduirait seul. L'application les déclare tous.

Il convient à une application Symfony dont les rédacteurs écrivent des pages, des nouvelles ou d'autres genres de contenu, souvent en plusieurs langues, et dont les lecteurs ne doivent voir que ce qui a été publié. Un site de quelques pages fixes dans une seule langue, sans brouillons, est mieux servi par de simples routes et des gabarits Twig. phil/directory-bundle s'appuie sur lui et enregistre chaque fiche comme un contenu. La publication à une heure fixée passe par le workflow phil_content_publication, que phil/scheduled-transitions-bundle applique quand le noyau l'a ; aucun des deux bundles n'exige l'autre.

C'est un bundle Symfony qui se branche sur Doctrine ORM, symfony/workflow, le routeur et Twig, et qui utilise phil/markup, phil/ujo, phil/slug, phil/sitemap, phil/url et phil/publishing. Les capacités (un gabarit, un workflow éditorial, le référencement, un extrait, un lien, un slug, un corps de texte) sont des paires d'interface et de trait qu'une classe de ligne compose. Le bundle associe leurs colonnes à chaque classe de ligne qui les implémente, et un pipeline étiqueté de mappeurs de données, de fusionneurs et de normaliseurs les lit et les écrit. La conception suit le stockage de contenu de Sulu 3 (packages/content) comme motif seulement, autour de simples types du domaine.

État

Documentation

Prérequis

• PHP 8.5 ou plus récent.
• Les composants Symfony 8.2 (dependency-injection, config, workflow, routing, http-kernel, console, …), doctrine/orm 3.7, doctrine/dbal 4.2, twig/twig 3.21, phil/markup, phil/locale-dimensions et phil/ddd-bundle.
• Pour le stockage Doctrine et les commandes de console : DoctrineBundle dans le noyau. Pour le contrôleur et les fonctions Twig : DoctrineBundle et TwigBundle, avec FrameworkBundle.

La liste complète, avec la raison de chaque prérequis, se trouve dans doc/fr/installation.md.

Démarrage rapide

Installez le bundle et les bundles du framework qu'il branche. Tant que les paquets ne sont pas sur Packagist, déclarez un dépôt qui contient phil/content-bundle et phil/ddd-bundle ; voir doc/fr/installation.md.

composer require phil/content-bundle:^0.1@dev phil/ddd-bundle:^0.1@dev doctrine/doctrine-bundle symfony/twig-bundle

Enregistrez Phil\ContentBundle\PhilContentBundle dans config/bundles.php, puis écrivez une racine et sa classe de ligne :

#[ORM\Entity]
class News extends AbstractContentRoot
{
    #[ORM\Id, ORM\Column(name: 'id', type: NewsIdType::NAME)]
    private NewsId $id;

    public function __construct()
    {
        $this->id = NewsId::generate();
    }

    public static function dimensionContentClass(): string
    {
        return NewsDimension::class;
    }
}

#[ORM\Entity]
class NewsDimension extends AbstractDimensionContent implements TemplateCapable, WorkflowCapable, ExcerptCapable,
    RoutableCapable, BodyCapable
{
    use BodyTrait;
    use ExcerptTrait;
    use RoutableTrait;
    use TemplateTrait;
    use WorkflowTrait;
}

La plus petite configuration qui sert des pages :

# config/packages/phil_content.yaml
phil_content:
    locales:
        fr: []
    roots:
        - App\Content\News
    routes:
        news: news_show
    default_template: content/news.html.twig

# config/routes/content.yaml
news_show:
    path: /{_locale}/news/{slug}
    controller: Phil\ContentBundle\Infrastructure\Http\ContentController

Migrez le schéma (bin/console doctrine:migrations:diff, puis migrate), puis écrivez et publiez du contenu :

bin/console phil:content:create news fr --field=slug=opening --field=excerptTitle=Opening \
    --field=bodySource="The site **opens** today." --publish

/fr/news/opening produit maintenant le rendu de content/news.html.twig, qui reçoit le contenu normalisé :

<h1>{{ content.excerptTitle }}</h1>
{{ content.bodyHtml|raw }}  {# the only value printed unescaped: it is purified on every read #}

Contribuer

Les contributions sont les bienvenues sur le monodépôt de PHIL : lisez le guide de contribution et le code de conduite. Signalez une vulnérabilité en privé, comme l'explique la politique de sécurité, jamais dans un ticket public.

Licence

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Parler Haut Interagir Librement project. Voir LICENSE.

Sulu est lu comme un motif, pour son modèle et ses tests.