XGAP - Generated Documentation (phpDocumentor 2)
\

\AplicacionXgap

Provee métodos para operar con la aplicación generada.

Summary

Methods
Properties
Constants
realFullAppDir()
enModoMantenimiento()
esPaginaAccesibleEnModoMantenimiento()
esRolFuncionalConAccesoEnMantenimiento()
verificarModoMantenimiento()
No public properties found
ARCHIVO_MANTENIMIENTO_PREDEFINIDO
responderModoMantenimiento()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

ARCHIVO_MANTENIMIENTO_PREDEFINIDO

ARCHIVO_MANTENIMIENTO_PREDEFINIDO

Nombre del archivo usado para indicar que la aplicación está en modo mantenimiento, sin tener en cuenta los valores de configuración.

Methods

realFullAppDir()

realFullAppDir() : string

Retorna la ruta completa del directorio raíz de la aplicación.

La diferencia con la constante FULL_APP_DIR es que este método retorna la ruta hecha absoluta y canónica, mientras que la constante no necesariamente está así.

Returns

string

enModoMantenimiento()

enModoMantenimiento() : boolean

¿La aplicación se encuentra actualmente en modo mantenimiento?

Returns

boolean

esPaginaAccesibleEnModoMantenimiento()

esPaginaAccesibleEnModoMantenimiento(string  $pagina = null) : boolean

Permite comprobar si una página tiene el acceso permitido en modo mantenimiento.

Parameters

string $pagina

ruta de la página, relativa al directorio raíz de la aplicación

Returns

boolean

esRolFuncionalConAccesoEnMantenimiento()

esRolFuncionalConAccesoEnMantenimiento(string  $nombre_rolf = null) : boolean

Permite comprobar si un rol funcional tiene el acceso permitido en modo mantenimiento.

Parameters

string $nombre_rolf

nombre del rol funcional a comprobar

Returns

boolean

verificarModoMantenimiento()

verificarModoMantenimiento()

Verifica si la aplicación está en modo de mantenimiento, en cuyo caso cancela el procesamiento normal y realiza una respuesta apropiada.

La respuesta está dada por las reglas siguientes:

  • Si la página solicitada o el rol actual se pueden acceder, de acuerdo a las opciones de configuración, se agrega un mensaje de aviso y se continúa el procesamiento normal sin más interferencia.
  • Si no, se responde con la primera de las siguientes opciones que cumpla las condiciones indicadas:
    1. Redirección a la [página de mantenimiento predefinida](../classes/AplicacionXgap.html#constant_ARCHIVO_MANTENIMIENTO_PREDEFINIDO), si existe y la página solicitada produciría respuesta HTML.
    2. Redirección a la página de mantenimiento configurada (parámetro de configuración pagina_mantenimiento), si existe y la página solicitada produciría respuesta HTML.
    3. Estado HTTP 503, con el valor del parámetro de configuración mensaje_mantenimiento en el cuerpo de la respuesta, en cualquier otro caso.

responderModoMantenimiento()

responderModoMantenimiento()

Realiza la respuesta para modo de mantenimiento.

Las reglas están indicadas en verificarModoMantenimiento().