phil/content-warnings

phil/content-warnings décrit ce qu'un contenu peut avoir de difficile à aborder et laisse chaque lecteur décider de ce qui lui arrive. Un catalogue énumère les thèmes d'avertissement — gore, araignées, suicide, lumières clignotantes —, regroupés en catégories et libellés en plusieurs langues. La bibliothèque est fournie avec une liste de base d'environ soixante-dix thèmes en douze catégories, libellés en anglais, en français, en espagnol, en allemand, en italien et en portugais. Chaque application la complète, en modifie les libellés, en retire des thèmes ou la remplace par sa propre liste. Un contenu porte ses avertissements, un par thème, chacun avec une sévérité et une note facultatives. Les préférences d'un lecteur indiquent, par thème, par catégorie ou par défaut, si un contenu visé par un avertissement est affiché, replié derrière son avertissement ou masqué. Le comparateur réunit les deux en une décision par contenu.

Elle s'adresse à toute application qui publie du contenu que certains lecteurs préfèrent aborder avec précaution, ou pas du tout : un catalogue de jeux, une bibliothèque, un blogue, un calendrier d'événements, un outil de sécurité dont les lignes masquent et dont les voiles replient. C'est une simple bibliothèque PHP, sans autre dépendance que les extensions JSON et multioctet de PHP. Dans une application Symfony, tournez-vous vers phil/content-warnings-bundle, qui ajoute la configuration, la colonne Doctrine, les champs de formulaire, l'affichage replié dans Twig et un magasin de préférences.

La conception sépare les clés et les libellés. Les avertissements et les préférences désignent les thèmes et les catégories par des clés stables : les données stockées survivent donc à un libellé reformulé, et un thème qu'une application retire reste sur le contenu qui le nomme. Chaque valeur est immuable et bornée : 100 avertissements par contenu, 2 000 thèmes par catalogue.

État

Documentation

Démarrage rapide

composer require phil/content-warnings

use Phil\ContentWarnings\BaseCatalogue;
use Phil\ContentWarnings\CatalogueLoader;
use Phil\ContentWarnings\ContentWarning;
use Phil\ContentWarnings\ContentWarnings;
use Phil\ContentWarnings\Display;
use Phil\ContentWarnings\Severity;
use Phil\ContentWarnings\WarningMatcher;
use Phil\ContentWarnings\WarningPreferences;

$catalogue = new CatalogueLoader()->apply(['remove' => ['clowns']], BaseCatalogue::load());

$warnings = ContentWarnings::of(
    new ContentWarning('gore', Severity::Severe, 'The final battle'),
    new ContentWarning('spiders'),
);

$preferences = WarningPreferences::defaults(Display::Show)
    ->withCategory('phobias', Display::Fold)
    ->withTheme('gore', Display::Hide, Severity::Moderate);

$decision = new WarningMatcher($catalogue)->decide($warnings, $preferences);
$decision->display;                          // Display::Hide
$catalogue->theme('spiders')?->label('fr');  // "Araignées"

Prérequis

PHP 8.5 ou plus récent avec ext-json et ext-mbstring.

Contribuer

Les contributions sont les bienvenues sur le monodépôt 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.