Obtención del objeto de usuario

With a Subscription, click any sentence in the script to jump to that part of the video!

Una de las increíbles características de nuestro sitio es que puedes votar por arriba y por abajo cada respuesta. Ahora mismo, ni siquiera necesitas estar conectado para hacerlo. Vamos a cambiar eso.

Requerir el inicio de sesión para votar

Encuentra el controlador que gestiona la llamada Ajax que se realiza cuando votamos: essrc/Controller/AnswerController.php... el método answerVote(). Bien: quiero exigir al usuario que se identifique para utilizar esta ruta. Hagámoslo con una anotación... o atributo: @IsGranted... luego selecciona esa clase y dale al tabulador para que añada la declaración use que necesitamos arriba. Dentro, utilizaIS_AUTHENTICATED_REMEMBERED:

            
            54 lines
            
            src/Controller/AnswerController.php
        
                                                    ... lines 1 - 8
                            
            use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
        
                                                    ... lines 10 - 13
                            
            class AnswerController extends AbstractController
        
            {
        
                                                    ... lines 16 - 29
                            
                /**
        
                                                    ... line 31
                            
                 * @IsGranted("IS_AUTHENTICATED_REMEMBERED")
        
                 */
        
                public function answerVote(Answer $answer, LoggerInterface $logger, Request $request, EntityManagerInterface $entityManager)
        
                {
        
                                                    ... lines 36 - 51
                            
                }
        
            }

Como estamos utilizando el sistema remember me, ésta es la forma correcta de comprobar si el usuario está simplemente conectado.

Si nos detenemos ahora, porque no estamos conectados, no podremos votar. Pero va a tener un aspecto extraño en el frontend porque los enlaces de votación siguen siendo visibles. Así que vamos a ocultarlos.

La plantilla para esta sección es templates/answer/_answer.html.twig. Veamos... abajo... aquí están las flechas de votación. Así que básicamente queremos ocultar toda esta sección divsi no estamos conectados. Si is_granted('IS_AUTHENTICATED_REMEMBERED'), busca el cierre div... aquí está, y añade endif:

            
            50 lines
            
            templates/answer/_answer.html.twig
        
            <li class="mb-4">
        
                                                    ... lines 2 - 12
                            
                <div class="row">
        
                                                    ... lines 14 - 20
                            
                    <div class="col-2 text-end">
        
                                                    ... line 22
                            
                        {% if is_granted('IS_AUTHENTICATED_REMEMBERED') %}
        
                        <div
        
                            class="vote-arrows"
        
                            {{ stimulus_controller('answer-vote', {
        
                                url: path('answer_vote', {
        
                                    id: answer.id
        
                                })
        
                            }) }}
        
                        >
        
                                                    ... lines 32 - 44
                            
                        </div>
        
                        {% endif %}
        
                    </div>
        
                </div>
        
            </li>

Cuando actualizamos... ¡sí! Los enlaces de votación han desaparecido.

Obtención del objeto usuario desde un controlador

En una aplicación real, cuando guardemos el voto en la base de datos, probablemente también almacenaremos quién ha votado, para evitar que un usuario vote varias veces la misma respuesta. No vamos a hacer eso ahora... pero vamos a probar algo más sencillo: vamos a registrar un mensaje que incluya la dirección de correo electrónico de quien vota.

Pero espera: ¿cómo averiguamos quién ha iniciado la sesión? En un controlador, es muy fácil: utiliza el acceso directo $this->getUser(). Compruébalo: en la parte superior, diré$logger->info('') con el mensaje

{usuario} está votando la respuesta {respuesta}

            
            59 lines
            
            src/Controller/AnswerController.php
        
                                                    ... lines 1 - 13
                            
            class AnswerController extends AbstractController
        
            {
        
                                                    ... lines 16 - 33
                            
                public function answerVote(Answer $answer, LoggerInterface $logger, Request $request, EntityManagerInterface $entityManager)
        
                {
        
                    $logger->info('{user} is voting on answer {answer}!', [
        
                                                    ... lines 37 - 38
                            
                    ]);
        
                                                    ... lines 40 - 56
                            
                }
        
            }

