Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

  1. Home
  2. Documentation
  3. Bundles
  4. SonataAdminBundle
  5. 15. Saving hooks
WARNING: You are browsing the documentation for version 2.x which is not maintained anymore. If some of your projects are still using this version, consider upgrading.

15. Saving hooks

2.x version
Maintained
3.x current 4.x
Unmaintained
2.x

15. Saving hooks

When a SonataAdmin is submitted for processing, two events are always called. One is before any persistence layer interaction and the other is afterwards, the events are named as follows:

  • new object : prePersist($object) / postPersist($object)
  • edited object : preUpdate($object) / postUpdate($object)
  • deleted object : preRemove($object) / postRemove($object)

It is worth noting that the update events are called whenever the Admin is successfully submitted, regardless of whether there are any actual persistence layer events. This differs from the use of preUpdate and postUpdate events in DoctrineORM and perhaps some other persistence layers.

For example: if you submit an edit form without changing any of the values on the form then there is nothing to change in the database and DoctrineORM would not fire the Entity class’s own preUpdate and postUpdate events. However, your Admin class’s preUpdate and postUpdate methods are called and this can be used to your advantage.

Note

When embedding one Admin within another, for example using the sonata_type_admin field type, the child Admin’s hooks are not fired.

15.1. Example used with the FOS/UserBundle

The FOSUserBundle provides authentication features for your Symfony2 Project, and is compatible with Doctrine ORM, Doctrine ODM and Propel. See FOSUserBundle on GitHub for more information.

The user management system requires to perform specific calls when the user password or username are updated. This is how the Admin bundle can be used to solve the issue by using the preUpdate saving hook.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<?php
namespace FOS\UserBundle\Admin\Entity;

use Sonata\AdminBundle\Admin\Admin;
use FOS\UserBundle\Model\UserManagerInterface;

class UserAdmin extends Admin
{
    protected function configureFormFields(FormMapper $formMapper)
    {
        $formMapper
            ->with('General')
                ->add('username')
                ->add('email')
                ->add('plainPassword', 'text')
            ->end()
            ->with('Groups')
                ->add('groups', 'sonata_type_model', array('required' => false))
            ->end()
            ->with('Management')
                ->add('roles', 'sonata_security_roles', array( 'multiple' => true))
                ->add('locked', null, array('required' => false))
                ->add('expired', null, array('required' => false))
                ->add('enabled', null, array('required' => false))
                ->add('credentialsExpired', null, array('required' => false))
            ->end()
        ;
    }

    public function preUpdate($user)
    {
        $this->getUserManager()->updateCanonicalFields($user);
        $this->getUserManager()->updatePassword($user);
    }

    public function setUserManager(UserManagerInterface $userManager)
    {
        $this->userManager = $userManager;
    }

    /**
     * @return UserManagerInterface
     */
    public function getUserManager()
    {
        return $this->userManager;
    }
}

The service declaration where the UserManager is injected into the Admin class.

  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
    <service id="fos.user.admin.user" class="%fos.user.admin.user.class%">
    <tag name="sonata.admin" manager_type="orm" group="fos_user" />
    <argument />
    <argument>%fos.user.admin.user.entity%</argument>
    <argument />

    <call method="setUserManager">
        <argument type='service' id='fos_user.user_manager' />
    </call>
</service>

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.