Como usar o SonataUserBundle no Symfony?

O que é o SonataUserBundle e como funciona?

O SonataUserBundle é um pacote do Symfony destinado a gerenciar usuários e autenticação em um projeto. Ele é baseado no FOSUserBundle e oferece recursos extras, como integração com os componentes SonataAdminBundle e SonataEasyExtendsBundle. Com o SonataUserBundle, é possível criar usuários com diferentes níveis de permissão, como administrador e usuário comum, por exemplo, além de definir campos personalizados para o perfil de cada usuário.

Como instalar o SonataUserBundle no Symfony?

O primeiro passo para instalar o SonataUserBundle é adicionar a dependência no arquivo composer.json do projeto. Para isso, basta inserir a seguinte linha:

 "sonata-project/user-bundle": "~4.2" 

Depois disso, é preciso atualizar o composer com o comando “composer update”. Em seguida, é preciso adicionar o SonataUserBundle ao AppKernel.php do Symfony, incluindo as seguintes linhas:

   new FOSUserBundleFOSUserBundle(),

   new SonataUserBundleSonataUserBundle('FOSUserBundle'),

Por fim, é preciso criar as tabelas do banco de dados com o comando “php bin/console doctrine:schema:update –force”.

Como configurar o SonataUserBundle no Symfony?

A configuração do SonataUserBundle é feita através do arquivo config.yml do Symfony. As principais configurações envolvem a definição dos templates para as páginas de login, registro e perfil do usuário, além da inclusão de campos personalizados no formulário de registro. Por exemplo, para adicionar um campo de telefone ao formulário de registro, é preciso incluir as seguintes linhas:

   fos_user:

       registration:

           form:

              - { name: 'phone', label: 'Telefone' }

Outra configuração importante é a definição dos papéis de usuário. Com o SonataUserBundle, é possível criar diferentes papéis e atribuí-los a usuários específicos ou a grupos de usuários. Por exemplo, é possível definir um papel “ADMIN” para usuários administradores e um papel “USER” para usuários comuns.

Como criar um usuário com o SonataUserBundle?

Para criar um novo usuário com o SonataUserBundle, basta utilizar o serviço “fos_user.user_manager”, que pode ser injetado em um controlador ou outra classe do Symfony. Por exemplo, para criar um novo usuário com os campos “username”, “email” e “password” preenchidos, é preciso utilizar o seguinte código:

   $userManager = $this->get('fos_user.user_manager');

   $user        = $userManager->createUser();

   $user->setUsername('johndoe');

   $user->setEmail('johndoe@example.com');

   $user->setPlainPassword('mypassword');

   $userManager->updateUser($user);

É importante lembrar que o método “updateUser” é responsável por persistir o usuário no banco de dados.

Como autenticar um usuário com o SonataUserBundle?

A autenticação de usuários no Symfony é gerenciada pelo componente FOSUserBundle, que é utilizado pelo SonataUserBundle. Para autenticar um usuário, basta utilizar o serviço “security.authentication.manager”, que pode ser injetado em um controlador ou outra classe do Symfony. Por exemplo, para autenticar um usuário com o email e a senha informados, é preciso utilizar o seguinte código:

   $authenticationManager = $this->get('security.authentication.manager');

   $token = $authenticationManager->authenticate(new UsernamePasswordToken('johndoe@example.com', 'mypassword', 'secured_area'));

   $this->get('security.token_storage')->setToken($token);

   $this->get('session')->set('_security_secured_area', serialize($token));

Este código cria um token de autenticação com o username (email) e a senha informados e o armazena na sessão do usuário.

Como personalizar o formulário de login com o SonataUserBundle?

O formulário de login do SonataUserBundle pode ser personalizado por meio da sobrescrita do template “login.html.twig” em seu projeto. Para isso, basta criar um arquivo com esse nome em seu diretório de templates (geralmente, em “app/Resources/views/SonataUserBundle/Security”). Neste arquivo, é possível adicionar ou remover campos do formulário de login, como o campo de lembrete de senha, por exemplo.

Como customizar o perfil de usuário com o SonataUserBundle?

O perfil de usuário pode ser customizado adicionando novos campos ou removendo os existentes. Para adicionar um novo campo, é preciso definir a propriedade correspondente na entidade de usuário. Por exemplo, para adicionar um campo “phone” ao perfil do usuário, é preciso definir a propriedade “phone” na entidade “User”. Depois disso, é preciso editar o arquivo “edit.html.twig” no diretório “Sonata/UserBundle/Resources/views/Admin” e adicionar o campo “phone” ao formulário de edição de usuário.

Como adicionar permissões a um usuário com o SonataUserBundle?

As permissões de usuário no SonataUserBundle são gerenciadas pelo componente FOSUserBundle e podem ser configuradas no arquivo security.yml. Por exemplo, para definir um usuário administrador com acesso a todas as páginas do site, é preciso adicionar as seguintes linhas:

   security:

       role_hierarchy:

           ROLE_ADMIN:       [ROLE_USER, ROLE_SONATA_ADMIN]

           ROLE_SUPER_ADMIN: [ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]

       access_control:

           - { path: ^/admin, roles: ROLE_ADMIN }

Com essas configurações, o usuário com o papel “ROLE_ADMIN” terá acesso à área administrativa do site (que geralmente é protegida por login e senha).

Como gerenciar grupos de usuários com o SonataUserBundle?

O gerenciamento de grupos de usuários no SonataUserBundle é feito pelo componente FOSUserBundle. Para criar um grupo, basta utilizar o serviço “fos_user.group_manager”, que pode ser injetado em um controlador ou outra classe do Symfony. Por exemplo, para criar um novo grupo com o nome “Users” e o papel “ROLE_USER”, é preciso utilizar o seguinte código:

   $groupManager = $this->get('fos_user.group_manager');

   $group        = $groupManager->createGroup('Users');

   $group->addRole('ROLE_USER');

   $groupManager->updateGroup($group);

É importante lembrar que o método “updateGroup” é responsável por persistir o grupo no banco de dados.

Como integrar o SonataUserBundle com o SonataAdminBundle?

A integração do SonataUserBundle com o SonataAdminBundle é feita de forma automática. Se o SonataAdminBundle estiver instalado e configurado corretamente no projeto, as páginas de gerenciamento de usuários e grupos serão automaticamente adicionadas à área administrativa do site (geralmente, em “/admin”).