Fr3nch13/CakePHP Utilities

FlashHelper extends Helper
in package

Application

FlashHelper class to render flash messages.

After setting messages in your controllers with FlashComponent, you can use this class to output your flash messages in your views.

Properties

$_config : array<string, mixed>: Runtime config
$_configInitialized : bool: Whether the config property has already been configured with defaults
$_defaultConfig : array<string, mixed>: Default config for this helper.
$_helperMap : array<string, array<string|int, mixed>>: A helper lookup table used to lazy load helper objects.
$_View : View: The View instance this helper is attached to
$helpers : array<string|int, mixed>: List of helpers used by this helper

Methods

__call() : mixed|void: Provide non fatal errors on missing method calls.
__construct() : mixed: Default Constructor
__debugInfo() : array<string, mixed>: Returns an array that can be used to describe the internal state of this object.
__get() : Helper|null|void: Lazy loads helpers.
addClass() : array<string, mixed>: Adds the given class to the element options
configShallow() : $this: Merge provided config with existing config. Unlike `config()` which does a recursive merge for nested keys, this method does a simple merge.
getConfig() : mixed: Returns the config.
getConfigOrFail() : mixed: Returns the config for this specific key.
getView() : View: Get the view instance this helper is bound to.
implementedEvents() : array<string, mixed>: Event listeners.
initialize() : void: Constructor hook method.
render() : string|null: Used to render the message set in FlashComponent::set()
setConfig() : $this: Sets the config.
_configDelete() : void: Deletes a single config key.
_configRead() : mixed: Reads a config key.
_configWrite() : void: Writes a config key.
_confirm() : string: Returns a string to be used as onclick handler for confirm dialogs.

$_config

Runtime config


    protected
        array<string, mixed>
    $_config
     = []

$_configInitialized

Whether the config property has already been configured with defaults


    protected
        bool
    $_configInitialized
     = false

$_defaultConfig

Default config for this helper.


    protected
        array<string, mixed>
    $_defaultConfig
     = []

$_helperMap

A helper lookup table used to lazy load helper objects.


    protected
        array<string, array<string|int, mixed>>
    $_helperMap
     = []

$_View

The View instance this helper is attached to


    protected
        View
    $_View

$helpers

List of helpers used by this helper


    protected
        array<string|int, mixed>
    $helpers
     = []

__call()

Provide non fatal errors on missing method calls.


    public
                    __call(string $method, array<string|int, mixed> $params) : mixed|void

Parameters

$method : string: Method to invoke
$params : array<string|int, mixed>: Array of params for the method.

Return values

mixed|void

__construct()

Default Constructor


    public
                    __construct(View $view[, array<string, mixed> $config = [] ]) : mixed

Parameters

$view : View: The View this helper is being attached to.
$config : array<string, mixed> = []: Configuration settings for the helper.

__debugInfo()

Returns an array that can be used to describe the internal state of this object.


    public
                    __debugInfo() : array<string, mixed>

Return values

array<string, mixed>

__get()

Lazy loads helpers.


    public
                    __get(string $name) : Helper|null|void

Parameters

$name : string: Name of the property being accessed.

Return values

Helper|null|void —

Helper instance if helper with provided name exists

addClass()

Adds the given class to the element options


    public
                    addClass(array<string, mixed> $options, string $class[, string $key = 'class' ]) : array<string, mixed>

Parameters

$options : array<string, mixed>: Array options/attributes to add a class to
$class : string: The class name being added.
$key : string = 'class': the key to use for class. Defaults to 'class'.

Return values

array<string, mixed> —

Array of options with $key set.

configShallow()

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


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

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

$key : array<string, mixed>|string: The key to set, or a complete array of configs.
$value : mixed|null = null: The value to set.

Return values

$this

getConfig()

Returns the config.


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

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

$key : string|null = null: The key to get or null for the whole config.
$default : mixed = null: The return value when the key does not exist.

