User Manager

In order to be storage agnostic, all operations on the user instances are handled by a user manager implementing Nucleos\UserBundle\Model\UserManagerInterface. Using it ensures that your code will continue to work if you change the storage. The controllers provided by the bundle use the configured user manager instead of interacting directly with the storage layer.

If you configure the db_driver option to orm, this service is an instance of Nucleos\UserBundle\Doctrine\UserManager.

If you configure the db_driver option to mongodb, this service is an instance of Nucleos\UserBundle\Doctrine\UserManager.

Accessing the User Manager service

The user manager is available in the container as a Nucleos\UserBundle\Model\UserManagerInterface service.

use Nucleos\UserBundle\Model\UserManagerInterface;

public function someAction(UserManagerInterface $manager)
{
    // ...
}

Creating a new User

A new instance of your User class can be created by the user manager.

$user = $userManager->createUser();

$user is now an instance of your user class.

Note

This method will not work if your user class has some mandatory constructor arguments.

Retrieving the users

The user manager has a few methods to find users based on the unique fields (username, email and confirmation token) and a method to retrieve all existing users.

findUserByUsername($username)
findUserByEmail($email)
findUserByConfirmationToken($token)
findUserBy(['id'=>$id])
findUsers()

To save a user object, you can use the updateUser method of the user manager. This method will update the encoded password field and then persist the changes.

Updating a User object

$user = $userManager->createUser();
$user->setUsername('John');
$user->setEmail('john.doe@example.com');

$userManager->updateUser($user);

Note

To make it easier, the bundle comes with a Doctrine listener handling the update of the password fields for you behind the scenes. If you always save the user through the user manager, you may want to disable it to improve performance.

# config/packages/nucleos_user.yaml
nucleos_user:
    # ...
    use_listener: false

Note

For the Doctrine implementations, the default behavior is to flush the unit of work when calling the updateUser method. You can disable the flush by passing a second argument set to false. This will then be equivalent to calling updatePassword.

An ORM example:

use Nucleos\UserBundle\Model\UserManagerInterface;

class MainController
{
    public function updateAction(UserManagerInterface $userManager, $id)
    {
        $user = // get a user from the datastore

        $user->setEmail($newEmail);

        $userManager->updateUser($user, false);

        // make more modifications to the database

        $this->getDoctrine()->getManager()->flush();
    }
}

Overriding the User Manager

You can replace the default implementation of the user manager by defining a service implementing Nucleos\UserBundle\Model\UserManagerInterface and setting its id in the configuration. The id of the default implementation is nucleos_user.user_manager.default

nucleos_user:
    # ...
    service:
        user_manager: custom_user_manager_id

Your custom implementation can extend Nucleos\UserBundle\Model\UserManager to reuse the common logic.

SecurityBundle integration

The bundle provides several implementation of Symfony\Component\Security\Core\UserProviderInterface on top of the UserManagerInterface.