Sesiones en Symfony

Si ves errores o quieres modificar/añadir contenidos, puedes crear un pull request. Gracias

Indice de contenido

Introducción
La session API
Manejo de datos de sesiones
Atributos

1. Introducción

El componente Symfony HttpFoundation tiene un potente y flexible subsistema de sesiones designado para proporcionar el manejo de sesiones a través de una interface orientada a objetos utilizando drivers de almacenamiento de sesiones.

Las sesiones son utilizadas a través de la implementación de Session de la interface SessionInterface.

Hay que asegurarse de no tener iniciada la sesión de PHP antes de utilizar la clase Session. Si tienes un sistema de legado de sesiones que inicia la sesión, lee este artículo.

use Symfony\Component\HttpFoundation\Session\Session;

$session = new Session();
$session->start();

// Establecer y obtener atributos de sesión
$session->set('name', 'Drak');
$session->get('name');

// Establecer mensajes flash
$session->getFlashBag()->add('notice', 'Profile updated');

// Devolver mensajes
foreach ($session->getFlashBag()->get('notice', array()) as $message) {
    echo '<div class="flash-notice">'.$message.'</div>';
}

Las sesiones de Symfony están diseñadas para reemplazar algunas funciones nativas de PHP. Las aplicaciones deberían evitar utilizar _sessionstart(), _session_regenerateid(), _sessionid(), _sessionname() y _sessiondestroy() y en su lugar utilizar la API de Symfony.

Es recomentable iniciar una sesión explícitamente, pero una sesión de iniciará bajo demanda, es decir, si se hace cualquier sessión request para leer o escribir datos en sesiones. Es problable que en lugar de utilizar el código de new Session() tengas que acceder a la sesión directamente desde el request:

$session = $request->getSession();

Ya que si no te puede salir el siguiente error: Failed to start the session: already started by PHP. 500 Internal Server Error - RuntimeException.

Las sesiones de Symfony son incompatibles con la directiva php.ini session.auto_start = 1. Esta directiva debe desactivarse en php.ini, en las directivas del servidor web o en .htaccess.

2. La session API

La clase Session implementa SessionInterface.

Session tiene una simple API dividida en varios grupos, como sigue:

Session Workflow

start(). Inicia la sesión. Nunca utilizar _sessionstart().
migrate(). Regenera la session ID. Nunca utilizar _session_regenerateid().
invalidate(). Limpia los datos de sesiones y regenera la session ID. Nunca utilizar _sessiondestroy().
getId(). Obtiene la session ID. Nunca utilizar _sessionid().
setId(). Establece la session ID. Nunca utilizar _sessionid().
getName(). Obtiene el nombre de la sesión. Nunca utilizar _sessionname().
setName(). Establece el nombre de la sesión. Nunca utilizar _sessionname().

Session Attributes

set(). Establece un atributo con una key.
get(). Obtiene un atributo por su key.
all(). Obtiene todos los atributos como array key => value.
has(). Devuelve true si el atributo existe.
replace(). Establece múltiples atributos de vez. Toma un array asociativo y establece cada pareja key => value.
remove(). Elimina un atributo por su key.
clear(). Limpia todos los atributos.

Los atributos se guardan internamente en una bolsa (Bag), un objeto PHP que actúa como un array. Existen unos pocos métodos para la administración de bolsas:

registerBag(). Registra una SessionBagInterface.
getBag(). Obtiene una SessionBagInterface por su nombre de tag.
getFlashBag(). Obtiene una FlashBagInterface. Es un simple shortcut por conveniencia.

Session Metadata

getMetadataBag(). Obtiene la MetadataBag que contiene información sobre la sesión.

3. Manejo de datos de sesiones

La administración de sesiones de PHP requiere el uso de la superglobal $_SESSION, sin embargo, interfiere de alguna forma con el testeo del código y la encapsulación en el paradigma OOP (Object Oriented Programming). Para solucionar esto, Symfony utiliza bolsas de sesiones enlazadas a la sesión para encapsular conjuntos de datos de atributos o mensajes flash.

Este enfoque también mitiga la profanación de namespaces dentro de la superglobal $_SESSION ya que cada bolsa guarda todos sus datos bajo un único namespace. Esto permite a Symfony coexistir con otras aplicaciones o librerías que pudieran utilizar la superglobal $_SESSION y todos los datos permanecen completamente compatibles con la administración de sesiones de Symfony.

Symfony proporciona dos tipos de bolsas de almacenamiento, con dos implementaciones diferentes. Todo está construido en base a interfaces por lo que puedes extender o crear tus propias bolsas si es necesario.

SessionBagInterface tiene la siguiente API que es principalmente para asuntos internos:

getStorageKey(). Devuelve el key bajo el que la bolsa guardará su array en $_SESSION. Generalmente este valor se puede dejar a su valor por defecto ya que es para uso interno.
initialize(). Esta función es llamada internamente por las clases de almacenamiento de sesión de Symfony para enlazar datos de bolsas a la sesión.
getName(). Devuelve el nombre de la bolsa de sesión.

4. Atributos

El objetivo de las bolsas implementando AttributeBagInterface es para manejar el almacenamiento de atributos de sesión. Esto podría incluir cosas como user ID, y ajustes de "recordarme" y otros basados en información estática.

AttributeBag. Esta es la implementación por defecto estándar.
NamespacedAttributeBag. Esta implementación permite a los atributos ser guardados en un namespace estructurado.

Cualquier sistema de almacenamiento key-value está limitado a la complejidad de los datos guardados ya que cada key debe ser única. Puedes conseguir namespacing introduciendo una convención de nombres a los keys y así diferentes partes de tu aplicación pueden operar sin chocar. Por ejemplo module1.foo y module2.foo. Sin embargo, a veces no es muy práctico cuando los datos de los atributos están en un array, por ejemplo un conjunto de tokens. En este caso, administrar el array se convierte en una carga porque tienes que sacar el array, procesarlo y guardarlo de nuevo:

$tokens = array(
    'tokens' => array(
        'a' => 'a6c1e0b6',
        'b' => 'f4a7b1f3',
    ),
);

Procesar esto podría complicarse mucho rápidamente, incluso añadiendo simplemente un token al array:

$tokens = $session->get('tokens');
$tokens['c'] = $value;
$session->set('tokens', $tokens);

Con namespacing estructurado, el key se puede traducir a la estructura del array como esta usando un carácter de namespaces (por defecto /):

$session->set('tokens/c', $value);

De esta forma puedes acceder fácilmente a un key dentro del array guardado directa y fácilmente:

AttributeBagInterface tiene una API simple

set(). Establece un atributo según una key.
get(). Obtiene un atributo según una key.
all(). Obtiene todos los atributos como un array de key => value.
has(). Devuelve true si el atributo existe.
replace(). Establece múltiples atributos de vez: toma un array asociativo y establece cada pareja key => value.
remove(). Elimina un atributo por su key.
clear(). Limpia la bolsa.