phil/enums-bundle

phil/enums-bundle is the Symfony integration of phil/enums. It translates enum cases by their Label and Description metadata. Form fields offer only a subset of an enum (a group, a list, the cases with a given meta value) or hold EnumSet data, and a validator constraint accepts exactly that subset. Twig gets functions, filters and badges. A translation extractor, a debug:enums command and a TypeScript export serve the developer. JSON Schema, a serializer normalizer and Doctrine column types for enum sets serve API contracts and storage.

It is for Symfony applications whose enums reach the screen, the database or an API. It does not map a single case to the database, since Doctrine's enumType does. It does not read cases from a request either: Symfony's argument resolver does, and this bundle's #[ParseEnum] does it more leniently. Outside Symfony, phil/enums alone gives the traits and attributes.

What varies per enum is declared on the enum itself, with the attributes of phil/enums. The configuration only says where the commands look, which set columns exist and which enums are workflows. Optional integrations wake up when their package is installed: the console, the serializer, the expression language, Symfony Workflow, API Platform, NelmioApiDoc and the maker.

Status

Documentation

Quick start

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;

Requirements

PHP 8.5 or later with ext-mbstring and ext-tokenizer, phil/enums, and Symfony 8.2's form, validator and translation contracts; Twig 3.21 or later for the Twig part. Optional: symfony/translation, symfony/console, symfony/serializer, doctrine/dbal, doctrine/orm, symfony/http-kernel, symfony/expression-language and symfony/workflow, API Platform, NelmioApiDoc and MakerBundle, for the parts that need them.

Contributing

Contributions are welcome on the PHIL monorepo: read the contribution guide and the code of conduct. Report a vulnerability privately, as the security policy explains, never in a public issue.

License

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