src/EventSubscriber/SonataAdmin/AbstractAdminSubscriber.php line 131

Open in your IDE?
  1. <?php
  3. namespace App\EventSubscriber\SonataAdmin;
  5. use App\Contract\EventSubscriber\SonataAdmin\ConfigureDataGridInterface;
  6. use App\Contract\EventSubscriber\SonataAdmin\ConfigureFormInterface;
  7. use App\Contract\EventSubscriber\SonataAdmin\ConfigureListInterface;
  8. use App\Contract\EventSubscriber\SonataAdmin\ConfigureShowInterface;
  9. use App\Contract\EventSubscriber\SonataAdmin\PostPersistInterface;
  10. use App\Contract\EventSubscriber\SonataAdmin\PostRemoveInterface;
  11. use App\Contract\EventSubscriber\SonataAdmin\PostUpdateInterface;
  12. use App\Contract\EventSubscriber\SonataAdmin\PrePersistInterface;
  13. use App\Contract\EventSubscriber\SonataAdmin\PreRemoveInterface;
  14. use App\Contract\EventSubscriber\SonataAdmin\PreUpdateInterface;
  15. use Sonata\AdminBundle\Admin\AdminInterface;
  16. use Sonata\AdminBundle\Event\ConfigureEvent;
  17. use Sonata\AdminBundle\Event\PersistenceEvent;
  18. use Sonata\AdminBundle\Datagrid\ListMapper;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  21. /**
  22.  * Class AbstractAdminSubscriber.
  23.  *
  24.  * @method void configureForm(AdminInterface $admin, FormMapper $formMapper): void
  25.  * @method void configureList(AdminInterface $admin, ListMapper $listMapper): void
  26.  * @method void configureDataGrid(AdminInterface $admin, DatagridMapper $dataGridMapper): void
  27.  * @method void configureShow(AdminInterface $admin, ShowMapper $showMapper): void
  28.  * @method void preUpdate(AdminInterface $admin, object $entity): void
  29.  * @method void postUpdate(AdminInterface $admin, object $entity): void
  30.  * @method void prePersist(AdminInterface $admin, object $entity): void
  31.  * @method void postPersist(AdminInterface $admin, object $entity): void
  32.  * @method void preRemove(AdminInterface $admin, object $entity): void
  33.  * @method void postRemove(AdminInterface $admin, object $entity): void
  34.  */
  35. abstract class AbstractAdminSubscriber implements EventSubscriberInterface
  36. {
  38.     public static function getSubscribedEvents(): array
  39.     {
  40.         return [
  41.             'sonata.admin.event.configure.form' => 'onConfigureForm',
  42.             'sonata.admin.event.configure.list' => 'onConfigureList',
  43.             'sonata.admin.event.configure.show' => 'onConfigureShow',
  44.             'sonata.admin.event.configure.datagrid' => 'onConfigureDataGrid',
  45.             'sonata.admin.event.persistence.pre_update' => 'onPreUpdate',
  46.             'sonata.admin.event.persistence.post_update' => 'onPostUpdate',
  47.             'sonata.admin.event.persistence.pre_persist' => 'onPrePersist',
  48.             'sonata.admin.event.persistence.post_persist' => 'onPostPersist',
  49.             'sonata.admin.event.persistence.pre_remove' => 'onPreRemove',
  50.             'sonata.admin.event.persistence.post_remove' => 'onPostRemove',
  51.         ];
  52.     }
  54.     /**
  55.      * Helper method to indicate whether or not a subscriber callback should be invoked.
  56.      *
  57.      * @param \Sonata\AdminBundle\Admin\AdminInterface $admin
  58.      *   The instance of the currently loaded admin
  59.      *
  60.      * @return bool
  61.      *   The result check
  62.      */
  63.     abstract public function supports(AdminInterface $admin): bool;
  65.     /**
  66.      * Responsible for providing form configuration.
  67.      *
  68.      * @param \Sonata\AdminBundle\Event\ConfigureEvent $event
  69.      *   The instance of the dispatched event
  70.      */
  71.     final public function onConfigureForm(ConfigureEvent $event): void
  72.     {
  73.         if (!$this instanceof ConfigureFormInterface || !$this->supports($event->getAdmin())) {
  74.             return;
  75.         }
  77.         $this->configureForm($event->getAdmin(), $event->getMapper());
  78.     }
  80.     /**
  81.      * Responsible for providing list configuration.
  82.      *
  83.      * @param \Sonata\AdminBundle\Event\ConfigureEvent $event
  84.      *   The instance of the dispatched event
  85.      */
  86.     final public function onConfigureList(ConfigureEvent $event): void
  87.     {
  88.         if (!$this instanceof ConfigureListInterface || !$this->supports($event->getAdmin())) {
  89.             return;
  90.         }
  92.         $this->configureList($event->getAdmin(), $event->getMapper());
  93.     }
  95.     /**
  96.      * Responsible for providing data grid configuration.
  97.      *
  98.      * @param \Sonata\AdminBundle\Event\ConfigureEvent $event
  99.      *   The instance of the dispatched event
  100.      */
  101.     final public function onConfigureDataGrid(ConfigureEvent $event): void
  102.     {
  103.         if (!$this instanceof ConfigureDataGridInterface || !$this->supports($event->getAdmin())) {
  104.             return;
  105.         }
  107.         $this->configureDataGrid($event->getAdmin(), $event->getMapper());
  108.     }
  110.     /**
  111.      * Responsible for providing entity show configuration.
  112.      *
  113.      * @param \Sonata\AdminBundle\Event\ConfigureEvent $event
  114.      *   The instance of the dispatched event
  115.      */
  116.     final public function onConfigureShow(ConfigureEvent $event): void
  117.     {
  118.         if (!$this instanceof ConfigureShowInterface || !$this->supports($event->getAdmin())) {
  119.             return;
  120.         }
  122.         $this->configureShow($event->getAdmin(), $event->getMapper());
  123.     }
  125.     /**
  126.      * Responsible for providing a hook right before an entity is updated.
  127.      *
  128.      * @param \Sonata\AdminBundle\Event\PersistenceEvent $event
  129.      *   The instance of the dispatched event
  130.      */
  131.     final public function onPreUpdate(PersistenceEvent $event): void
  132.     {
  133.         if (!$this instanceof PreUpdateInterface || !$this->supports($event->getAdmin())) {
  134.             return;
  135.         }
  137.         $this->preUpdate($event->getAdmin(), $event->getObject());
  138.     }
  140.     /**
  141.      * Responsible for providing a hook right after an entity is updated.
  142.      *
  143.      * @param \Sonata\AdminBundle\Event\PersistenceEvent $event
  144.      *   The instance of the dispatched event
  145.      */
  146.     final public function onPostUpdate(PersistenceEvent $event): void
  147.     {
  148.         if (!$this instanceof PostUpdateInterface || !$this->supports($event->getAdmin())) {
  149.             return;
  150.         }
  152.         $this->postUpdate($event->getAdmin(), $event->getObject());
  153.     }
  155.     /**
  156.      * Responsible for providing a hook right before an entity is created.
  157.      *
  158.      * @param \Sonata\AdminBundle\Event\PersistenceEvent $event
  159.      *   The instance of the dispatched event
  160.      */
  161.     final public function onPrePersist(PersistenceEvent $event): void
  162.     {
  163.         if (!$this instanceof PrePersistInterface || !$this->supports($event->getAdmin())) {
  164.             return;
  165.         }
  167.         $this->prePersist($event->getAdmin(), $event->getObject());
  168.     }
  170.     /**
  171.      * Responsible for providing a hook right after an entity is created.
  172.      *
  173.      * @param \Sonata\AdminBundle\Event\PersistenceEvent $event
  174.      *   The instance of the dispatched event
  175.      */
  176.     final public function onPostPersist(PersistenceEvent $event): void
  177.     {
  178.         if (!$this instanceof PostPersistInterface || !$this->supports($event->getAdmin())) {
  179.             return;
  180.         }
  182.         $this->postPersist($event->getAdmin(), $event->getObject());
  183.     }
  185.     /**
  186.      * Responsible for providing a hook right before an entity is removed.
  187.      *
  188.      * @param \Sonata\AdminBundle\Event\PersistenceEvent $event
  189.      *   The instance of the dispatched event
  190.      */
  191.     final public function onPreRemove(PersistenceEvent $event): void
  192.     {
  193.         if (!$this instanceof PreRemoveInterface || !$this->supports($event->getAdmin())) {
  194.             return;
  195.         }
  197.         $this->preRemove($event->getAdmin(), $event->getObject());
  198.     }
  200.     /**
  201.      * Responsible for providing a hook right after an entity is removed.
  202.      *
  203.      * @param \Sonata\AdminBundle\Event\PersistenceEvent $event
  204.      *   The instance of the dispatched event
  205.      */
  206.     final public function onPostRemove(PersistenceEvent $event): void
  207.     {
  208.         if (!$this instanceof PostRemoveInterface || !$this->supports($event->getAdmin())) {
  209.             return;
  210.         }
  212.         $this->postRemove($event->getAdmin(), $event->getObject());
  213.     }
  214. }