phil/enums-bundle

phil/enums-bundle est l'intégration Symfony de phil/enums. Il traduit les cas d'une enum selon leurs métadonnées Label et Description. Les champs de formulaire n'offrent qu'un sous-ensemble d'une enum (un groupe, une liste, les cas qui ont une méta-valeur donnée) ou contiennent des données EnumSet, et une contrainte de validation accepte exactement ce sous-ensemble. Twig reçoit des fonctions, des filtres et des badges. Un extracteur de traductions, une commande debug:enums et un export TypeScript servent le développeur. JSON Schema, un normaliseur du sérialiseur et des types de colonne Doctrine pour les ensembles d'enums servent les contrats d'API et le stockage.

Il s'adresse aux applications Symfony dont les enums se rendent à l'écran, à la base de données ou à une API. Il ne fait pas correspondre un cas unique à la base de données, car enumType de Doctrine le fait déjà. Il ne lit pas non plus les cas d'une requête : le résolveur d'arguments de Symfony s'en charge, et le #[ParseEnum] de ce bundle le fait avec plus de souplesse. Hors de Symfony, phil/enums seul fournit les traits et les attributs.

Ce qui varie d'une enum à l'autre se déclare sur l'enum elle-même, avec les attributs de phil/enums. La configuration indique seulement où les commandes cherchent, quelles colonnes d'ensemble existent et quelles enums sont des workflows. Les intégrations facultatives s'activent lorsque leur paquet est installé : la console, le sérialiseur, le langage d'expression, Symfony Workflow, API Platform, NelmioApiDoc et le maker.

État

Documentation

Démarrage rapide

composer require phil/enums-bundle

#[Meta(Label::class, Group::class)]
enum OrderStatus: string implements TranslatableInterface
{
    use AsMetadatableEnumTrait;
    use AsTranslatableEnumTrait;

    #[Label('Pending')] #[Group('customer')]
    case PENDING = 'pending';

    #[Label('Cancelled')]
    case CANCELLED = 'cancelled';
}

// A field that offers the customer's statuses, labelled in the user's language
$builder->add('status', EnumType::class, ['class' => OrderStatus::class, 'group' => 'customer']);

// The constraint that accepts the same subset
#[EnumCase(OrderStatus::class, inGroup: 'customer')]
public ?OrderStatus $status = null;

Prérequis

PHP 8.5 ou plus récent avec ext-mbstring et ext-tokenizer, phil/enums, et les composants de formulaire et de validation ainsi que les contrats de traduction de Symfony 8.2 ; Twig 3.21 ou plus récent pour la partie Twig. Facultatifs : symfony/translation, symfony/console, symfony/serializer, doctrine/dbal, doctrine/orm, symfony/http-kernel, symfony/expression-language et symfony/workflow, API Platform, NelmioApiDoc et MakerBundle, pour les parties qui en ont besoin.

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.