---
title: "Phalcon Flash"
version: "5.20"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Flash
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Flash\AbstractFlash
Abstract
Shows HTML notifications related to different circumstances. Classes can be
stylized using CSS
```php
$flash->success("The record was successfully deleted");
$flash->error("Cannot open the file");
```
- `\stdClass`
- [`Phalcon\Di\AbstractInjectionAware`](/5.20/api/phalcon_di/#diabstractinjectionaware)
- **`Phalcon\Flash\AbstractFlash`** - implements [`Phalcon\Flash\FlashInterface`](#flashflashinterface)
- [`Phalcon\Flash\Direct`](#flashdirect)
- [`Phalcon\Flash\Session`](#flashsession)
`Phalcon\Contracts\Flash\FlashTypes` · `Phalcon\Di\AbstractInjectionAware` · `Phalcon\Di\Di` · `Phalcon\Di\DiInterface` · `Phalcon\Flash\Exceptions\EscaperServiceUnavailable` · `Phalcon\Flash\Exceptions\FlashMessageNotStringOrArray` · `Phalcon\Html\Escaper\EscaperInterface` · `Phalcon\Session\ManagerInterface` · `Phalcon\Traits\Support\Helper\Str\InterpolateTrait`
### Method Summary
AbstractFlash constructor.
Clears accumulated messages when implicit flush is disabled
Shows a HTML error message
Returns the flag that defines whether to automatically escape content or not
Returns the flag that defines whether to automatically use HTML or not
Returns the array of the CSS classes for formatting messages. The key is
Returns the array of the icon CSS classes for formatting messages. The
Returns the custom template for formatting messages
Returns the Escaper Service
Outputs a message. Delivery semantics differ per implementation:
Shows a HTML notice/information message
Outputs a message formatting it with HTML
Set the autoescape mode in generated HTML
Set if the output must be implicitly formatted with HTML
Set an array with CSS classes to format the messages
Set an array with CSS classes to format the icon messages
Set a custom template for showing the messages
Sets the Escaper Service
Set whether the output must be implicitly flushed to the output or
Shows a HTML success message
Shows a HTML warning message
### Properties
### Methods
__construct()
```php
public function __construct(
EscaperInterface|null $escaper = null,
SessionInterface|null $session = null
);
```
AbstractFlash constructor.
clear()
```php
public function clear(): void;
```
Clears accumulated messages when implicit flush is disabled
error()
```php
public function error( string $message ): string|null;
```
Shows a HTML error message
```php
$flash->error("This is an error");
```
getAutoescape()
```php
public function getAutoescape(): bool;
```
Returns the flag that defines whether to automatically escape content or not
getAutomaticHtml()
```php
public function getAutomaticHtml(): bool;
```
Returns the flag that defines whether to automatically use HTML or not
getCssClasses()
```php
public function getCssClasses(): array;
```
Returns the array of the CSS classes for formatting messages. The key is
the type of message and the value is the CSS class
getCssIconClasses()
```php
public function getCssIconClasses(): array;
```
Returns the array of the icon CSS classes for formatting messages. The
key is the type of message and the value is the icon CSS class
getCustomTemplate()
```php
public function getCustomTemplate(): string;
```
Returns the custom template for formatting messages
getEscaperService()
```php
public function getEscaperService(): EscaperInterface;
```
Returns the Escaper Service
message()
```php
abstract public function message(
string $type,
mixed $message
): string|null;
```
Outputs a message. Delivery semantics differ per implementation:
`Direct` renders and emits immediately, `Session` stores the raw
message for output on a later request.
notice()
```php
public function notice( string $message ): string|null;
```
Shows a HTML notice/information message
```php
$flash->notice("This is an information");
```
outputMessage()
```php
public function outputMessage(
string $type,
mixed $message
): string|null;
```
Outputs a message formatting it with HTML
```php
$flash->outputMessage("error", $message);
```
setAutoescape()
```php
public function setAutoescape( bool $autoescape ): static;
```
Set the autoescape mode in generated HTML
setAutomaticHtml()
```php
public function setAutomaticHtml( bool $automaticHtml ): static;
```
Set if the output must be implicitly formatted with HTML
setCssClasses()
```php
public function setCssClasses( array $cssClasses ): static;
```
Set an array with CSS classes to format the messages
setCssIconClasses()
```php
public function setCssIconClasses( array $cssIconClasses ): static;
```
Set an array with CSS classes to format the icon messages
setCustomTemplate()
```php
public function setCustomTemplate( string $customTemplate ): static;
```
Set a custom template for showing the messages
setEscaperService()
```php
public function setEscaperService( EscaperInterface $escaperService ): static;
```
Sets the Escaper Service
setImplicitFlush()
```php
public function setImplicitFlush( bool $implicitFlush ): static;
```
Set whether the output must be implicitly flushed to the output or
returned as string
Note: `output()` is an echo API and requires implicit flush to remain
enabled (the default). With implicit flush disabled, `message()` returns
the rendered string while `output()` does not emit it.
success()
```php
public function success( string $message ): string|null;
```
Shows a HTML success message
```php
$flash->success("The process was finished successfully");
```
warning()
```php
public function warning( string $message ): string|null;
```
Shows a HTML warning message
```php
$flash->warning("Hey, this is important");
```
## Flash\Direct
Class
Class Direct
@package Phalcon\Flash
- `\stdClass`
- [`Phalcon\Di\AbstractInjectionAware`](/5.20/api/phalcon_di/#diabstractinjectionaware)
- [`Phalcon\Flash\AbstractFlash`](#flashabstractflash)
- **`Phalcon\Flash\Direct`**
### Method Summary
Outputs a message
Prints the messages accumulated in the flasher
### Methods
message()
```php
public function message(
string $type,
mixed $message
): string|null;
```
Outputs a message
output()
```php
public function output( bool $remove = true ): void;
```
Prints the messages accumulated in the flasher
## Flash\Exception
Class
Exceptions thrown in Phalcon\Flash classes will use this class
- `\Exception`
- **`Phalcon\Flash\Exception`**
- [`Phalcon\Flash\Exceptions\EscaperServiceUnavailable`](#flashexceptionsescaperserviceunavailable)
- [`Phalcon\Flash\Exceptions\FlashMessageNotStringOrArray`](#flashexceptionsflashmessagenotstringorarray)
- [`Phalcon\Flash\Exceptions\SessionServiceUnavailable`](#flashexceptionssessionserviceunavailable)
## Flash\Exceptions\EscaperServiceUnavailable
Class
- `\Exception`
- [`Phalcon\Flash\Exception`](#flashexception)
- **`Phalcon\Flash\Exceptions\EscaperServiceUnavailable`**
`Phalcon\Flash\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Flash\Exceptions\FlashMessageNotStringOrArray
Class
- `\Exception`
- [`Phalcon\Flash\Exception`](#flashexception)
- **`Phalcon\Flash\Exceptions\FlashMessageNotStringOrArray`**
`Phalcon\Flash\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Flash\Exceptions\SessionServiceUnavailable
Class
- `\Exception`
- [`Phalcon\Flash\Exception`](#flashexception)
- **`Phalcon\Flash\Exceptions\SessionServiceUnavailable`**
`Phalcon\Flash\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Flash\FlashInterface
Interface
Interface FlashInterface
- [`Phalcon\Contracts\Flash\Flash`](/5.20/api/phalcon_contracts/#contractsflashflash)
- **`Phalcon\Flash\FlashInterface`**
`Phalcon\Contracts\Flash\Flash`
## Flash\Session
Class
This is an implementation of the Phalcon\Flash\FlashInterface that
temporarily stores the messages in session, then messages can be printed in
the next request.
Class Session
@package Phalcon\Flash
- `\stdClass`
- [`Phalcon\Di\AbstractInjectionAware`](/5.20/api/phalcon_di/#diabstractinjectionaware)
- [`Phalcon\Flash\AbstractFlash`](#flashabstractflash)
- **`Phalcon\Flash\Session`**
`Phalcon\Contracts\Flash\FlashTypes` · `Phalcon\Flash\Exceptions\SessionServiceUnavailable` · `Phalcon\Html\Escaper\EscaperInterface` · `Phalcon\Session\ManagerInterface`
### Method Summary
Session constructor.
Clear messages in the session messenger
Returns the messages in the session flasher
Returns the Session Service
Checks whether there are messages
Adds a message to the session flasher
Prints the messages in the session flasher
Returns the messages stored in session
Stores the messages in session
### Constants
### Properties
### Methods
__construct()
```php
public function __construct(
EscaperInterface|null $escaper = null,
ManagerInterface|null $session = null,
string|null $sessionKey = null
);
```
Session constructor.
clear()
```php
public function clear(): void;
```
Clear messages in the session messenger
getMessages()
```php
public function getMessages(
mixed $type = null,
bool $remove = true
): array;
```
Returns the messages in the session flasher
getSessionService()
```php
public function getSessionService(): ManagerInterface;
```
Returns the Session Service
has()
```php
public function has( string|null $type = null ): bool;
```
Checks whether there are messages
message()
```php
public function message(
string $type,
mixed $message
): string|null;
```
Adds a message to the session flasher
output()
```php
public function output( bool $remove = true ): void;
```
Prints the messages in the session flasher
getSessionMessages()
```php
protected function getSessionMessages(
bool $remove,
string|null $type = null
): array;
```
Returns the messages stored in session
setSessionMessages()
```php
protected function setSessionMessages( array $messages ): array;
```
Stores the messages in session
Source: https://docs.phalcon.io/5.20/api/phalcon_flash/index.mdx