Abstract Class Phalcon\Flash\AbstractFlash
Código fuente en GitHub
| Namespace |
Phalcon\Flash |
|
Uses |
Phalcon\Di\Di, Phalcon\Di\DiInterface, Phalcon\Di\AbstractInjectionAware, Phalcon\Html\Escaper\EscaperInterface, Phalcon\Session\ManagerInterface, Phalcon\Support\Helper\Str\Interpolate |
|
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");
Class AbstractFlash
@package Phalcon\Flash
Propiedades
/**
* @var bool
*/
protected autoescape = true;
/**
* @var bool
*/
protected automaticHtml = true;
/**
* @var array
*/
protected cssClasses;
/**
* @var array
*/
protected cssIconClasses;
/**
* @var string
*/
protected customTemplate = ;
/**
* @var EscaperInterface | null
*/
protected escaperService;
/**
* @var bool
*/
protected implicitFlush = true;
/**
* @var Interpolate
*/
protected interpolator;
/**
* @var array
*/
protected messages;
/**
* @var SessionInterface|null
*/
protected sessionService;
Métodos
public function __construct( EscaperInterface $escaper = null, SessionInterface $session = null );
AbstractFlash constructor.
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 getAutomaticHtml(): bool;
public function getCssClasses(): array;
public function getCssIconClasses(): 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 ): string | null;
Muestra un mensaje formateándolo con HTML
$flash->outputMessage("error", $message);
public function setAutoescape( bool $autoescape ): AbstractFlash;
Establece el modo autoescapado en el HTML generado
public function setAutomaticHtml( bool $automaticHtml ): AbstractFlash;
Establece si la salida se debe formatear implícitamente en HTML
public function setCssClasses( array $cssClasses ): AbstractFlash;
Establece un vector con clases CSS para formatear los mensajes
public function setCssIconClasses( array $cssIconClasses ): AbstractFlash;
Set an array with CSS classes to format the icon messages
public function setCustomTemplate( string $customTemplate ): AbstractFlash;
Set a custom template for showing the messages
public function setEscaperService( EscaperInterface $escaperService ): AbstractFlash;
Establece el Servicio Escapador
public function setImplicitFlush( bool $implicitFlush ): AbstractFlash;
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 |
Class Direct
@package Phalcon\Flash
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 |
\Exception |
Las excepciones lanzadas por Phalcon\Flash usarán esta clase
Interface Phalcon\Flash\FlashInterface
Código fuente en GitHub
Interface FlashInterface
@package 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\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.
Class Session
@package Phalcon\Flash
Constantes
const SESSION_KEY = _flashMessages;
Métodos
public function clear(): void;
Limpia los mensajes en el mensajero de sesión
@throws Exception
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( string $type = null ): bool;
Comprueba si hay mensajes
public function message( string $type, mixed $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, string $type = null ): array;
Devuelve los mensajes almacenados en sesión
protected function setSessionMessages( array $messages ): array;
Almacena los mensajes en sesión
Czech
German
Greek
English (US)
Persian
French
Indonesian
Italian
Japanese
Korean
Polish
Portuguese, Brazilian
Russian
Turkish
Ukrainian
Chinese Simplified