Constants

PREFIJO_PARAM_CONF

PREFIJO_PARAM_CONF

Prefijo para constantes que definen parámetros de configuración

PREFIJO_PARAM_APP

PREFIJO_PARAM_APP

Prefijo para constantes que definen parámetros de aplicación

PREFIJO_RECURSO

PREFIJO_RECURSO

Prefijo para constantes que definen recursos

PREFIJO_PARAM_REQUEST

PREFIJO_PARAM_REQUEST

Prefijo para constantes que definen parámetros del Request

PREFIJO_NOMBRE_PARAM_REQUEST

PREFIJO_NOMBRE_PARAM_REQUEST

Prefijo para nombres de parámetros del Request

LONGITUD_MINIMA_SAL_CRIPTOGRAFICA

LONGITUD_MINIMA_SAL_CRIPTOGRAFICA

Longitud mínima para los parámetros de tipo "sal-criptografica".

ARCHIVO_RECURSOS

ARCHIVO_RECURSOS

Nombre del archivo de configuración de recursos en las aplicaciones.

Properties

$parametros_configuracion

$parametros_configuracion : array

Contiene los parámetros de configuración cargados.

Type

array

$parametros_configuracion_defaults

$parametros_configuracion_defaults : array

Contiene los valores por defecto de parámetros de configuración.

Type

array

$recursos

$recursos : array

Type

array

$con_conexion

$con_conexion : boolean

Type

boolean

Methods

__construct()

__construct() 

recuperar()

recuperar() : array

Retorna los parámetros de configuración.

Returns

array

recuperarDefaults()

recuperarDefaults() : array

Retorna los valores por defecto de los parámetros de configuración.

Returns

array

recuperarRecursos()

recuperarRecursos() : array

Retorna los valores de recursos.

Returns

array

recuperarParametro()

recuperarParametro(string  $nombre) : mixed

Devuelve el valor de un parámetro de configuración.

Parameters

string $nombre

el nombre del parámetro

Returns

mixed

recuperarDefaultParametro()

recuperarDefaultParametro(string  $nombre) : mixed

Devuelve el valor por defecto de un parámetro de configuración.

Parameters

string $nombre

el nombre del parámetro

Returns

mixed

recuperarArray()

recuperarArray(string  $parametro, string  $separador = ',', boolean  $trim = false) : array

Devuelve el parámetro de configuración indicado, en forma de array.

El parámetro debe estar dado como una lista de valores divididos por $separador. Por ejemplo: // En el archivo de configuración define(Configuracion::PREFIJO_PARAM_CONF . 'PARAM', 'v1,v2,v3'); // Luego de crear el objeto $configuracion $configuracion->recuperarArray('param', ',') == array('v1, 'v2', 'v3');

Parameters

string $parametro

nombre del parametro a obtener

string $separador

expresion regular a usar como divisor

boolean $trim

¿se deben eliminar los blancos en los extremos de los valores?

Returns

array

recuperarDefaultArray()

recuperarDefaultArray(string  $parametro, string  $separador = ',') : array

Devuelve el valor por defecto del parámetro de configuración indicado, en forma de array.

Parameters

string $parametro

nombre del parametro a obtener

string $separador

expresion regular a usar como divisor

Returns

array

recuperarColor()

recuperarColor(string  $parametro) : array

Retorna un parámetro de tipo color, como un array con los tres componentes R, G y B.

Parameters

string $parametro

nombre del parametro a obtener

Returns

array —

componentes del color, con el formato array(0 => R, 1 => G, 2 => B)

incluirLibrerias()

incluirLibrerias() 

Incluye todos los archivos necesarios para la aplicación.

establecerUsoDeConexion()

establecerUsoDeConexion(boolean  $uso_conexion) 

Establece si debe emplearse o no una conexión a base de datos.

Parameters

boolean $uso_conexion

usaConexion()

usaConexion() : boolean

Indica si emplea o no una conexión a base de datos.

Returns

boolean

establecerEsPagina()

establecerEsPagina(boolean  $es_pagina) 

Establece el valor de la propiedad <var>esPagina</var>.

Parameters

boolean $es_pagina

esPagina()

esPagina() : boolean

¿El request actual corresponde a un pedido de una página de la aplicación?

No se consideran páginas a solicitudes que producen contenido parcial que es incluido en páginas (como los menúes) o salida no html (como listados pdf).

Cuando esta propiedad es false, no se crean objetos que sólo tienen sentido en páginas, como el historial o el flash.

Returns

boolean

recuadroConMargen()

recuadroConMargen(string  $param) : array

Procesa el valor de un parámetro que especifica un recuadro (bounding box) dado con alto, ancho y espacio arriba y espacio a la izquierda.

El formato del parámetro debe ser "---", donde el valor de cada componente debe seguir las reglas de CSS (por ejemplo: 400px, 90%, 30em).

Sólo el primer valor es requerido; los demás se deducen usando las siguientes reglas:

  • Si ancho no está presente, se toma igual al alto.
  • Si arriba o izquierda no están presentes, se toman como 0.

Ejemplos:

  • '94%-90%-3%-5%' -> alto => '94%', ancho => '90%', arriba => '3%', izquierda => '5%'
  • '94%-90%--5%' -> alto => '94%', ancho => '90%', arriba => '0', izquierda => '5%'
  • '90%' -> alto => '90%', ancho => '90%', arriba => '0', izquierda => '0'

Parameters

string $param

el valor a procesar

Returns

array —

un array con el formato array('ancho' => ancho, 'alto' => alto, 'arriba' => arriba, 'izquierda' => izquierda)

raizAplicacion()

raizAplicacion() : string

Devuelve la ruta a la raíz de la aplicación.

Se garantiza que el valor devuelto termina en '/' o es vacío.

El valor devuelto depende del parámetro de configuración raiz_aplicacion. Si no está definido, se usa APP_ROOT como valor por defecto. Si APP_ROOT tampoco está definido, entonces la raíz de la aplicación es indefinida y devuelve la cadena vacía.

Returns

string

paginaInicio()

paginaInicio() : string

Devuelve la ruta completa a la página de inicio de la aplicación.

Si la raíz de la aplicación no está definida (ver Configuracion::raizAplicacion()), devuelve la cadena vacía.

El valor devuelto depende de la variable de contexto pagina_inicio o del parámetro de configuración pagina_inicio si la primera no existe o es vacía; si este último tampoco está definido, se usa el valor por defecto 'index_contenido.php'.

Returns

string

paginaInterna()

paginaInterna(string  $pagina) : string

Devuelve la ruta completa para una página interna de la aplicación.

El valor devuelto depende de Configuracion::raizAplicacion().

Parameters

string $pagina

nombre de la página

Returns

string