Pásale un segundo argumento, que se llama "contexto" del registrador. Esto no tiene relación con la seguridad... es simplemente genial. El segundo argumento es una matriz con cualquier dato extra que quieras almacenar junto con el mensaje. Por ejemplo, podemos poner answera $answer->getId():

            
            59 lines
            
            src/Controller/AnswerController.php
        
                                                    ... lines 1 - 13
                            
            class AnswerController extends AbstractController
        
            {
        
                                                    ... lines 16 - 33
                            
                public function answerVote(Answer $answer, LoggerInterface $logger, Request $request, EntityManagerInterface $entityManager)
        
                {
        
                    $logger->info('{user} is voting on answer {answer}!', [
        
                                                    ... line 37
                            
                        'answer' => $answer->getId(),
        
                    ]);
        
                                                    ... lines 40 - 56
                            
                }
        
            }

Y... si utilizas este ingenioso formato {answer}, el contexto answer se incluirá automáticamente en el mensaje. Lo veremos en un momento.

Para el user, obtén el usuario actual con $this->getUser()... es así de fácil. Esto nos dará el objeto User... y entonces podemos llamar a un método en él, como->getUserIdentifier(), que sabemos que será el correo electrónico:

            
            59 lines
            
            src/Controller/AnswerController.php
        
                                                    ... lines 1 - 13
                            
            class AnswerController extends AbstractController
        
            {
        
                                                    ... lines 16 - 33
                            
                public function answerVote(Answer $answer, LoggerInterface $logger, Request $request, EntityManagerInterface $entityManager)
        
                {
        
                    $logger->info('{user} is voting on answer {answer}!', [
        
                        'user' => $this->getUser()->getUserIdentifier(),
        
                        'answer' => $answer->getId(),
        
                    ]);
        
                                                    ... lines 40 - 56
                            
                }
        
            }

¡Genial! ¡Vamos a probar esta cosa! Primero... tenemos que iniciar la sesión - abraca_admin@example.com, contraseña tada. Y... ¡lo conseguimos! Nos redirige de nuevo a /admin/login porque, hace unos minutos, hemos intentado acceder a esto y nos ha redirigido al formulario de inicio de sesión. Así que técnicamente sigue en la sesión como nuestra "ruta de destino".

Dirígete a la página de inicio, haz clic en una pregunta... ¡y vota! En la barra de herramientas de depuración de la web, podemos ver esa llamada Ajax... e incluso podemos abrir el perfilador de esa petición haciendo clic en el enlace. Dirígete a Logs. ¡Dulce!

abraca_admin@example.com está votando la respuesta 498

Clase base del controlador personalizada

De vuelta al controlador, sabemos que $this->getUser() devolverá nuestro objeto User... lo que significa que podemos llamar a los métodos que tenga. Por ejemplo, nuestra claseUser tiene un método getEmail():

            
            59 lines
            
            src/Controller/AnswerController.php
        
                                                    ... lines 1 - 13
                            
            class AnswerController extends AbstractController
        
            {
        
                                                    ... lines 16 - 33
                            
                public function answerVote(Answer $answer, LoggerInterface $logger, Request $request, EntityManagerInterface $entityManager)
        
                {
        
                    $logger->info('{user} is voting on answer {answer}!', [
        
                        'user' => $this->getUser()->getEmail(),
        
                                                    ... line 38
                            
                    ]);
        
                                                    ... lines 40 - 56
                            
                }
        
            }

Así que esto funcionará. Pero fíjate en que mi editor no ha autocompletado eso. ¡Qué pena!

