CLAVE_CONTEXTO
CLAVE_CONTEXTO
Permite pasar información entre un request y el siguiente, registrándola como pares (clave => valor).
Por ejemplo, se puede guardar un mensaje con el resultado de una operación para mostrar en la siguiente página presentada.
Este objeto mantiene dos juegos de valores:
Se puede utilizar cualquier string como clave, pero se proveen algunas constantes que definen claves comunes (Flash::MENSAJE_*).
El flash se puede deshabilitar, tanto para el request actual como para el siguiente. Este estado de deshabilitación se emplea para indicar que no se deben mostrar automáticamente sus contenidos al cargar la página, pero no afecta de ningún otro modo su funcionamiento; las operaciones sobre él se siguen comportando de la misma manera.
inicializar() : \Flash
Inicializa el objeto Flash para su uso durante la duración del request en curso.
Sucesivos llamados a este método no tienen efecto sobre dicho objeto.
instancia() : \Flash
Devuelve la única instancia de esta clase.
guardar(string $clave, mixed $valor)
Almacena un valor para acceder en el próximo request.
Si se utiliza una clave existente, se sobreescribe el valor almacenado.
Este método no tiene efecto sobre los valores disponibles en el request en curso.
| string | $clave | la clave para asociar al valor |
| mixed | $valor | el valor a almacenar |
agregar(string $clave, mixed $valor)
Agrega un valor a los existentes en el request actual.
Si se utiliza una clave existente, se sobreescribe el valor almacenado.
Este método no tiene efecto sobre los valores disponibles para el próximo request.
| string | $clave | la clave para asociar al valor |
| mixed | $valor | el valor a almacenar |
mantener(mixed $que = null, boolean $mantener_tiempo_presentacion = true, boolean $mantener_estado_deshabilitacion = true)
Hace que uno o más de los valores del flash del request actual también estén disponibles para el próximo.
Si ya existen valores guardados en el flash con las mismas claves que se mantienen, se sobreescriben con los valores actuales.
| mixed | $que | valores a mantener (1) si es null, mantiene el flash completo (2) si es un array, debe contener las claves de los valores a mantener (3) en caso contrario, mantiene el valor con clave $que |
| boolean | $mantener_tiempo_presentacion | ¿se debe mantener también para el próximo request el tiempo de presentación del flash que está establecido para el actual? |
| boolean | $mantener_estado_deshabilitacion | ¿se debe mantener también para el próximo request el estado de deshabilitación del flash que está establecido para el actual? |
cambiarTiempoPresentacionActual(integer $tiempo)
Establece el tiempo por el que se deben presentar los mensajes del request actual.
No tiene efecto si $tiempo no es positivo o es Flash::TIEMPO_PRESENTACION_INDETERMINADO.
| integer | $tiempo | tiempo en milisegundos |
cambiarTiempoPresentacionSiguiente(integer $tiempo)
Establece el tiempo por el que se deben presentar los mensajes del request siguiente.
No tiene efecto si $tiempo no es positivo o es Flash::TIEMPO_PRESENTACION_INDETERMINADO.
| integer | $tiempo | tiempo en milisegundos |