Constants

PAGINA_USO_NO_APLICA

PAGINA_USO_NO_APLICA

Usada para indicar que no corresponde aplicar seguridad a una página.

PAGINA_USO_SIN

PAGINA_USO_SIN

Usada para indicar que una página no tiene la seguridad habilitada.

PAGINA_USO_CON

PAGINA_USO_CON

Usada para indicar que una página tiene la seguridad habilitada.

VAR_SESION_ID_USUARIO_ACTUAL

VAR_SESION_ID_USUARIO_ACTUAL

Nombre de la variable de sesión que guarda el ID del usuario logueado.

VAR_SESION_NOMBRE_CORTO_USUARIO_ACTUAL

VAR_SESION_NOMBRE_CORTO_USUARIO_ACTUAL

Nombre de la variable de sesión que guarda el nombre corto del usuario logueado.

VAR_SESION_NOMBRE_COMPLETO_USUARIO_ACTUAL

VAR_SESION_NOMBRE_COMPLETO_USUARIO_ACTUAL

Nombre de la variable de sesión que guarda el nombre completo del usuario logueado.

VAR_SESION_ID_ROLF_ACTUAL

VAR_SESION_ID_ROLF_ACTUAL

Nombre de la variable de sesión que guarda el ID del rol funcional activo del usuario logueado.

VAR_SESION_NOMBRE_ROLF_ACTUAL

VAR_SESION_NOMBRE_ROLF_ACTUAL

Nombre de la variable de sesión que guarda el nombre del rol funcional activo del usuario logueado.

Methods

obtenerConsultaSegura()

obtenerConsultaSegura(string  $consulta) : mixed

Retorna el resultado de una consulta.

Parameters

string $consulta

Returns

mixed

hayUsuarioLogueado()

hayUsuarioLogueado() : boolean

Permite comprobar si hay un usuario logueado en la aplicación y tiene un rol seleccionado.

Returns

boolean

usuarioLogueado()

usuarioLogueado() : array|null

Retorna datos del usuario logueado en la aplicación.

El resultado tiene la forma:

array(
    'id' => identificador,
    'nombre' => nombre corto,
    'nombre_ext' => nombre completo
)

Returns

array|null —

los datos del usuario o null si no hay un usuario logueado

rolFuncionalUsuarioLogueado()

rolFuncionalUsuarioLogueado() : array|null

Retorna datos del rol funcional activo del usuario logueado en la aplicación.

El resultado tiene la forma:

array(
    'id' => identificador,
    'nombre' => nombre
)

Returns

array|null —

los datos del rol o null si no hay un rol activo

destruirSesionAplicacion()

destruirSesionAplicacion(boolean  $regenerar_id_sesion = FALSE, string  $mensaje = NULL, string  $tipo_mensaje = \Flash::MENSAJE_INFORMACION, integer  $duracion_mensaje = \Flash::TIEMPO_PRESENTACION_INDETERMINADO) 

Elimina todos los datos de la sesión para la aplicación actual.

Parameters

boolean $regenerar_id_sesion

si es FALSE; se mantiene el ID de sesión; si es FALSE, el ID se cambia por uno nuevo, afectando a todas las aplicaciones, no sólo a la actual

string $mensaje

mensaje a mostrar durante el siguiente request; si es vacío, no se muestra ningún mensaje

string $tipo_mensaje

tipo de mensaje; una de las constantes Flash::MENSAJE_*

integer $duracion_mensaje

tiempo en milisegundos por el que se debe presentar el mensaje; pasar NULL para usar el tiempo preestablecido

paginaUsaSeguridad()

paginaUsaSeguridad(string  $nombre_pagina) : boolean

Permite comprobar si una página usa seguridad.

Parameters

string $nombre_pagina

Returns

boolean —

true si usa seguridad; null si no lo puede comprobar porque no se encuentra el índice de páginas o una entrada para $nombre_pagina dentro del índice

puedeVerPagina()

puedeVerPagina(  $pagina) : boolean

Permite comprobar si el rol actual del usuario logueado le permite ver la página <var>$pagina</var> de la aplicación actual.

Parameters

$pagina

ruta completa de la página a verificar

Returns

boolean —

true si $pagina no usa seguridad o el usuario tiene permiso para verla

puedeVerPaginaParams()

puedeVerPaginaParams(  $pagina, array  $params) : boolean

Permite comprobar si el usuario logueado puede visitar la página <var>$pagina</var> con los parámetros <var>$params</var>.

Este método difiere de \puedeVerPagina() en que se utiliza para verificar si la página se puede visitar con una lista de parámetros dada, mientras que \puedeVerPagina() se usa para ver si la página en sí es accesible, independientemente de los parámetros. Esto hace posible que se permita la visita a una página con ciertos valores de parámetros, pero no con otros.

Por defecto este método retorna siempre true, pero se puede especializar en las aplicaciones con una clase de seguridad personalizada.

Parameters

$pagina

ruta completa de la página a verificar

array $params

parámetros que recibe la página

Returns

boolean

operacionHabilitada()

operacionHabilitada(\iOperacion  $operacion) : boolean

Permite comprobar si una operación debe estar habilitada para ejecutar.

Parameters

\iOperacion $operacion

Returns

boolean

verificarSeguridad()

verificarSeguridad(string  $error) : boolean

Realiza un chequeo de seguridad.

Parameters

string $error

Returns

boolean

actualizaPermisosPaginas()

actualizaPermisosPaginas(string  $aplicacion, string  $rol_usuario, string  $tipo_pagina, array  $paginas, array  $operaciones) 

Actualiza los permisos de las paginas.

Si no están las agrega en la tabla de paginas y establece, para un rol determinado, lo que se puede realizar.

Parameters

string $aplicacion
string $rol_usuario
string $tipo_pagina
array $paginas
array $operaciones

actualizarPermisosPorPagina()

actualizarPermisosPorPagina(string  $aplicacion, string  $pagina, array  $roles_usuario, array  $operaciones) 

Actualiza los permisos para una página.

Define los roles que pueden accederla y las operaciones que se pueden realizar sobre ella.

Parameters

string $aplicacion

nombre de la aplicación que contiene la página

string $pagina

nombre de la página

array $roles_usuario

IDs de los roles de usuario que pueden acceder la página

array $operaciones

operaciones que se pueden realizar

obtenerPaginasPermitidas()

obtenerPaginasPermitidas(string  $aplicacion, string  $rol_usuario, string  $tipo_pagina) : array

Permite obtener las páginas que se pueden visitar y operaciones posibles en cada una.

Para una aplicación, un rol de usuario y un tipo de página determinados, retorna un arreglo con las páginas permitidas como clave y las operaciones como un arreglo con las operaciones posibles

Parameters

string $aplicacion
string $rol_usuario
string $tipo_pagina

Returns

array

obtenerRolesDisponibles()

obtenerRolesDisponibles() : array

Permite obtener los roles disponibles en la aplicación.

Returns

array —

un array asociativo con los roles disponibles, donde la clave es el identificador del rol y el valor es su descripción

obtenerAplicacionesDisponibles()

obtenerAplicacionesDisponibles() : array

Permite obtener las aplicaciones disponibles.

Returns

array —

un array asociativo con las aplicaciones disponibles, donde la clave es el identificador de la aplicación y el valor es un array con los valores de las columnas