Mantén pulsado Command o Ctrl y haz clic en getUser(). Esto nos hace saltar al núcleoAbstractController. Ah... el método anuncia que devuelve un UserInterface, ¡lo cual es cierto! Pero, más concretamente, sabemos que devolverá nuestra entidad User. Desgraciadamente, como este método no lo dice, no obtenemos un buen autocompletado.

Yo uso mucho $this->getUser() en mis controladores... así que me gusta "arreglar" esto ¿Cómo? Creando una clase base de controlador personalizada. Dentro del directorio Controller/, crea una nueva clase llamada BaseController.

Puedes hacer que sea abstract... porque nunca la usaremos directamente. Hazla extendida AbstractController para que tengamos los métodos normales de acceso directo:

            
            10 lines
            
            src/Controller/BaseController.php
        
                                                    ... lines 1 - 2
                            
            namespace App\Controller;
        
            use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
        
            abstract class BaseController extends AbstractController
        
            {
        
            }

Crear un controlador base personalizado es... una buena idea: puedes añadir los métodos abreviados adicionales que quieras. Luego, en tus controladores reales, extiendes esto y... ¡diviértete! Ahora mismo sólo voy a hacer esto en AnswerController... sólo para ahorrar tiempo:

            
            60 lines
            
            src/Controller/AnswerController.php
        
                                                    ... lines 1 - 14
                            
            class AnswerController extends BaseController
        
            {
        
                                                    ... lines 17 - 58
                            
            }

De todos modos, si nos detenemos ahora... ¡felicidades! Esto no cambia nada porqueBaseController extiende AbstractController. Para resolver nuestro problema, no necesitamos añadir un nuevo método abreviado... sólo tenemos que dar a nuestro editor una pista para que sepa que getUser() devuelve nuestro objeto User... y no sólo un UserInterface.

Para ello, encima de la clase, añade @method y luego User y getUser():

            
            14 lines
            
            src/Controller/BaseController.php
        
                                                    ... lines 1 - 4
                            
            use App\Entity\User;
        
                                                    ... lines 6 - 7
                            
            /**
        
             * @method User getUser()
        
             */
        
            abstract class BaseController extends AbstractController
        
            {
        
            }

¡Hecho! De nuevo en AnswerController, vuelve a escribir getEmail() y... ¡sí! ¡Obtenemos el autocompletado!

