Download the PHP package danilovl/entity-traits-bundle without Composer

EntityTraitsBundle

Symfony bundle providing 410 Doctrine ORM trait variants across 21 categories — plus interfaces, listeners, filters, validators and attributes — to eliminate the boilerplate that gets copy-pasted across every entity (id, createdAt, updatedAt, slug, active, deletedAt, …).

Requirements

• PHP 8.5+
• Symfony 8.0
• Doctrine ORM 3.0

Installation

If you are not using Symfony Flex, register the bundle in config/bundles.php:

Then create config/packages/danilovl_entity_traits.yaml:

Required vs Optional variants

Every trait and *AwareInterface ships in two variants, mirroring whether the underlying field is mandatory or optional at the database level:

Pick whichever matches your column constraint. You can mix freely within an entity:

The same split applies to interfaces under Contract/Required/<Group>/ and Contract/Optional/<Group>/. Listeners and filters in this bundle accept both variants — they instanceof-check both contract namespaces internally, so user entities are free to pick either side.

Quick start

That's an entity with 11 columns and 30+ helper methods (getCreatedAt(), setSlug(), publish(), isPublished(), incrementViewsCount(), …) without writing a single field by hand.

The bundle's listeners do the rest:

• TimestampableListener populates createdAt / updatedAt in the configured timezone.
• SluggableListener generates the slug from title / name when empty.
• BlameableListener sets createdBy / updatedBy from the current Security user (object or string identifier).
• SoftDeletableListener converts $em->remove($entity) into UPDATE … SET deleted_at = NOW().
• RequestContextListener populates ipAddress / userAgent from the current Request.
• LastLoginAtListener updates lastLoginAt on LoginSuccessEvent.
• RevisionListener increments revision on every onFlush update.
• TreePathListener rebuilds materialized path / depth for entities marked with #[Tree].
• TagsNormalizationListener trims, lowercases and dedupes tags arrays.
• AutoIdentifierListener fills properties marked with #[AutoToken], #[AutoUuid], #[AutoUlid], #[AutoIdentifier].

Trait catalog

205 Optional + 205 Required = 410 trait variants across 21 categories. Every trait has a paired *AwareInterface under Contract/Required/<Group>/ and Contract/Optional/<Group>/.

Conventions

Attributes

Validators

All validators are registered as services with the validator.constraint_validator tag — Symfony's validator pipeline picks them up automatically.

Doctrine SQL filters

soft_delete is registered automatically when soft_delete.filter_auto_enable: true (the default). The remaining filters must be registered manually.

To disable auto-registration of SoftDeleteFilter:

To register the other filters manually:

Enums

• Gender — Male, Female, NonBinary, Other, PreferNotToSay
• IdentityStrategy — Int, Uuid, Ulid
• WorkflowState — Draft, Pending, InReview, Approved, Published, Rejected, Archived, Cancelled
• RobotsDirective — Index, NoIndex, Follow, NoFollow, IndexFollow, NoIndexNoFollow, NoArchive, NoSnippet

Configuration as a service

Bundle config flows into a typed, autowireable EntityTraitsConfig value object:

Timestampable timezone

All auto-timestamps are converted to the configured timezone before being stored:

TimestampableListener calls $clock->now()->setTimezone(new DateTimeZone($config->timestampableTimezone)) — so the stored DateTimeImmutable carries the correct offset even when the app server is in UTC.

Slug source override

By default SluggableListener uses the name field. To slug from title (or any other field):

Auto-identifier with configured strategy

#[AutoIdentifier] generates a UUID or ULID depending on identity.default_strategy, making the choice central rather than per-entity:

On prePersist, AutoIdentifierListener generates Uuid::v7() (or new Ulid) and fills the property if it is empty. For int, no generation is performed — Doctrine handles auto-increment at the database level.

Soft delete

SoftDeleteFilter is auto-registered and enabled by default (see soft_delete.filter_auto_enable). All subsequent SELECTs hide the row automatically. To include deleted rows:

If the entity also implements DeletedByAwareInterface, the listener fills deletedBy from the current Security user during the same flush.

Blameable — object vs string

By default BlameableListener stores the full UserInterface object as a Doctrine relation. Use use_username_string: true to store the username string instead, which avoids a foreign key and is useful for audit logs, microservices, or any context where the user relation is not available:

BlameableListener detects the interface variant at runtime: when use_username_string = true it calls $entity->setCreatedBy($user->getUserIdentifier()) instead of $entity->setCreatedBy($user).

The standard object-based traits (CreatedByTrait, UpdatedByTrait) remain unchanged and work as before when the flag is false.

Tree (materialized path)

TreePathListener rebuilds path (e.g. /1/4/9) and depth on every save by walking the parent chain.

Testing

Functional tests use a minimal TestKernel (under tests/Functional/Kernel/TestKernel.php) that boots only FrameworkBundle + EntityTraitsBundle so wiring scenarios can be verified in isolation.

Security traits

Prevent brute-force and track authentication state:

Tenancy traits

Add multi-tenancy scoping with a single trait:

Integration traits

Track external system references without coupling your schema to foreign systems:

Pricing traits

Separate pricing concerns from the base product:

Extended counters

Geolocation traits

Fine-grained address decomposition, separate from the combined AddressTrait:

Extended SEO

License

The EntityTraitsBundle is open-sourced software licensed under the MIT license.