TIPO_ERROR
TIPO_ERROR
Tipo de mensaje: error
Clase encargada de generar los diversos mensajes de la aplicación.
COD_ERR_SEG_PERMISOXDESTINOFINAL
Error de seguridad: El usuario no tiene permiso para visitar la página solicitada.
(falla la comprobación en iSeguridad::puedeVerPaginaParams()).
porTipo(string $tipo, string $mensaje, string $mensaje_debug = null, string $clase_extra = null, boolean $registrar = true)
Muestra un mensaje de un tipo dado.
Es equivalente a invocar uno de los métodos error(), alerta(), notificacion(), info(), generico(), según $tipo.
| string | $tipo | una de las constantes Mensaje::TIPO_*, o cualquier otro valor alfanumérico |
| string | $mensaje | el mensaje a mostrar |
| string | $mensaje_debug | mensaje a mostrar luego de $mensaje si !XGAP_CONF_EN_PRODUCCION |
| string | $clase_extra | clase/s CSS que se agrega/n a la generada por defecto |
| boolean | $registrar | ¿se debe registrar el mensaje a través del Auditor? |
error(string $mensaje, string $mensaje_debug = null, string $clase_extra = null, boolean $registrar = true)
Muestra un mensaje de error.
Genera un div HTML con clase CSS 'mensaje_error'.
| string | $mensaje | el mensaje a mostrar |
| string | $mensaje_debug | mensaje a mostrar luego de $mensaje si !XGAP_CONF_EN_PRODUCCION |
| string | $clase_extra | clase/s CSS que se agrega/n a la generada por defecto |
| boolean | $registrar | ¿se debe registrar el mensaje a través del Auditor? |
alerta(string $mensaje, string $mensaje_debug = null, string $clase_extra = null, boolean $registrar = true)
Muestra un mensaje de alerta.
Genera un div HTML con clase CSS 'mensaje_alerta'.
| string | $mensaje | el mensaje a mostrar |
| string | $mensaje_debug | mensaje a mostrar luego de $mensaje si XGAP_CONF_EN_PRODUCCION |
| string | $clase_extra | clase/s CSS que se agrega/n a la generada por defecto |
| boolean | $registrar | ¿se debe registrar el mensaje a través del Auditor? |
notificacion(string $mensaje, string $mensaje_debug = null, string $clase_extra = null, boolean $registrar = true)
Muestra un mensaje de notificación.
Genera un div HTML con clase CSS 'mensaje_notificacion'.
| string | $mensaje | el mensaje a mostrar |
| string | $mensaje_debug | mensaje a mostrar luego de $mensaje si XGAP_CONF_EN_PRODUCCION |
| string | $clase_extra | clase/s CSS que se agrega/n a la generada por defecto |
| boolean | $registrar | ¿se debe registrar el mensaje a través del Auditor? |
info(string $mensaje, string $mensaje_debug = null, string $clase_extra = null, boolean $registrar = true)
Muestra un mensaje de información.
Genera un div HTML con clase CSS 'mensaje_info'.
| string | $mensaje | el mensaje a mostrar |
| string | $mensaje_debug | mensaje a mostrar luego de $mensaje si XGAP_CONF_EN_PRODUCCION |
| string | $clase_extra | clase/s CSS que se agrega/n a la generada por defecto |
| boolean | $registrar | ¿se debe registrar el mensaje a través del Auditor? |
generico(string $mensaje, string $mensaje_debug = null, string $clase_extra = null, boolean $registrar = true)
Muestra un mensaje genérico.
Genera un div HTML con clase CSS 'mensaje'.
Se provee este método para los casos en que se desconoce si se debe usar Mensaje::error(), Mensaje::alerta(), Mensaje::notificacion() o Mensaje::info().
| string | $mensaje | el mensaje a mostrar |
| string | $mensaje_debug | mensaje a mostrar luego de $mensaje si XGAP_CONF_EN_PRODUCCION |
| string | $clase_extra | clase/s CSS que se agrega/n a la generada por defecto |
| boolean | $registrar | ¿se debe registrar el mensaje a través del Auditor? |
mostrar(\ObjetoMensaje $mensaje, string $clase_extra = null)
Muestra un mensaje del tipo de <var>$mensaje</var>.
Es equivalente a invocar uno de los métodos Mensaje::error(), Mensaje::alerta(), Mensaje::notificacion(), Mensaje::info(), Mensaje::generico(), pasándole las propiedades de $mensaje, de acuerdo a su tipo.
| \ObjetoMensaje | $mensaje | el mensaje a mostrar |
| string | $clase_extra | clase/s CSS que se agrega/n a la generada por defecto |
mostrarLista(\ListaMensajes $lista, boolean $generar_contenedor = true, string $clase_contenedor = 'cont-msjs', string $id_contenedor = null, array|string $clase_extra_mensajes = null)
Muestra una lista de mensajes, a través de {@link Mensaje::mostrar()}.
El formato del HTML generado es el siguiente:
<div id="$id_contenedor" class="$clase_contenedor">
<div class="{clase-mensaje} $clase_extra_mensaje[0] primero">{$lista[0]}</div>
<div class="{clase-mensaje} $clase_extra_mensaje[1]">{$lista[1]}</div>
...
</div>
| \ListaMensajes | $lista | lista de mensajes a mostrar |
| boolean | $generar_contenedor | ¿se debe generar el div contenedor? |
| string | $clase_contenedor | clase CSS para el div contenedor; si es vacío, no se le agrega el atributo class; se ignora si $generar_contenedor es false |
| string | $id_contenedor | ID para el div contenedor; si es vacío, no se le agrega el atributo id; se ignora si $generar_contenedor es false |
| array|string | $clase_extra_mensajes | lista de clases CSS extra a aplicar a los div emitidos para cada mensaje. Se aplica de forma cíclica; por ejemplo, si $clase_extra_mensaje tiene dos elementos, se aplica la primer clase a los mensajes pares y la segunda a los impares |
mail(string $asunto, string $mensaje, string $to, string $cc = null, string $bcc = null, string $origen = null, array $datos_extra = null, boolean $datos_extra_antes_mensaje = true) : boolean
Envía un mensaje por correo electrónico.
Realiza el envío por SMTP si está configurado, o mediante la función estándar \PHP_MANUAL#mail si no.
Comprueba que las direcciones de destinatarios sean
sintácticamente válidas;
también hace comprobaciones básicas para evitar inyección de código.
Por el momento, los parámetros $to, $cc, $bcc
y $origen sólo aceptan direcciones simples, es decir que
no pueden estar en el formato
'"Nombre Destinatario" usuario@servidor.tld'.
| string | $asunto | asunto del mail |
| string | $mensaje | texto del mensaje |
| string | $to | dirección destino o lista de direcciones separadas por comas |
| string | $cc | dirección CC o lista de direcciones separadas por comas |
| string | $bcc | dirección BCC o lista de direcciones separadas por comas |
| string | $origen | contenido de la cabecera From:; si no se especifica, se usa uno por defecto |
| array | $datos_extra | lista de datos a agregar al comienzo del cuerpo del mail;
cada par "clave" => "valor" se agrega al mensaje como una línea
con el formato "clave: valor". Por ejemplo, si: |
| boolean | $datos_extra_antes_mensaje | indica si la lista de datos extra se debe ubicar antes del mensaje (true) o después (false) |
true si se envió el mail correctamente; si no, retorna false y se puede obtener la causa mediante {@link Mensaje::ultimoError()}
errorAplicacion(string $mensaje, string $mensaje2 = "", boolean $pagina_simple = null)
Presenta un error de la aplicación, ya sea redirigiendo a una página de error, enviando un mail o mostrando un mensaje en la página actual.
| string | $mensaje | |
| string | $mensaje2 | |
| boolean | $pagina_simple | fuerza a que la página de error se muestre como simple (true) o no (false); si es null, usa el comportamiento por defecto, que depende de la página actual |
registrarMensaje(string $mensaje, string $tipo, string $mensaje_debug = null, array $backtrace = null)
Registra un mensaje a través del Auditor, cuando la configuración indica que debe hacerlo.
Sólo registra el mensaje cuando el tipo de mensaje está presente en el parámetro de configuración "tipos_mensaje_incluir_log" y el objeto Auditor está disponible; caso contrario no tiene efecto.
| string | $mensaje | texto del mensaje |
| string | $tipo | tipo del mensaje; una de las constantes Mensaje::TIPO_* |
| string | $mensaje_debug | mensaje adicional que se usa sólo si !XGAP_CONF_EN_PRODUCCION |
| array | $backtrace | backtrace obtenido en el punto donde se generó el mensaje, con el formato retornado por {@link debug_backtrace() debug_backtrace()}; si no se provee, se obtiene en este método |