Allow declaring entity listeners without having to use explicit config

[nicolas-grekas]

Thanks to PHP 8 and autoconfiguration, we should be able to replace such configs by attributes:

    App\EntityListener\ConferenceEntityListener:
        tags:
            - { name: 'doctrine.orm.entity_listener', event: 'prePersist', entity: 'App\Entity\Conference'}
            - { name: 'doctrine.orm.entity_listener', event: 'preUpdate', entity: 'App\Entity\Conference'}

(example from the-fast-track)

$container->registerAttributeForAutoconfiguration() might help.

Help wanted!

[nicolas-grekas]

Proposal:

#[AsEntityListener]
class ConferenceEntityListener
{
    private $slugger;

    public function __construct(SluggerInterface $slugger)
    {
        $this->slugger = $slugger;
    }

    // explicit style, all possible arguments listed
    #[OnEvent(event: Events::preUpdate, entity: Conference::class, lazy: true|false, entityManager: 'foo_em')]
    public function prePersist(Conference $conference, LifecycleEventArgs $event)
    {
        $conference->computeSlug($this->slugger);
    }

    // compact style: event/method and entity are inferred from the signature, no attribute is needed on the method
    public function preUpdate(Conference $conference, LifecycleEventArgs $event)
    {
        $conference->computeSlug($this->slugger);
    }
}

[ostrolucky]

I don't think all of those tags are required. We do this in one of the projects

AppBundle\EventListener\AddToQueueListener:
        tags:
            - { name: doctrine.orm.entity_listener }

class AddToQueueListener
{
    public function postPersist(Queue $entity, LifecycleEventArgs $args): void
    {
        $job = new Job('everlution:queue:process', [$entity->getId()], true, QueueManager::POSTING_QUEUE);
        $job->setMaxRetries(1);
        $job->setMaxRuntime(30);
        $args->getEntityManager()->persist($job);
        $args->getEntityManager()->flush();
    }
}

/**
 * @ORM\Entity
 * @ORM\EntityListeners({AddToQueueListener::class})
 */
class Queue implements TimestampableInterface
{
}

[nicolas-grekas]

Great! So we might only need #[AsEntityListener] to replace the explicit tag and the rest already exists!