Secciones

Abstract Class Phalcon\Flash\AbstractFlash

Código fuente en GitHub

Namespace Phalcon\Flash   Uses Phalcon\Di, Phalcon\Di\DiInterface, Phalcon\Di\AbstractInjectionAware, Phalcon\Escaper\EscaperInterface, Phalcon\Session\ManagerInterface   Extends AbstractInjectionAware   Implements FlashInterface

Muestra notificaciones HTML relacionadas con diferentes circunstancias. Las clases se pueden estilizar usando CSS

$flash->success("The record was successfully deleted");
$flash->error("Cannot open the file");

Propiedades

/**
 * @var bool
 */
protected autoescape = true;

/**
 * @var bool
 */
protected automaticHtml = true;

/**
 * @var array
 */
protected cssClasses;

/**
 * @var string
 */
protected customTemplate = ;

/**
 * @var EscaperInterface | null
 */
protected escaperService;

/**
 * @var bool
 */
protected implicitFlush = true;

/**
 * @var array
 */
protected messages;

/**
 * @var SessionInterface | null
 */
protected sessionService;

Métodos

public function __construct( EscaperInterface $escaper = null, SessionInterface $session = null );

Constructor Phalcon\Flash

public function clear(): void;

Limpia los mensajes acumulados cuando el vaciado implícito está deshabilitado

public function error( string $message ): string | null;

Muestra un mensaje de error HTML

$flash->error("This is an error");
public function getAutoescape(): bool
public function getCssClasses(): array
public function getCustomTemplate(): string
public function getEscaperService(): EscaperInterface;

Devuelve un Servicio Escapador

public function notice( string $message ): string | null;

Muestra un mensaje de aviso/información HTML

$flash->notice("This is an information");
public function outputMessage( string $type, mixed $message );

Muestra un mensaje formateándolo con HTML

$flash->outputMessage("error", $message);
public function setAutoescape( bool $autoescape ): FlashInterface;

Establece el modo autoescapado en el HTML generado

public function setAutomaticHtml( bool $automaticHtml ): FlashInterface;

Establece si la salida se debe formatear implícitamente en HTML

public function setCssClasses( array $cssClasses ): FlashInterface;

Establece un vector con clases CSS para formatear los mensajes

public function setCustomTemplate( string $customTemplate ): FlashInterface;

Establece una plantilla personalizada para mostrar los mensajes

public function setEscaperService( EscaperInterface $escaperService ): FlashInterface;

Establece el Servicio Escapador

public function setImplicitFlush( bool $implicitFlush ): FlashInterface;

Establece si la salida se debe vaciar implícitamente a la salida o devolución como cadena

public function success( string $message ): string | null;

Muestra un mensaje de éxito HTML

$flash->success("The process was finished successfully");
public function warning( string $message ): string | null;

Muestra un mensaje de advertencia HTML

$flash->warning("Hey, this is important");

Class Phalcon\Flash\Direct

Código fuente en GitHub

Namespace Phalcon\Flash   Extends AbstractFlash

Esta es una implementación de Phalcon\Flash\FlashInterface que muestra inmediatamente cualquier mensaje que se le haya pasado.

Métodos

public function message( string $type, mixed $message ): string | null;

Muestra un mensaje

public function output( bool $remove = bool ): void;

Imprime los mensajes acumulados en el flasheador

Class Phalcon\Flash\Exception

Código fuente en GitHub

Namespace Phalcon\Flash   Extends \Phalcon\Exception

Las excepciones lanzadas por Phalcon\Flash usarán esta clase

Interface Phalcon\Flash\FlashInterface

Código fuente en GitHub

Namespace Phalcon\Flash

Phalcon\Flash\FlashInterface

Interfaz para clases Phalcon\Flash

Métodos

public function error( string $message ): string | null;

Muestra un mensaje de error HTML

public function message( string $type, string $message ): string | null;

Muestra un mensaje

public function notice( string $message ): string | null;

Muestra un mensaje de aviso/información HTML

public function success( string $message ): string | null;

Muestra un mensaje de éxito HTML

public function warning( string $message ): string | null;

Muestra un mensaje de advertencia HTML

Class Phalcon\Flash\Session

Código fuente en GitHub

Namespace Phalcon\Flash   Uses Phalcon\Di\DiInterface, Phalcon\Session\ManagerInterface   Extends AbstractFlash

Esta es una implementación de Phalcon\Flash\FlashInterface que almacena temporalmente los mensajes en sesión, por lo que los mensajes se pueden imprimir en la siguiente petición.

Métodos

public function clear(): void;

Limpia los mensajes en el mensajero de sesión

public function getMessages( mixed $type = null, bool $remove = bool ): array;

Devuelve los mensajes en el flasheador de sesión

public function getSessionService(): ManagerInterface;

Devuelve el Servicio Sesión

public function has( mixed $type = null ): bool;

Comprueba si hay mensajes

public function message( string $type, string $message ): string | null;

Añade un mensaje al flasheador de sesión

public function output( bool $remove = bool ): void;

Imprime los mensajes del flasheador de sesión

protected function getSessionMessages( bool $remove, mixed $type = null ): array;

Devuelve los mensajes almacenados en sesión

protected function setSessionMessages( array $messages ): array;

Almacena los mensajes en sesión