CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 5.0 Chiffon API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 5.0
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Form
    • Http
      • Client
      • Cookie
      • Exception
      • Middleware
      • Session
      • TestSuite
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • TestSuite
    • Utility
    • Validation
    • View

Class FlashMessage

The FlashMessage class provides a way for you to write a flash variable to the session, to be rendered in a view with the FlashHelper.

Namespace: Cake\Http

Property Summary

  • $_config protected
    array<string, mixed>

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array<string, mixed>

    Default configuration

  • $session protected
    Cake\Http\Session

Method Summary

  • __construct() public

    Constructor

  • _configDelete() protected

    Deletes a single config key.

  • _configRead() protected

    Reads a config key.

  • _configWrite() protected

    Writes a config key.

  • configShallow() public

    Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

  • consume() public

    Get the messages for given key and remove from session.

  • error() public

    Set an success message.

  • getConfig() public

    Returns the config.

  • getConfigOrFail() public

    Returns the config for this specific key.

  • info() public

    Set an info message.

  • set() public

    Store flash messages that can be output in the view.

  • setConfig() public

    Sets the config.

  • setExceptionMessage() public

    Set an exception's message as flash message.

  • success() public

    Set a success message.

  • warning() public

    Set a warning message.

Method Detail

__construct() ¶ public

__construct(Cake\Http\Session $session, array<string, mixed> $config = [])

Constructor

Parameters
Cake\Http\Session $session

Session instance.

array<string, mixed> $config optional

Config array.

See Also
FlashMessage::set() For list of valid config keys.

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes a single config key.

Parameters
string $key

Key to delete.

Returns
void
Throws
Cake\Core\Exception\CakeException
if attempting to clobber existing config

_configRead() ¶ protected

_configRead(string|null $key): mixed

Reads a config key.

Parameters
string|null $key

Key to read.

Returns
mixed

_configWrite() ¶ protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Writes a config key.

Parameters
array<string, mixed>|string $key

Key to write to.

mixed $value

Value to write.

string|bool $merge optional

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Returns
void
Throws
Cake\Core\Exception\CakeException
if attempting to clobber existing config

configShallow() ¶ public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

$this->configShallow('key', $value);

Setting a nested value:

$this->configShallow('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->configShallow(['one' => 'value', 'another' => 'value']);
Parameters
array<string, mixed>|string $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

Returns
$this

consume() ¶ public

consume(string $key): array|null

Get the messages for given key and remove from session.

Parameters
string $key

The key for get messages for.

Returns
array|null

error() ¶ public

error(string $message, array<string, mixed> $options = []): void

Set an success message.

The 'element' option will be set to 'error'.

Parameters
string $message

Message to flash.

array<string, mixed> $options optional

An array of options.

Returns
void
See Also
FlashMessage::set() For list of valid options

getConfig() ¶ public

getConfig(string|null $key = null, mixed $default = null): mixed

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

$this->getConfig('some.nested.key');

Reading with default value:

$this->getConfig('some-key', 'default-value');
Parameters
string|null $key optional

The key to get or null for the whole config.

mixed $default optional

The return value when the key does not exist.

Returns
mixed

getConfigOrFail() ¶ public

getConfigOrFail(string $key): mixed

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters
string $key

The key to get.

Returns
mixed
Throws
InvalidArgumentException

info() ¶ public

info(string $message, array<string, mixed> $options = []): void

Set an info message.

The 'element' option will be set to 'info'.

Parameters
string $message

Message to flash.

array<string, mixed> $options optional

An array of options.

Returns
void
See Also
FlashMessage::set() For list of valid options

set() ¶ public

set(string $message, array<string, mixed> $options = []): void

Store flash messages that can be output in the view.

If you make consecutive calls to this method, the messages will stack (if they are set with the same flash key)

Options:

  • key The key to set under the session's Flash key.
  • element The element used to render the flash message. You can use 'SomePlugin.name' style value for flash elements from a plugin.
  • plugin Plugin name to use element from.
  • params An array of variables to be made available to the element.
  • clear A bool stating if the current stack should be cleared to start a new one.
  • escape Set to false to allow templates to print out HTML content.
Parameters
string $message

Message to be flashed.

array<string, mixed> $options optional

An array of options

Returns
void
See Also
FlashMessage::$_defaultConfig For default values for the options.

setConfig() ¶ public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

Sets the config.

Usage

Setting a specific value:

$this->setConfig('key', $value);

Setting a nested value:

$this->setConfig('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->setConfig(['one' => 'value', 'another' => 'value']);
Parameters
array<string, mixed>|string $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

bool $merge optional

Whether to recursively merge or overwrite existing config, defaults to true.

Returns
$this
Throws
Cake\Core\Exception\CakeException
When trying to set a key that is invalid.

setExceptionMessage() ¶ public

setExceptionMessage(Throwable $exception, array<string, mixed> $options = []): void

Set an exception's message as flash message.

The following options will be set by default if unset:

'element' => 'error',
`params' => ['code' => $exception->getCode()]
Parameters
Throwable $exception

Exception instance.

array<string, mixed> $options optional

An array of options.

Returns
void
See Also
FlashMessage::set() For list of valid options

success() ¶ public

success(string $message, array<string, mixed> $options = []): void

Set a success message.

The 'element' option will be set to 'success'.

Parameters
string $message

Message to flash.

array<string, mixed> $options optional

An array of options.

Returns
void
See Also
FlashMessage::set() For list of valid options

warning() ¶ public

warning(string $message, array<string, mixed> $options = []): void

Set a warning message.

The 'element' option will be set to 'warning'.

Parameters
string $message

Message to flash.

array<string, mixed> $options optional

An array of options.

Returns
void
See Also
FlashMessage::set() For list of valid options

Property Detail

$_config ¶ protected

Runtime config

Type
array<string, mixed>

$_configInitialized ¶ protected

Whether the config property has already been configured with defaults

Type
bool

$_defaultConfig ¶ protected

Default configuration

Type
array<string, mixed>

$session ¶ protected

Type
Cake\Http\Session
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs