Generating the User Entity¶

Ok, forget about security! Seriously! Just think about the fact that we want to store some user information in the database. To do this, we’ll need a User entity class.

That sounds like a lot of work, so let’s just use the doctrine:generate:entity app/console command:

php app/console doctrine:generate:entity

For entity shortcut name, use UserBundle:User. Remember, Doctrine uses this shortcut syntax for entities.

Give the class just 2 fields:

• username as a string
• password as a string

And of course, choose “yes” to generating the repository class. I’ll explain why these are so fabulous in a second.

Once the robots are done writing the code for us, we should have a new User class in the Entity directory of UserBundle. Let’s change the table name to be yoda_user:

// src/Yoda/UserBundle/Entity/User.php
namespace Yoda\UserBundle\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Table(name="yoda_user")
 * @ORM\Entity(repositoryClass="Yoda\UserBundle\Entity\UserRepository")
 */
class User
{
    // ... the generated properties and getter/setter functions
}

Implementing UserInterface¶

Right now, this is just a plain, regular Doctrine entity that has nothing to do with security. But, our goal is to load users from this table on login. The first step is to make your class implement a UserInterface:

// src/Yoda/UserBundle/Entity/User.php
// ...

use Symfony\Component\Security\Core\User\UserInterface;

class User implements UserInterface
{
    // ...
}

This interface requires us to have 5 methods and hey! We already have 2 of them: getUsername() and getPassword():

// src/Yoda/UserBundle/Entity/User.php
// ...

public function getUsername()
{
    return $this->username;
}

public function getPassword()
{
    return $this->password;
}

Cool! So let’s add the other 3.

First, getRoles() returns an array of roles that the user should get. For now, we’ll hardcode a single role, ROLE_USER:

// src/Yoda/UserBundle/Entity/User.php
// ...

public function getRoles()
{
    return array('ROLE_USER');
}

Second, add eraseCredentials. Keep this method blank for now. We will add some logic to this later:

public function eraseCredentials()
{
    // blank for now
}

Finally, add getSalt() and just make it return null:

public function getSalt()
{
    return null;
}

I’ll talk more about this method in a second.

Now that the User class implements UserInterface, Symfony’s authentication system will be able to use it. But before we hook that up, let’s add the yoda_user table to the database by running the doctrine:schema:update command:

php app/console doctrine:schema:update --force

Loading Users from Doctrine: security.yml¶

And for the grand finale, let’s tell the security system to use our entity class!

In security.yml, replace the encoder entry with our user class and set its value to bcrypt:

# app/config/security.yml
security:
    encoders:
        Yoda\UserBundle\Entity\User: bcrypt
    # ...

This tells Symfony that the password field on our User will be encoded using the bcrypt algorithm.

php composer.phar require ircmaxell/password-compat

"require": {
    "...": "..."
    "ircmaxell/password-compat": "~1.0.3"
},

# app/config/security.yml
security:
    # ...

    providers:
        our_database_users:
            entity: { class: UserBundle:User, property: username }

There is no user provider for user "Symfony\Component\Security\Core\User\User".

Creating and Saving Users¶