Symfony2 enable user login with either username or e-mail

In project, I am using standard Symfony2 authentication mechanism. So, by default, I created entity User and added it to security.yml file like this:

    providers:
      main:
        entity: { class: Surgeworks\CoreBundle\Entity\User, property: username}
 
    firewalls:
        login:
            pattern:  ^/admin/login$
            security: false
 
        secured_area:
            pattern:    ^/admin/
            form_login:
                check_path: /admin/login_check
                login_path: /admin/login
                always_use_default_target_path: true
                default_target_path: /admin/login_after
            logout:
                path:   /admin/logout
                target: /admin/
            #anonymous: ~
            http_basic:
                realm: "Secured Admin Area"

In meantime, the needs for project was changed and I had to implement possibility for user to insert either username or e-mail address into login form’s username field. But, I could not intercept login_check call inside controller to load username from e-mail provided and then do the login check. After some brainstorming and testing possibilities I found easy solution for that problem:

I added class UserRepository and implemented UserProvider interface:

<?php
namespace Surgeworks\CoreBundle\Entity;
use Doctrine\ORM\EntityRepository;
use Symfony\Component\Security\Core\User\UserProviderInterface;
use Symfony\Component\Security\Core\User\UserInterface;
 
class UserRepository extends EntityRepository
implements UserProviderInterface
{
   public function loadUserByUsername($username) {
     return $this->getEntityManager()
         ->createQuery('SELECT u FROM
         SurgeworksCoreBundle:User u
         WHERE u.username = :username
         OR u.email = :username')
         ->setParameters(array(
                       'username' => $username
                        ))
         ->getOneOrNullResult();
    }
 
    public function refreshUser(UserInterface $user) {
        return $this->loadUserByUsername($user->getUsername());
    }
 
    public function supportsClass($class) {
        return $class === 'Surgeworks\CoreBundle\Entity\User';
    }
 
}

And my user class looks like this:

<?php
   namespace Surgeworks\CoreBundle\Entity;
   use Doctrine\Common\Collections\ArrayCollection;
   use Symfony\Component\Security\Core\User\UserInterface;
   use Symfony\Component\Validator\Constraints as Assert;
   use Symfony\Bridge\Doctrine\Validator\Constraints as DoctrineAssert;
   use Doctrine\ORM\Mapping as ORM;
 
   /**
   * @ORM\Entity(repositoryClass="Surgeworks\CoreBundle\Entity\UserRepository")
   * @ORM\Table(name="user")
   * @DoctrineAssert\UniqueEntity(fields={"username"}, message="username.already.exist" )
   * @DoctrineAssert\UniqueEntity(fields={"email"}, message="email.already.exist" )
   */ class User implements UserInterface
     {
        /**
        * @ORM\Id
        * @ORM\Column(type="integer")
        * @ORM\GeneratedValue(strategy="AUTO")
        * @var integer $id
        */
        protected $id;
 
        /**
        * @ORM\OneToMany(targetEntity="Favorite", mappedBy="user")
        */
 
        protected $favorites;
        /**
        * @ORM\Column(type="string", length="255", name="first_name")
        *
        * @var string $firstName
        */
        protected $firstName;
 
        /**
        * @ORM\Column(type="string", length="255", name="last_name")
        *
        * @var string $lastName
        */
        protected $lastName;
 
        /**
        * @ORM\Column(type="string", length="255",unique=true)
        * @var string $email
        */
 
         protected $email;
 
        /**
        * @ORM\Column(type="string", length="255", unique=true)
        * @var string username
        */
        protected $username;
 
        /**
        * @ORM\Column(type="string", length="255")
        *
        * @var string password
        */
        protected $password;
 
       //...
}

Of course one more thing inside security.yml, remove property:username to get the whole thing work:

#...
 providers:
      main:
        entity: { class: Surgeworks\CoreBundle\Entity\User}
#...

That solved the problem. Now my users can login with e-mail or username.

Cheers!