Le framework Symfony coupl\u00e9 \u00e0 l’ORM doctrine permet de cr\u00e9er des \u00ab\u00a0Event Listeners\u00a0\u00bb, c’est \u00e0 dire connaitre d\u00e9s qu’il y’a un \u00e9v\u00e9nement (cr\u00e9ation\/modification\/suppression) sur une entit\u00e9. C’est un outil tr\u00e8s int\u00e9ressant pour automatiser des actions quand certaines propri\u00e9t\u00e9s d’une entit\u00e9 sont mis \u00e0 jour.<\/p>\n
Prenons un exemple concret : Dans les semaines pr\u00e9c\u00e9dentes, nous avons vu comment r\u00e9cup\u00e9rer les coordonn\u00e9es d’une adresse gr\u00e2ce \u00e0 l’API google map<\/a>. Afin de limiter les appels \u00e0 l’API google map (payants si un certain quota et d\u00e9pass\u00e9) nous allons enregistrer ces coordonn\u00e9es en base de donn\u00e9es pour pouvoir les r\u00e9utiliser directement. Il nous faut cependant les enregistrer\/mettre \u00e0 jour \u00e0 chaque fois qu’une adresse est cr\u00e9e ou modifi\u00e9e. C’est ici que nous faisons intervenir les Event Listener.<\/p>\n Commen\u00e7ons par configurer nos listeners dans les services (fichiers services.yml du dossier \/app\/config\/) de symfony.<\/p>\n La configuration indique que nous allons \u00e9couter les \u00e9v\u00e9nements \u00ab\u00a0PrePersist\u00a0\u00bb et \u00ab\u00a0PreUpdate\u00a0\u00bb. Ce qui permettra d’effectuer notre action lors de la cr\u00e9ation d’une adresse et lors de sa modification. Cr\u00e9ons la classe qui va g\u00e9rer tout \u00e7a. Comme indiqu\u00e9 il s’agit du fichier : AppBundle\\EventListener\\DoctrineEvent<\/p>\n Pour appr\u00e9hender la suite, consultez les commentaires dans le code<\/p>\n De cette mani\u00e8re nos coordonn\u00e9es seront toujours \u00e0 jour. Il manque pour que l’exemple soit complet la fonction \u00ab\u00a0updateGmapData()\u00a0\u00bb de notre entit\u00e9 Contact. Cela ne concerne pas le sujet des Event Listener, mais je vous en met un exemple qui utilise bien sur la fonction \u00ab\u00a0geocodeAddress()\u00a0\u00bb d\u00e9taill\u00e9 ici<\/a><\/p>\n
\n<\/span> #...<\/span>
\n #LISTENER DOCTRINE#<\/span>
\n app.listener.doctrineevent<\/span>:
\n class<\/span>: <\/span>AppBundle\\EventListener\\DoctrineEvent
\n tags<\/span>:
\n - { name<\/span>: <\/span>doctrine.event_listener, event: <\/span>prePersist, lazy: <\/span>true }<\/span>
\n - { name<\/span>: <\/span>doctrine.event_listener, event: <\/span>preUpdate, lazy: <\/span>true }<\/span><\/div><\/div>\n
\n
\nuse<\/span> Doctrine\\Common\\EventSubscriber;<\/span>
\nuse<\/span> Doctrine\\Common\\Persistence\\Event\\LifecycleEventArgs;<\/span>
\n\/\/les adresses de nos utilisateur sont stock\u00e9s dans une entit\u00e9 "Contact"<\/span>
\nuse<\/span> AppBundle\\Entity\\Contact;<\/span>
\n
\nclass<\/span> DoctrineEvent implements<\/span> EventSubscriber {<\/span>
\n
\n public<\/span> function<\/span> getSubscribedEvents(<\/span>)<\/span> {<\/span>
\n return<\/span> array<\/span><\/a>(<\/span>'prePersist'<\/span>,<\/span> 'preUpdate'<\/span>)<\/span>;<\/span>\/\/les \u00e9v\u00e9nements \u00e9cout\u00e9s<\/span>
\n }<\/span>
\n
\n public<\/span> function<\/span> prePersist(<\/span>LifecycleEventArgs $args<\/span>)<\/span> {<\/span>
\n $entity<\/span> =<\/span> $args<\/span>-><\/span>getEntity<\/span>(<\/span>)<\/span>;<\/span>
\n \/\/Si c'est bien une entit\u00e9 Contact qui va \u00eatre "persist\u00e9"<\/span>
\n if<\/span> (<\/span>$entity<\/span> instanceof Contact)<\/span> {<\/span>
\n $entity<\/span>-><\/span>updateGmapData<\/span>(<\/span>)<\/span>;<\/span>\/\/on met \u00e0 jour les coordonn\u00e9es via l'appel \u00e0 google map<\/span>
\n }<\/span>
\n }<\/span>
\n
\n public<\/span> function<\/span> preUpdate(<\/span>LifecycleEventArgs $args<\/span>)<\/span> {<\/span>
\n $entity<\/span> =<\/span> $args<\/span>-><\/span>getEntity<\/span>(<\/span>)<\/span>;<\/span>
\n $changeset<\/span> =<\/span> $args<\/span>-><\/span>getEntityManager<\/span>(<\/span>)<\/span>-><\/span>getUnitOfWork<\/span>(<\/span>)<\/span>-><\/span>getEntityChangeSet<\/span>(<\/span>$entity<\/span>)<\/span>;<\/span>
\n \/\/Si c'est bien une entit\u00e9 Contact qui va \u00eatre modifi\u00e9<\/span>
\n if<\/span> (<\/span>$entity<\/span> instanceof Contact)<\/span> {<\/span>
\n \/\/Si il y'a eu une mise a jour sur les propri\u00e9t\u00e9s en relation avec l'adresse (ici "address", "city" et "postalCode")<\/span>
\n if<\/span> (<\/span>array_key_exists<\/span><\/a>(<\/span>"address"<\/span>,<\/span> $changeset<\/span>)<\/span> ||<\/span> array_key_exists<\/span><\/a>(<\/span>"city"<\/span>,<\/span> $changeset<\/span>)<\/span> ||<\/span> array_key_exists<\/span><\/a>(<\/span>"postalCode"<\/span>,<\/span> $changeset<\/span>)<\/span>)<\/span> {<\/span>
\n $entity<\/span>-><\/span>updateGmapData<\/span>(<\/span>)<\/span>;<\/span>\/\/on met \u00e0 jour les coordonn\u00e9es via l'appel \u00e0 google map<\/span>
\n }<\/span>
\n }<\/span>
\n }<\/span>
\n
\n}<\/span><\/div><\/div>\n
\n $data<\/span> =<\/span> \\AppBundle\\Utils\\GmapApi::<\/span>geocodeAddress<\/span>(<\/span>$this<\/span>-><\/span>getAddress<\/span>(<\/span>)<\/span> .<\/span> ' '<\/span> .<\/span> $this<\/span>-><\/span>getZipcode<\/span>(<\/span>)<\/span> .<\/span> ' '<\/span> .<\/span> $this<\/span>-><\/span>getCity<\/span>(<\/span>)<\/span>)<\/span>;<\/span>
\n $this<\/span>-><\/span>setGmapLat<\/span>(<\/span>$data<\/span>[<\/span>'lat'<\/span>]<\/span>)<\/span>;<\/span>
\n $this<\/span>-><\/span>setGmapLng<\/span>(<\/span>$data<\/span>[<\/span>'lng'<\/span>]<\/span>)<\/span>;<\/span>
\n $this<\/span>-><\/span>setGmapAddress<\/span>(<\/span>$data<\/span>[<\/span>'address'<\/span>]<\/span>)<\/span>;<\/span>
\n $this<\/span>-><\/span>setGmapPostalCode<\/span>(<\/span>$data<\/span>[<\/span>'postal_code'<\/span>]<\/span>)<\/span>;<\/span>
\n $this<\/span>-><\/span>setGmapCity<\/span>(<\/span>$data<\/span>[<\/span>'city'<\/span>]<\/span>)<\/span>;<\/span>
\n $this<\/span>-><\/span>setGmapDepartment<\/span>(<\/span>$data<\/span>[<\/span>'department'<\/span>]<\/span>)<\/span>;<\/span>