I am working on an application using Symfony 3 and Twig templates. I have created forms using symfony formBuilder. I need to run a php script every time a row is inserted in database. Is there anyway that I can do this ?
yes of course, you can use the Events and Event Listeners https://symfony.com/doc/current/event_dispatcher.html or Doctrine Event Listeners and Subscribers https://symfony.com/doc/current/doctrine/event_listeners_subscribers.html
First, to run a script, you can use the Process component of Symfony.
Here is an example of usage:
$phpBinaryFinder = new PhpExecutableFinder();
$phpBinaryPath = $phpBinaryFinder->find();
$process = new Process("{$phpBinaryPath} worker.php");
$process->run();
You should read the related doc for more insights.
Then you want to hook after the flush of doctrine, then use an event listener. It's a class with a specific method that you register as a service.
You need to define a class:
namespace App\EventListener;
use Doctrine\ORM\Event\PostFlushEventArgs;
use Doctrine\ORM\Event\LifecycleEventArgs;
class YourListener
{
private $persisted = [];
public function postPersist(LifecycleEventArgs $args)
{
$entity = $args->getEntity();
if (!$entity instanceof YourRecord) {
return;
}
$this->persisted[] = $entity;
}
public function postFlush(PostFlushEventArgs $args)
{
foreach ($persisted as $row) {
// Execute your action for the given row
}
}
}
Then you need to register it as service:
# services.yaml
services:
App\EventListener\YourListener:
tags:
- { name: doctrine.event_listener, event: postPersist }
- { name: doctrine.event_listener, event: postFlush }
Check the related documentation: https://symfony.com/doc/current/doctrine/event_listeners_subscribers.html
app/config/services.yml
services:
myApp.event_listener:
class: Test\EventListener\MyListener
tags:
- { name: myApp.event_listener, event: onDoSomething }
namespace Test\EventListener
use Test\Event\MyEvent;
class MyListener
{
public function onDoSomething(MyEvent $event)
{
echo "I m on listener";
}
}
namespace Test\Event;
use TEST\Entity\MyEntity;
use Symfony\Component\EventDispatcher\Event;
class MyEvent extends Event
{
const DO_SOMETHING = 'event.do_something';
protected $myEntity;
public function __construct(MyEntity $myEntity)
{
$this->myEntity = $myEntity;
}
public function getMyEntity()
{
return $this->myEntity;
}
}
From Controller:
$dispatcher = new EventDispatcher();
$dispatcher->dispatch(MyEvent::DO_SOMETHING, new Event());
Can you guy help why it can't add this event into the listener?
please read the documentation about event listener . Depending on the event you want to listen you will need to fix your tag declaration in the service definition. This is an example if you want to listen to a kernel event:
yaml
# app/config/services.yml
services:
app.exception_listener:
class: AppBundle\EventListener\ExceptionListener
tags:
- { name: kernel.event_listener, event: kernel.exception }
If you want to listen to a custom event, you need to create an appropriate event class beforehand and maybe using the method attribute of the tag definition, as described in the docs:
There is an optional tag attribute called method which defines which method to execute when the event is triggered. By default the name of the method is on + "camel-cased event name". If the event is kernel.exception the method executed by default is onKernelException().
If you want to create and dispatch your own event, please read the documentation about the EventDispatcher component.
You will need to fix several issues in your code!
the service definition of your event listener should use the tag name kernel.event_listener and the name of your event (MyEvent::DO_SOMETHING) which is event.do_something:
services:
myApp.event_listener:
class: Test\EventListener\MyListener
tags:
- { name: kernel.event_listener, event: event.do_something }
The method in your listener which would be called without specifying the method parameter is onEventDoSomething
use Test\Event\MyEvent;
class MyListener
{
public function onEventDoSomething(MyEvent $event)
{
echo "I m on listener";
}
}
In your controller you should get the dispatcher from the container, create an instance of your MyEvent class and pass the entity it (see the Events constructor):
/** #var $dispatcher EventDispatcherInterface */
$dispatcher = $this->get('event_dispatcher');
$event = new MyEvent($myEntity);
$dispatcher->dispatch(MyEvent::DO_SOMETHING, $event);
As #Cerad commented: if you want to create a new dispatcher instance you do not need the service definition, but you would need to add the listener to the new dispatcher:
// create dispatcher and add listener to it
$dispatcher = new EventDispatcher();
$listener = new MyListener();
$dispatcher->addListener('event.do_something', array($listener, 'onEventDoSomething'));
// dispatch event
$event = new MyEvent($myEntity);
$dispatcher->dispatch(MyEvent::DO_SOMETHING, $event);
I have this event listener below, but it is not working:
<?php
namespace Project\BackendBundle\EventListener;
//src/Project/BackendBundle/EventListener/ClippedImagesManager.php
use Doctrine\ORM\Event\LifecycleEventArgs;
use Doctrine\ORM\Event\PostFlushEventArgs;
use Project\BackendBundle\Entity\Subitem;
class ClippedImagesManager
{
public function preUpdate(LifecycleEventArgs $args)
{
die("Event listener!!!");
}
//src/Project/BackendBundle/Resources/config/services.yml
services:
project.clipped_images_manager:
class: Project\BackendBundle\EventListener\ClippedImagesManager
tags:
- { name: doctrine.event_listener, event: preUpdate }
I expected "Event listener!!" was fired when updating any entity inside BackendBundle.
I had a similar issue before.
Stripped off example below is same as yours but to see the full working example visit the post please. The trick is, persisting after preUpdate() within postFlush() event.
Note: Although this might not be the best solution, it could be done with an Event Subscriber or simple onFlush() -> $uow->getScheduledEntityUpdates() in an Event Listener.
Service.yml
services:
entity.event_listener.user_update:
class: Site\FrontBundle\EventListener\Entity\UserUpdateListener
tags:
- { name: doctrine.event_listener, event: preUpdate }
Event Listener
<?php
namespace Site\FrontBundle\EventListener\Entity;
use Doctrine\ORM\Event\LifecycleEventArgs;
use Site\FrontBundle\Entity\User;
class UserUpdateListener
{
public function preUpdate(LifecycleEventArgs $args)
{
$entity = $args->getEntity();
// False check is compulsory otherwise duplication occurs
if (($entity instanceof User) === false) {
// Do something
}
}
}
Im trying to implement my custom exception listener that is derived from Symfony's default exception listener. The minimal code is:
use Symfony\Component\HttpKernel\EventListener\ExceptionListener as SymfonyExceptionListener;
namespace MyCompany\MyBundle\EventListener;
class ExceptionListener extends SymfonyExceptionListener {
public function __construct( $controller, LoggerInterface $logger = null ) {
parent::__construct( $controller, $logger );
}
public static function getSubscribedEvents() {
// The parent class has priority -128
return array(
KernelEvents::EXCEPTION => array( 'onKernelException', -64 ),
);
}
}
Obviously, I need to inject the controller and the logger into the constructor and this is where my problem starts. According to the documentation, I need to register the service via:
services:
kernel.listener.custom_exception_listener:
class: MyCompany\MyBundle\EventListener\ExceptionListener
arguments: []
tags:
- { name: kernel.event_listener, event: kernel.exception, method: onKernelException, priority: -64 }
What do I need to put into arguments: []? It must be something along the lines "#controller #logger-service" but I could not find the correct names anywhere.
Registering custom exception listener in on hand - is just registering some listener. The minimum code here is:
class ExceptionListener
{
public function listenExceptions(GetResponseForExceptionEvent $event)
{
// Some event management
}
}
And config:
services:
kernel.listener.custom_exception_listener:
class: MyCompany\MyBundle\EventListener\ExceptionListener
tags:
- { name: kernel.event_listener, event: kernel.exception, method: listenExceptions, priority: -64 }
So to register listener you shouldn't extend something or inject services.
In other hand, you might need some services to handle an event (logger or mailer). In that case you should create constructor and inject services that you're going to use.
If you wanna extend Symfony2 ExceptionListener (which is Subscriber), %twig.exception_listener.controller% and #logger are default parameters for Symfony2 exception listener
I want add new Feed item on entity persist and update. I write this event listener (postUpdate is same):
public function postPersist(LifecycleEventArgs $args)
{
$entity = $args->getEntity();
$em = $args->getEntityManager();
if ($entity instanceof FeedItemInterface) {
$feed = new FeedEntity();
$feed->setTitle($entity->getFeedTitle());
$feed->setEntity($entity->getFeedEntityId());
$feed->setType($entity->getFeedType());
if($entity->isFeedTranslatable()) {
$feed->getEnTranslation()->setTitle($entity->getFeedTitle('en'));
}
$em->persist($feed);
$em->flush();
}
}
But I got
Integrity constraint violation: 1062 Duplicate entry '30-2' for key
'PRIMARY'
and in log a have two insertations:
INSERT INTO interview_scientificdirection (interview_id,
scientificdirection_id) VALUES (?, ?) ([30,2]) INSERT INTO
interview_scientificdirection (interview_id, scientificdirection_id)
VALUES (?, ?) ([30,2])
scientificdirection is Many to Many relationship table for entity what we want to persist.
In frontend application everything work fine, but in Sonata Admin I got this problem :(
If you need to persist additional objects, the postPersist or postUpdate handler in Doctrine is, sadly, not the right place to go. I struggled with the same problem today, as I needed to generate some message entries in that handler.
The problem at this point is that the postPersist handler is called during the flush event, and not after. So you can't persist additional objects here, as they are not getting flushed afterwards. Additionally, you can't call flush during an postPersist handler, as this might lead to ducplicate entries (as you have experienced).
One way to go is using the onFlush handler from doctrine, documented here: https://www.doctrine-project.org/projects/doctrine-orm/en/2.7/reference/events.html#onflush
This is just problematic if you need the inserted ids of the database object, as the entity hasn't yet been written to the database in that handler. If you don't need those ids, you are fine with the onFlush event in doctrine.
For me, the solution was a little different. I'm currently working on a symfony2 project, and needed the ids of the inserted database objects (for callbacks and updates later on).
I created a new service in symfony2, which basically just acts like a queue for my messages. During the postPersist update, I just fill the entries in the queue. I have another handler registered on kernel.response, which then takes those entries and persists them to the database. (Something along the line of this: http://symfony.com/doc/current/cookbook/service_container/event_listener.html)
I hope I don't digress too much from the topic here, but as it is something I really struggled with, I hope that some people might find this useful.
The service entries for this are:
amq_messages_chain:
class: Acme\StoreBundle\Listener\AmqMessagesChain
amqflush:
class: Acme\StoreBundle\Listener\AmqFlush
arguments: [ #doctrine.orm.entity_manager, #amq_messages_chain, #logger ]
tags:
- { name: kernel.event_listener, event: kernel.response, method: onResponse, priority: 5 }
doctrine.listener:
class: Acme\StoreBundle\Listener\AmqListener
arguments: [ #logger, #amq_messages_chain ]
tags:
- { name: doctrine.event_listener, event: postPersist }
- { name: doctrine.event_listener, event: postUpdate }
- { name: doctrine.event_listener, event: prePersist }
You can't use the doctrine.listener for this, as this leads to a circular dependency (as you need the entity manager for the service, but the entity manager needs the service....)
That worked like a charm. If you need more info on that, don't hesitate to ask, I'm glad to add some examples to this.
The answer from Francesc is wrong, as the changesets in the postFlush event are already empty.
The second answer of jhoffrichter could work, but is overkill.
The right way to go is to persist the entity in the postPersist event and to call flush again in the postFlush event. But you have to do this only if you changed something in the postPersist event, otherwise you create an endless loop.
public function postPersist(LifecycleEventArgs $args) {
$entity = $args->getEntity();
$em = $args->getEntityManager();
if($entity instanceof FeedItemInterface) {
$feed = new FeedEntity();
$feed->setTitle($entity->getFeedTitle());
$feed->setEntity($entity->getFeedEntityId());
$feed->setType($entity->getFeedType());
if($entity->isFeedTranslatable()) {
$feed->getEnTranslation()->setTitle($entity->getFeedTitle('en'));
}
$em->persist($feed);
$this->needsFlush = true;
}
}
public function postFlush(PostFlushEventArgs $eventArgs)
{
if ($this->needsFlush) {
$this->needsFlush = false;
$eventArgs->getEntityManager()->flush();
}
}
The solution from jhoffrichter is working very well. If you use Console Commands you should add a tag for the event command.terminate. Otherwise it is not working inside Console Commands. See https://stackoverflow.com/a/19737608/1526162
config.yml
amq_messages_chain:
class: Acme\StoreBundle\Listener\AmqMessagesChain
amqflush:
class: Acme\StoreBundle\Listener\AmqFlush
arguments: [ #doctrine.orm.entity_manager, #amq_messages_chain, #logger ]
tags:
- { name: kernel.event_listener, event: kernel.response, method: onResponse, priority: 5 }
- { name: kernel.event_listener, event: command.terminate, method: onResponse }
doctrine.listener:
class: Acme\StoreBundle\Listener\AmqListener
arguments: [ #logger, #amq_messages_chain ]
tags:
- { name: doctrine.event_listener, event: postPersist }
- { name: doctrine.event_listener, event: postUpdate }
- { name: doctrine.event_listener, event: prePersist }
Well, heres how i have done in SF 2.0 and 2.2:
Listener class:
<?php
namespace YourNamespace\EventListener;
use Doctrine\ORM\Mapping\PostPersist;
/*
* ORMListener class
*
* #author: Marco Aurélio Simão
* #description: Listener para realizar operações em qualquer objeto manipulado pelo Doctrine 2.2
*/
use Doctrine\ORM\UnitOfWork;
use Doctrine\ORM\Event\OnFlushEventArgs;
use Doctrine\Common\EventArgs;
use Doctrine\ORM\Mapping\PrePersist;
use Doctrine\ORM\Event\PostFlushEventArgs;
use Doctrine\ORM\Mapping\PostUpdate;
use Doctrine\ORM\Event\PreUpdateEventArgs;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Event\PreFlushEventArgs;
use Enova\EntitiesBundle\Entity\Entidades;
use Doctrine\ORM\Event\LifecycleEventArgs;
use Enova\EntitiesBundle\Entity\Tagged;
use Enova\EntitiesBundle\Entity\Tags;
class ORMListener
{
protected $extra_update;
public function __construct($container)
{
$this->container = $container;
$this->extra_update = false;
}
public function onFlush(OnFlushEventArgs $args)
{
$securityContext = $this->container->get('security.context');
$em = $args->getEntityManager();
$uow = $em->getUnitOfWork();
$cmf = $em->getMetadataFactory();
foreach ($uow->getScheduledEntityInsertions() AS $entity)
{
$meta = $cmf->getMetadataFor(get_class($entity));
$this->updateTagged($em, $entity);
}
foreach ($uow->getScheduledEntityUpdates() as $entity)
{
$meta = $cmf->getMetadataFor(get_class($entity));
$this->updateTagged($em, $entity);
}
}
public function updateTagged($em, $entity)
{
$entityTags = $entity->getTags();
$a = array_shift($entityTags);
//in my case, i have already sent the object from the form, but you could just replace this part for new Object() etc
$uow = $em->getUnitOfWork();
$cmf = $em->getMetadataFactory();
$meta = $cmf->getMetadataFor(get_class($a));
$em->persist($a);
$uow->computeChangeSet($meta, $a);
}
}
Config.yml:
services:
updated_by.listener:
class: YourNamespace\EventListener\ORMListener
arguments: [#service_container]
tags:
- { name: doctrine.event_listener, event: onFlush, method: onFlush }
Hope it helps ;)