---
title: "Phalcon Flash"
version: "5.17"
---
> 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
Source on GitHub
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");
```
Class AbstractFlash
@package Phalcon\Flash
- `stdClass`
- [`Phalcon\Di\AbstractInjectionAware`](/5.17/api/phalcon_di/#diabstractinjectionaware)
- **`Phalcon\Flash\AbstractFlash`** - implements [`Phalcon\Flash\FlashInterface`](#flashflashinterface)
- [`Phalcon\Flash\Direct`](#flashdirect)
- [`Phalcon\Flash\Session`](#flashsession)
__Uses__ `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\Support\Helper\Str\Interpolate`
### Method Summary
### Properties
protected
bool
$autoescape = true
protected
bool
$automaticHtml = true
protected
array
$cssClasses = []
protected
array
$cssIconClasses = []
protected
string
$customTemplate = ""
protected
EscaperInterface | null
$escaperService = null
protected
bool
$implicitFlush = true
protected
Interpolate
$interpolator
protected
array
$messages = []
protected
SessionInterface|null
$sessionService = null
### Methods
Public · 21
__construct()
```php
public function __construct(
EscaperInterface $escaper = null,
SessionInterface $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;
```
getAutomaticHtml()
```php
public function getAutomaticHtml(): bool;
```
getCssClasses()
```php
public function getCssClasses(): array;
```
getCssIconClasses()
```php
public function getCssIconClasses(): array;
```
getCustomTemplate()
```php
public function getCustomTemplate(): string;
```
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
Source on GitHub
Class Direct
@package Phalcon\Flash
- `stdClass`
- [`Phalcon\Di\AbstractInjectionAware`](/5.17/api/phalcon_di/#diabstractinjectionaware)
- [`Phalcon\Flash\AbstractFlash`](#flashabstractflash)
- **`Phalcon\Flash\Direct`**
### Method Summary
### Methods
Public · 2
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
Source on GitHub
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
Source on GitHub
- `\Exception`
- [`Phalcon\Flash\Exception`](#flashexception)
- **`Phalcon\Flash\Exceptions\EscaperServiceUnavailable`**
__Uses__ `Phalcon\Flash\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Flash\Exceptions\FlashMessageNotStringOrArray
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Flash\Exception`](#flashexception)
- **`Phalcon\Flash\Exceptions\FlashMessageNotStringOrArray`**
__Uses__ `Phalcon\Flash\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Flash\Exceptions\SessionServiceUnavailable
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Flash\Exception`](#flashexception)
- **`Phalcon\Flash\Exceptions\SessionServiceUnavailable`**
__Uses__ `Phalcon\Flash\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Flash\FlashInterface
Interface
Source on GitHub
Interface FlashInterface
- [`Phalcon\Contracts\Flash\Flash`](/5.17/api/phalcon_contracts/#contractsflashflash)
- **`Phalcon\Flash\FlashInterface`**
__Uses__ `Phalcon\Contracts\Flash\Flash`
## Flash\Session
Class
Source on GitHub
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.17/api/phalcon_di/#diabstractinjectionaware)
- [`Phalcon\Flash\AbstractFlash`](#flashabstractflash)
- **`Phalcon\Flash\Session`**
__Uses__ `Phalcon\Flash\Exceptions\SessionServiceUnavailable` · `Phalcon\Html\Escaper\EscaperInterface` · `Phalcon\Session\ManagerInterface`
### Method Summary
### Constants
string
SESSION_KEY = "_flashMessages"
### Properties
protected
string
$sessionKey = ""
### Methods
Public · 7
__construct()
```php
public function __construct(
EscaperInterface $escaper = null,
ManagerInterface $session = null,
string $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 $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
Protected · 2
getSessionMessages()
```php
protected function getSessionMessages(
bool $remove,
string $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.17/api/phalcon_flash/index.mdx