Return values

mixed —

Configuration data at the named key or null if the key does not exist.

getConfigOrFail()

Returns the config for this specific key.


    public
                    getConfigOrFail(string $key) : mixed

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

Parameters

$key : string: The key to get.

Return values

mixed —

Configuration data at the named key

getView()

Get the view instance this helper is bound to.


    public
                    getView() : View

Return values

View —

The bound view instance.

implementedEvents()

Event listeners.


    public
                    implementedEvents() : array<string, mixed>

Return values

array<string, mixed>

initialize()

Constructor hook method.


    public
                    initialize(array<string, mixed> $config) : void

Implement this method to avoid having to overwrite the constructor and call parent.

Parameters

$config : array<string, mixed>: The configuration settings provided to this helper.

render()

Used to render the message set in FlashComponent::set()


    public
                    render([string $key = 'flash' ][, array<string, mixed> $options = [] ]) : string|null

In your template file: $this->Flash->render('somekey'); Will default to flash if no param is passed

You can pass additional information into the flash message generation. This allows you to consolidate all the parameters for a given type of flash message into the view.

echo $this->Flash->render('flash', ['params' => ['name' => $user['User']['name']]]);

This would pass the current user's name into the flash message, so you could create personalized messages without the controller needing access to that data.

Lastly you can choose the element that is used for rendering the flash message. Using custom elements allows you to fully customize how flash messages are generated.

echo $this->Flash->render('flash', ['element' => 'my_custom_element']);

If you want to use an element from a plugin for rendering your flash message you can use the dot notation for the plugin's element name:

echo $this->Flash->render('flash', [
  'element' => 'MyPlugin.my_custom_element',
]);

If you have several messages stored in the Session, each message will be rendered in its own element.

Parameters

$key : string = 'flash': The [Flash.]key you are rendering in the view.
$options : array<string, mixed> = []: Additional options to use for the creation of this flash message. Supports the 'params', and 'element' keys that are used in the helper.

Return values

string|null —

Rendered flash message or null if flash key does not exist in session.

setConfig()

Sets the config.


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

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

$key : array<string, mixed>|string: The key to set, or a complete array of configs.
$value : mixed|null = null: The value to set.
$merge : bool = true: Whether to recursively merge or overwrite existing config, defaults to true.

Return values

$this

_configDelete()

Deletes a single config key.


    protected
                    _configDelete(string $key) : void

Parameters

$key : string: Key to delete.

_configRead()

Reads a config key.


    protected
                    _configRead(string|null $key) : mixed

Parameters

$key : string|null: Key to read.

_configWrite()

Writes a config key.


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

Parameters

$key : array<string, mixed>|string: Key to write to.
$value : mixed: Value to write.
$merge : string|bool = false: True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

_confirm()

Returns a string to be used as onclick handler for confirm dialogs.


    protected
                    _confirm(string $okCode, string $cancelCode) : string

Parameters

$okCode : string: Code to be executed after user chose 'OK'
$cancelCode : string: Code to be executed after user chose 'Cancel'

Return values

string —

"onclick" JS code

FlashHelper extends Helper in package Application

Table of Contents

Properties

Methods

Properties

$_config

$_configInitialized

$_defaultConfig

$_helperMap

$_View

$helpers

Methods

__call()

Parameters

Return values

__construct()

Parameters

__debugInfo()

Return values

__get()

Parameters

Return values

addClass()

Parameters

Return values

configShallow()

Parameters

Return values

getConfig()

Usage

Parameters

Return values

getConfigOrFail()

Parameters

Tags

Return values

getView()

Return values

implementedEvents()

Return values

initialize()

Parameters

render()

Parameters

Return values

setConfig()

Usage

Parameters

Tags

Return values

_configDelete()

Parameters

Tags

_configRead()

Parameters

_configWrite()

Parameters

Tags

_confirm()

Parameters

Return values

FlashHelper extends Helper
in package

Application