¡Genial! Así que la forma de obtener el usuario actual en un controlador es $this->getUser(). Pero hay algunos otros lugares en los que podríamos necesitar hacer esto, como en Twig o desde un servicio. Vamos a verlos a continuación.

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=8.1",
        "ext-ctype": "*",
        "ext-iconv": "*",
        "babdev/pagerfanta-bundle": "^3.3", // v3.3.0
        "composer/package-versions-deprecated": "^1.11", // 1.11.99.4
        "doctrine/annotations": "^1.0", // 1.13.2
        "doctrine/doctrine-bundle": "^2.1", // 2.6.3
        "doctrine/doctrine-migrations-bundle": "^3.0", // 3.1.1
        "doctrine/orm": "^2.7", // 2.10.1
        "knplabs/knp-markdown-bundle": "^1.8", // 1.9.0
        "knplabs/knp-time-bundle": "^1.11", // v1.16.1
        "pagerfanta/doctrine-orm-adapter": "^3.3", // v3.3.0
        "pagerfanta/twig": "^3.3", // v3.3.0
        "phpdocumentor/reflection-docblock": "^5.2", // 5.2.2
        "scheb/2fa-bundle": "^5.12", // v5.12.1
        "scheb/2fa-qr-code": "^5.12", // v5.12.1
        "scheb/2fa-totp": "^5.12", // v5.12.1
        "sensio/framework-extra-bundle": "^6.0", // v6.2.0
        "stof/doctrine-extensions-bundle": "^1.4", // v1.6.0
        "symfony/asset": "5.3.*", // v5.3.4
        "symfony/console": "5.3.*", // v5.3.7
        "symfony/dotenv": "5.3.*", // v5.3.8
        "symfony/flex": "^1.3.1", // v1.17.5
        "symfony/form": "5.3.*", // v5.3.8
        "symfony/framework-bundle": "5.3.*", // v5.3.8
        "symfony/monolog-bundle": "^3.0", // v3.7.0
        "symfony/property-access": "5.3.*", // v5.3.8
        "symfony/property-info": "5.3.*", // v5.3.8
        "symfony/rate-limiter": "5.3.*", // v5.3.4
        "symfony/runtime": "5.3.*", // v5.3.4
        "symfony/security-bundle": "5.3.*", // v5.3.8
        "symfony/serializer": "5.3.*", // v5.3.8
        "symfony/stopwatch": "5.3.*", // v5.3.4
        "symfony/twig-bundle": "5.3.*", // v5.3.4
        "symfony/ux-chartjs": "^1.3", // v1.3.0
        "symfony/validator": "5.3.*", // v5.3.8
        "symfony/webpack-encore-bundle": "^1.7", // v1.12.0
        "symfony/yaml": "5.3.*", // v5.3.6
        "symfonycasts/verify-email-bundle": "^1.5", // v1.5.0
        "twig/extra-bundle": "^2.12|^3.0", // v3.3.3
        "twig/string-extra": "^3.3", // v3.3.3
        "twig/twig": "^2.12|^3.0" // v3.3.3
    },
    "require-dev": {
        "doctrine/doctrine-fixtures-bundle": "^3.3", // 3.4.0
        "symfony/debug-bundle": "5.3.*", // v5.3.4
        "symfony/maker-bundle": "^1.15", // v1.34.0
        "symfony/var-dumper": "5.3.*", // v5.3.8
        "symfony/web-profiler-bundle": "5.3.*", // v5.3.8
        "zenstruck/foundry": "^1.1" // v1.13.3
    }
}

Edit on GitHub

TRACK

Symfony 5 >

COURSE

Symfony 5 Seguridad: Autenticadores

Obtención del objeto de usuario

Keep on Learning!

Requerir el inicio de sesión para votar

Obtención del objeto usuario desde un controlador

Clase base del controlador personalizada

Leave a comment!

What PHP libraries does this tutorial use?

	... lines 1 - 8
	use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
	... lines 10 - 13
	class AnswerController extends AbstractController
	{
	... lines 16 - 29
	/**
	... line 31
	* @IsGranted("IS_AUTHENTICATED_REMEMBERED")
	*/
	public function answerVote(Answer $answer, LoggerInterface $logger, Request $request, EntityManagerInterface $entityManager)
	{
	... lines 36 - 51
	}
	}

	<li class="mb-4">
	... lines 2 - 12
	<div class="row">
	... lines 14 - 20
	<div class="col-2 text-end">
	... line 22
	{% if is_granted('IS_AUTHENTICATED_REMEMBERED') %}
	<div
	class="vote-arrows"
	{{ stimulus_controller('answer-vote', {
	url: path('answer_vote', {
	id: answer.id
	})
	}) }}
	>
	... lines 32 - 44
	</div>
	{% endif %}
	</div>
	</div>
	</li>

	... lines 1 - 13
	class AnswerController extends AbstractController
	{
	... lines 16 - 33
	public function answerVote(Answer $answer, LoggerInterface $logger, Request $request, EntityManagerInterface $entityManager)
	{
	$logger->info('{user} is voting on answer {answer}!', [
	... lines 37 - 38
	]);
	... lines 40 - 56
	}
	}

	... lines 1 - 2
	namespace App\Controller;

	use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

	abstract class BaseController extends AbstractController
	{
	}

	... lines 1 - 14
	class AnswerController extends BaseController
	{
	... lines 17 - 58
	}

	... lines 1 - 4
	use App\Entity\User;
	... lines 6 - 7
	/**
	* @method User getUser()
	*/
	abstract class BaseController extends AbstractController
	{
	}