\Contexto

Centraliza el manejo de variables asociadas a la sesión, manteniendo separadas las variables pertenecientes a diferentes aplicaciones de XGAP.

Todo el manejo de variables de sesión se debe hacer a través de esta clase, en vez de acceder directamente a $_SESSION.

La aplicación actual está indicada por el valor de la constante NOMBRE_APP.

Summary

Methods
Properties
Constants
paginaActual()
iniciarSesion()
terminarSesion()
existeSesion()
idSesion()
cambiarIdSesion()
regenerarIdSesion()
destruirSesionAplicacion()
destruir_sesion_aplicacion()
existe()
obtener()
almacenar()
remover()
contenido()
obtenerTiempoUltimaActividad()
No public properties found
CLAVE_CONT_APLICACIONES
CLAVE_CONT_METADATOS
CLAVE_ACTIVIDAD
existeMeta()
obtenerMeta()
almacenarMeta()
removerMeta()
_obtenerTiempoUltimaActividad()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

CLAVE_CONT_APLICACIONES

CLAVE_CONT_APLICACIONES

Clave del valor que se guarda en la sesión, donde se almacenan todas las variables manejadas por esta clase.

CLAVE_CONT_METADATOS

CLAVE_CONT_METADATOS

Clave del contenedor de metadatos de la sesión.

CLAVE_ACTIVIDAD

CLAVE_ACTIVIDAD

Clave para almacenar el tiempo de última actividad de la sesión.

Methods

paginaActual()

paginaActual() : string

Devuelve el nombre de la pagina visitada actualmente.

Returns

string

iniciarSesion()

iniciarSesion() 

Inicia la sesión.

No tiene efecto si la sesión ya ha sido iniciada.

terminarSesion()

terminarSesion() 

Termina la sesión.

Este método actúa sobre la sesión a nivel global, es decir que afecta a todas las aplicaciones que compartan la sesión.

No tiene efecto si no hay una sesión activa.

existeSesion()

existeSesion() : boolean

Permite comprobar si hay una sesión activa.

Returns

boolean

idSesion()

idSesion() : string

Retorna el ID de la sesión actual, o vacío si no hay una sesión iniciada.

Returns

string

cambiarIdSesion()

cambiarIdSesion(string  $id) 

Establece un nuevo ID de sesión.

Este método actúa sobre la sesión a nivel global, es decir que afecta a todas las aplicaciones que compartan la sesión.

Se puede usar aunque exista una sesión ya iniciada.

Parameters

string $id

el nuevo ID

regenerarIdSesion()

regenerarIdSesion(boolean  $borrar_anterior = TRUE) : boolean

Cambia el ID de sesión por uno nuevo.

Este método actúa sobre la sesión a nivel global, es decir que afecta a todas las aplicaciones que compartan la sesión.

Se puede usar aunque exista una sesión ya iniciada.

Parameters

boolean $borrar_anterior

¿se debe borrar el contenido de la sesión asociada al ID anterior?

Returns

boolean —

TRUE si el cambio fue correcto; FALSE si no

destruirSesionAplicacion()

destruirSesionAplicacion() 

Elimina todos los datos de la sesión que corresponden a la aplicación actual, sin afectar el resto de la sesión.

No tiene efecto si la aplicación actual no está definida.

destruir_sesion_aplicacion()

destruir_sesion_aplicacion() 

existe()

existe(string  $variable) : boolean

Permite comprobar si una variable existe dentro de la sesión de la aplicación actual, o dentro de la sesión global, si la aplicación actual no está definida.

Parameters

string $variable

Returns

boolean

obtener()

obtener(string  $variable, mixed  $default = null) : mixed

Retorna el contenido de una variable almacenada en la sesión de la aplicación actual, o dentro en la sesión global, si la aplicación actual no está definida.

Parameters

string $variable
mixed $default

valor a devolver si no existe $variable en la sesión

Returns

mixed

almacenar()

almacenar(string  $nombre,   $variable) 

Almacena una variable en la sesión de la aplicación actual, o en la sesión global, si la aplicación actual no está definida.

Parameters

string $nombre
$variable

remover()

remover(string  $variable) 

Remueve una variable de la sesión de la aplicación actual, o de la sesión global, si la aplicación actual no está definida.

No tiene efecto si la variable no existe en el contexto.

Parameters

string $variable

nombre de la variable a remover

contenido()

contenido() : array

Devuelve el contenido de la sesión de la aplicación actual, si está definida, o de la sesión global si no.

Returns

array

obtenerTiempoUltimaActividad()

obtenerTiempoUltimaActividad() : integer

Devuelve el tiempo de última actividad en la sesión.

Returns

integer —

UNIX timstamp el momento de última actividad, o 0 si no se registró actividad aún

existeMeta()

existeMeta(string  $nombre) : boolean

Permite comprobar si un metadato existe dentro de la sesión de la aplicación actual, o dentro de la sesión global, si la aplicación actual no está definida.

Parameters

string $nombre

Returns

boolean

obtenerMeta()

obtenerMeta(string  $nombre, mixed  $default = null) : mixed

Retorna el contenido de un metadato almacenado en la sesión de la aplicación actual, o dentro en la sesión global, si la aplicación actual no está definida.

Parameters

string $nombre
mixed $default

valor a devolver si no existe $nombre en la sesión

Returns

mixed

almacenarMeta()

almacenarMeta(string  $nombre,   $variable) 

Almacena un metadato en la sesión de la aplicación actual, o en la sesión global, si la aplicación actual no está definida.

Parameters

string $nombre
$variable

removerMeta()

removerMeta(string  $nombre) 

Remueve un metadato de la sesión de la aplicación actual, o de la sesión global, si la aplicación actual no está definida.

No tiene efecto si el metadato no existe en el contexto.

Parameters

string $nombre

nombre del metadato a remover

_obtenerTiempoUltimaActividad()

_obtenerTiempoUltimaActividad() : integer

Devuelve el tiempo de última actividad en la sesión.

Es equivalente a \obtenerTiempoUltimaActividad(), pero no inicializa la sesión.

Returns

integer —

UNIX timstamp el momento de última actividad, o 0 si no se registró actividad aún